Add aliases for precision and recall (#537)

VectorInstitute · Dec 19, 2023 · 725a781 · 725a781
1 parent 9608603
commit 725a781
Show file tree

Hide file tree

Showing 4 changed files with 448 additions and 0 deletions.
diff --git a/cyclops/evaluate/metrics/experimental/__init__.py b/cyclops/evaluate/metrics/experimental/__init__.py
@@ -19,12 +19,21 @@
 )
 from cyclops.evaluate.metrics.experimental.metric_dict import MetricDict
 from cyclops.evaluate.metrics.experimental.precision_recall import (
+    BinaryPPV,
     BinaryPrecision,
     BinaryRecall,
+    BinarySensitivity,
+    BinaryTPR,
+    MulticlassPPV,
     MulticlassPrecision,
     MulticlassRecall,
+    MulticlassSensitivity,
+    MulticlassTPR,
+    MultilabelPPV,
     MultilabelPrecision,
     MultilabelRecall,
+    MultilabelSensitivity,
+    MultilabelTPR,
 )
 from cyclops.evaluate.metrics.experimental.specificity import (
     BinarySpecificity,

diff --git a/cyclops/evaluate/metrics/experimental/functional/__init__.py b/cyclops/evaluate/metrics/experimental/functional/__init__.py
@@ -18,12 +18,18 @@
     multilabel_fbeta_score,
 )
 from cyclops.evaluate.metrics.experimental.functional.precision_recall import (
+    binary_ppv,
     binary_precision,
     binary_recall,
+    binary_tpr,
+    multiclass_ppv,
     multiclass_precision,
     multiclass_recall,
+    multiclass_tpr,
+    multilabel_ppv,
     multilabel_precision,
     multilabel_recall,
+    multilabel_tpr,
 )
 from cyclops.evaluate.metrics.experimental.functional.specificity import (
     binary_specificity,

diff --git a/cyclops/evaluate/metrics/experimental/functional/precision_recall.py b/cyclops/evaluate/metrics/experimental/functional/precision_recall.py
@@ -828,3 +828,15 @@ def multilabel_recall(
         fp=fp,
         fn=fn,
     )
+
+
+# Aliases
+binary_ppv = binary_precision
+multiclass_ppv = multiclass_precision
+multilabel_ppv = multilabel_precision
+binary_sensitivity = binary_recall
+multiclass_sensitivity = multiclass_recall
+multilabel_sensitivity = multilabel_recall
+binary_tpr = binary_recall
+multiclass_tpr = multiclass_recall
+multilabel_tpr = multilabel_recall