Add SensitivityAtSpecificity metric

CHANGELOG.md

@@ -25,7 +25,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added support for logging `MultiTaskWrapper` directly with lightnings `log_dict` method ([#2213](https://github.com/Lightning-AI/torchmetrics/pull/2213))
 
 
-- Added `aggregate`` argument to retrieval metrics ([#2220](https://github.com/Lightning-AI/torchmetrics/pull/2220))
+- Added `aggregate` argument to retrieval metrics ([#2220](https://github.com/Lightning-AI/torchmetrics/pull/2220))
+
+
+- Added `SensitivityAtSpecificity` metric to classification subpackage ([#2217](https://github.com/Lightning-AI/torchmetrics/pull/2217))
+
 
 
 ### Changed

docs/source/classification/sensitivity_at_specificity.rst

@@ -0,0 +1,55 @@
+.. customcarditem::
+   :header: Sensitivity At Specificity
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
+   :tags: Classification
+
+.. include:: ../links.rst
+
+##########################
+Sensitivity At Specificity
+##########################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.SensitivityAtSpecificity
+    :exclude-members: update, compute
+    :special-members: __new__
+
+BinarySensitivityAtSpecificity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.BinarySensitivityAtSpecificity
+    :exclude-members: update, compute
+
+MulticlassSensitivityAtSpecificity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MulticlassSensitivityAtSpecificity
+    :exclude-members: update, compute
+
+MultilabelSensitivityAtSpecificity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MultilabelSensitivityAtSpecificity
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.classification.sensitivity_at_specificity
+
+binary_sensitivity_at_specificity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.binary_sensitivity_at_specificity
+
+multiclass_sensitivity_at_specificity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multiclass_sensitivity_at_specificity
+
+multilabel_sensitivity_at_specificity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multilabel_sensitivity_at_specificity

src/torchmetrics/__init__.py

@@ -59,6 +59,7 @@
     PrecisionRecallCurve,
     Recall,
     RecallAtFixedPrecision,
+    SensitivityAtSpecificity,
     Specificity,
     SpecificityAtSensitivity,
     StatScores,
@@ -233,6 +234,7 @@
     "SpearmanCorrCoef",
     "Specificity",
     "SpecificityAtSensitivity",
+    "SensitivityAtSpecificity",
     "SpectralAngleMapper",
     "SpectralDistortionIndex",
     "SQuAD",

src/torchmetrics/classification/__init__.py

@@ -97,6 +97,12 @@
     RecallAtFixedPrecision,
 )
 from torchmetrics.classification.roc import ROC, BinaryROC, MulticlassROC, MultilabelROC
+from torchmetrics.classification.sensitivity_specificity import (
+    BinarySensitivityAtSpecificity,
+    MulticlassSensitivityAtSpecificity,
+    MultilabelSensitivityAtSpecificity,
+    SensitivityAtSpecificity,
+)
 from torchmetrics.classification.specificity import (
     BinarySpecificity,
     MulticlassSpecificity,
@@ -207,4 +213,8 @@
     "BinaryPrecisionAtFixedRecall",
     "MulticlassPrecisionAtFixedRecall",
     "MultilabelPrecisionAtFixedRecall",
+    "BinarySensitivityAtSpecificity",
+    "MulticlassSensitivityAtSpecificity",
+    "MultilabelSensitivityAtSpecificity",
+    "SensitivityAtSpecificity",
 ]