Add SpecificityAtSensitivity Metric (#1432)

Co-authored-by: Justus Schock <[email protected]>

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added support for `SpecificityAtSensitivity` Metric ([#1432](https://github.com/Lightning-AI/metrics/pull/1432))
+
 - Added support for plotting of metrics through `.plot()` method ([#1328](https://github.com/Lightning-AI/metrics/pull/1328))
 
 

docs/source/classification/specificity_at_sensitivity.rst

@@ -0,0 +1,53 @@
+.. customcarditem::
+   :header: Specificity At Sensitivity
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
+   :tags: Classification
+
+##########################
+Specificity At Sensitivity
+##########################
+
+Module Interface
+________________
+
+BinarySpecificityAtSensitivity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.BinarySpecificityAtSensitivity
+    :noindex:
+    :exclude-members: update, compute
+
+MulticlassSpecificityAtSensitivity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MulticlassSpecificityAtSensitivity
+    :noindex:
+    :exclude-members: update, compute
+
+MultilabelSpecificityAtSensitivity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MultilabelSpecificityAtSensitivity
+    :noindex:
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+binary_specificity_at_sensitivity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.binary_specificity_at_sensitivity
+    :noindex:
+
+multiclass_specificity_at_sensitivity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multiclass_specificity_at_sensitivity
+    :noindex:
+
+multilabel_specificity_at_sensitivity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multilabel_specificity_at_sensitivity
+    :noindex:

pyproject.toml

@@ -84,6 +84,7 @@ select = [
 #]
 ignore = [
     "E731",  # Do not assign a lambda expression, use a def
+    "F401",  # Imports of __all__
 ]
 # Exclude a variety of commonly ignored directories.
 exclude = [
@@ -98,6 +99,7 @@ exclude = [
     "docs"
 ]
 ignore-init-module-imports = true
+unfixable = ["F401"]
 
 [tool.ruff.per-file-ignores]
 "setup.py" = ["D100", "SIM115"]

src/torchmetrics/classification/__init__.py

@@ -101,6 +101,11 @@
     MultilabelSpecificity,
     Specificity,
 )
+from torchmetrics.classification.specificity_at_sensitivity import (
+    BinarySpecificityAtSensitivity,
+    MulticlassSpecificityAtSensitivity,
+    MultilabelSpecificityAtSensitivity,
+)
 
 __all__ = [
     "BinaryConfusionMatrix",
@@ -188,4 +193,7 @@
     "MulticlassSpecificity",
     "MultilabelSpecificity",
     "Specificity",
+    "BinarySpecificityAtSensitivity",
+    "MulticlassSpecificityAtSensitivity",
+    "MultilabelSpecificityAtSensitivity",
 ]