🎨 Move AUSE out of classification metrics as it is a general metric

- fix docstrings
ENSTA-U2IS-AI · Sep 18, 2024 · 58acaf8 · 58acaf8
1 parent eb72501
commit 58acaf8
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -259,7 +259,6 @@ Others
     :nosignatures:
     :template: class.rst
 
-    AUSE
     GroupingLoss
 
 Regression
@@ -294,6 +293,18 @@ Segmentation
 
     MeanIntersectionOverUnion
 
+Others
+^^^^^^
+
+.. currentmodule:: torch_uncertainty.metrics
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+    :template: class.rst
+
+    AUSE
+
 Losses
 ------
 

diff --git a/...ics/classification/test_sparsification.py → tests/metrics/test_sparsification.py b/...ics/classification/test_sparsification.py → tests/metrics/test_sparsification.py
diff --git a/torch_uncertainty/metrics/__init__.py b/torch_uncertainty/metrics/__init__.py
@@ -2,7 +2,6 @@
 from .classification import (
     AUGRC,
     AURC,
-    AUSE,
     FPR95,
     AdaptiveCalibrationError,
     BrierScore,
@@ -29,3 +28,4 @@
     SILog,
     ThresholdAccuracy,
 )
+from .sparsification import AUSE
diff --git a/torch_uncertainty/metrics/classification/__init__.py b/torch_uncertainty/metrics/classification/__init__.py
@@ -17,5 +17,4 @@
     RiskAt80Cov,
     RiskAtxCov,
 )
-from .sparsification import AUSE
 from .variation_ratio import VariationRatio
diff --git a/.../metrics/classification/sparsification.py → torch_uncertainty/metrics/sparsification.py b/.../metrics/classification/sparsification.py → torch_uncertainty/metrics/sparsification.py
@@ -36,7 +36,7 @@ def __init__(self, **kwargs) -> None:
         Inputs:
             - :attr:`scores`: Uncertainty scores of shape :math:`(B,)`. A higher
               score means a higher uncertainty.
-            - :attr:`errors`: Binary errors of shape :math:`(B,)`,
+            - :attr:`errors`: Errors of shape :math:`(B,)`,
 
         where :math:`B` is the batch size.
 
@@ -52,7 +52,7 @@ def update(self, scores: Tensor, errors: Tensor) -> None:
 
         Args:
             scores (Tensor): uncertainty scores of shape :math:`(B,)`
-            errors (Tensor): binary errors of shape :math:`(B,)`
+            errors (Tensor): errors of shape :math:`(B,)`
         """
         self.scores.append(scores)
         self.errors.append(errors)
@@ -149,7 +149,7 @@ def _ause_rejection_rate_compute(
 
     Args:
         scores (Tensor): uncertainty scores of shape :math:`(B,)`
-        errors (Tensor): binary errors of shape :math:`(B,)`
+        errors (Tensor): errors of shape :math:`(B,)`
     """
     num_samples = errors.size(0)