Skip to content

Commit

Permalink
small doc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
SkafteNicki authored Aug 30, 2022
1 parent 27b4d93 commit 6b60bf3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
9 changes: 6 additions & 3 deletions src/torchmetrics/classification/average_precision.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ class BinaryAveragePrecision(BinaryPrecisionRecallCurve):
.. math::
AP = \sum{n} (R_n - R_{n-1}) P_n
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`.
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`. This value is
equivalent to the area under the precision-recall curve (AUPRC).
Accepts the following input tensors:
Expand Down Expand Up @@ -114,7 +115,8 @@ class MulticlassAveragePrecision(MulticlassPrecisionRecallCurve):
.. math::
AP = \sum{n} (R_n - R_{n-1}) P_n
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`.
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`. This value is
equivalent to the area under the precision-recall curve (AUPRC).
Accepts the following input tensors:
Expand Down Expand Up @@ -219,7 +221,8 @@ class MultilabelAveragePrecision(MultilabelPrecisionRecallCurve):
.. math::
AP = \sum{n} (R_n - R_{n-1}) P_n
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`.
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`. This value is
equivalent to the area under the precision-recall curve (AUPRC).
Accepts the following input tensors:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ def binary_average_precision(
.. math::
AP = \sum{n} (R_n - R_{n-1}) P_n
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`.
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`. This value is
equivalent to the area under the precision-recall curve (AUPRC).
Accepts the following input tensors:
Expand Down Expand Up @@ -196,7 +197,8 @@ def multiclass_average_precision(
.. math::
AP = \sum{n} (R_n - R_{n-1}) P_n
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`.
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`. This value is
equivalent to the area under the precision-recall curve (AUPRC).
Accepts the following input tensors:
Expand Down Expand Up @@ -326,7 +328,8 @@ def multilabel_average_precision(
.. math::
AP = \sum{n} (R_n - R_{n-1}) P_n
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`.
where :math:`P_n, R_n` is the respective precision and recall at threshold index :math:`n`. This value is
equivalent to the area under the precision-recall curve (AUPRC).
Accepts the following input tensors:
Expand Down

0 comments on commit 6b60bf3

Please sign in to comment.