Move CSI metric to right domain (#2309)

* move csi to right domain
* fix docstrings
* move docs

(cherry picked from commit 548a51f)

docs/source/image/critical_success_index.rst → docs/source/regression/critical_success_index.rst

@@ -1,22 +1,22 @@
-.. customcarditem::
-   :header: Critical Success Index (CSI)
-   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
-   :tags: Image
-
-.. include:: ../links.rst
-
-############################
-Critical Success Index (CSI)
-############################
-
-Module Interface
-________________
-
-.. autoclass:: torchmetrics.image.CriticalSuccessIndex
-    :exclude-members: update, compute
-
-
-Functional Interface
-____________________
-
-.. autofunction:: torchmetrics.functional.image.critical_success_index
+.. customcarditem::
+   :header: Critical Success Index (CSI)
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
+   :tags: Regression
+
+.. include:: ../links.rst
+
+############################
+Critical Success Index (CSI)
+############################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.regression.CriticalSuccessIndex
+    :exclude-members: update, compute
+
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.regression.critical_success_index

src/torchmetrics/__init__.py

@@ -95,6 +95,7 @@
 from torchmetrics.regression import (  # noqa: E402
     ConcordanceCorrCoef,
     CosineSimilarity,
+    CriticalSuccessIndex,
     ExplainedVariance,
     KendallRankCorrCoef,
     KLDivergence,
@@ -164,6 +165,7 @@
     "ConfusionMatrix",
     "CosineSimilarity",
     "CramersV",
+    "CriticalSuccessIndex",
     "Dice",
     "TweedieDevianceScore",
     "ErrorRelativeGlobalDimensionlessSynthesis",

src/torchmetrics/functional/__init__.py

@@ -89,6 +89,7 @@
 from torchmetrics.functional.regression import (
     concordance_corrcoef,
     cosine_similarity,
+    critical_success_index,
     explained_variance,
     kendall_rank_corrcoef,
     kl_divergence,
@@ -150,6 +151,7 @@
     "cosine_similarity",
     "cramers_v",
     "cramers_v_matrix",
+    "critical_success_index",
     "tweedie_deviance_score",
     "dice",
     "error_relative_global_dimensionless_synthesis",

src/torchmetrics/functional/image/__init__.py

@@ -11,7 +11,6 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from torchmetrics.functional.image.csi import critical_success_index
 from torchmetrics.functional.image.d_lambda import spectral_distortion_index
 from torchmetrics.functional.image.d_s import spatial_distortion_index
 from torchmetrics.functional.image.ergas import error_relative_global_dimensionless_synthesis
@@ -49,6 +48,5 @@
     "visual_information_fidelity",
     "learned_perceptual_image_patch_similarity",
     "perceptual_path_length",
-    "critical_success_index",
     "spatial_correlation_coefficient",
 ]

src/torchmetrics/functional/regression/__init__.py

@@ -11,9 +11,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
 from torchmetrics.functional.regression.concordance import concordance_corrcoef
 from torchmetrics.functional.regression.cosine_similarity import cosine_similarity
+from torchmetrics.functional.regression.csi import critical_success_index
 from torchmetrics.functional.regression.explained_variance import explained_variance
 from torchmetrics.functional.regression.kendall import kendall_rank_corrcoef
 from torchmetrics.functional.regression.kl_divergence import kl_divergence
@@ -34,6 +34,7 @@
 __all__ = [
     "concordance_corrcoef",
     "cosine_similarity",
+    "critical_success_index",
     "explained_variance",
     "kendall_rank_corrcoef",
     "kl_divergence",

src/torchmetrics/functional/image/csi.py → src/torchmetrics/functional/regression/csi.py

@@ -93,15 +93,15 @@ def critical_success_index(
 
     Example:
         >>> import torch
-        >>> from torchmetrics.functional.image.csi import critical_success_index
+        >>> from torchmetrics.functional.regression import critical_success_index
         >>> x = torch.Tensor([[0.2, 0.7], [0.9, 0.3]])
         >>> y = torch.Tensor([[0.4, 0.2], [0.8, 0.6]])
         >>> critical_success_index(x, y, 0.5)
         tensor(0.3333)
 
     Example:
         >>> import torch
-        >>> from torchmetrics.functional.image.csi import critical_success_index
+        >>> from torchmetrics.functional.regression import critical_success_index
         >>> x = torch.Tensor([[[0.2, 0.7], [0.9, 0.3]], [[0.2, 0.7], [0.9, 0.3]]])
         >>> y = torch.Tensor([[[0.4, 0.2], [0.8, 0.6]], [[0.4, 0.2], [0.8, 0.6]]])
         >>> critical_success_index(x, y, 0.5, keep_sequence_dim=0)

src/torchmetrics/image/__init__.py

@@ -11,7 +11,6 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from torchmetrics.image.csi import CriticalSuccessIndex
 from torchmetrics.image.d_lambda import SpectralDistortionIndex
 from torchmetrics.image.d_s import SpatialDistortionIndex
 from torchmetrics.image.ergas import ErrorRelativeGlobalDimensionlessSynthesis
@@ -46,7 +45,6 @@
     "UniversalImageQualityIndex",
     "VisualInformationFidelity",
     "TotalVariation",
-    "CriticalSuccessIndex",
     "SpatialCorrelationCoefficient",
 ]
 

src/torchmetrics/regression/__init__.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 from torchmetrics.regression.concordance import ConcordanceCorrCoef
 from torchmetrics.regression.cosine_similarity import CosineSimilarity
+from torchmetrics.regression.csi import CriticalSuccessIndex
 from torchmetrics.regression.explained_variance import ExplainedVariance
 from torchmetrics.regression.kendall import KendallRankCorrCoef
 from torchmetrics.regression.kl_divergence import KLDivergence
@@ -33,6 +34,7 @@
 __all__ = [
     "ConcordanceCorrCoef",
     "CosineSimilarity",
+    "CriticalSuccessIndex",
     "ExplainedVariance",
     "KendallRankCorrCoef",
     "KLDivergence",

src/torchmetrics/image/csi.py → src/torchmetrics/regression/csi.py

@@ -15,7 +15,7 @@
 
 import torch
 
-from torchmetrics.functional.image.csi import _critical_success_index_compute, _critical_success_index_update
+from torchmetrics.functional.regression.csi import _critical_success_index_compute, _critical_success_index_update
 from torchmetrics.metric import Metric
 from torchmetrics.utilities import dim_zero_cat
 
@@ -39,7 +39,7 @@ class CriticalSuccessIndex(Metric):
 
     Example:
         >>> import torch
-        >>> from torchmetrics.image.csi import CriticalSuccessIndex
+        >>> from torchmetrics.regression import CriticalSuccessIndex
         >>> x = torch.Tensor([[0.2, 0.7], [0.9, 0.3]])
         >>> y = torch.Tensor([[0.4, 0.2], [0.8, 0.6]])
         >>> csi = CriticalSuccessIndex(0.5)
@@ -48,7 +48,7 @@ class CriticalSuccessIndex(Metric):
 
     Example:
         >>> import torch
-        >>> from torchmetrics.image.csi import CriticalSuccessIndex
+        >>> from torchmetrics.regression import CriticalSuccessIndex
         >>> x = torch.Tensor([[[0.2, 0.7], [0.9, 0.3]], [[0.2, 0.7], [0.9, 0.3]]])
         >>> y = torch.Tensor([[[0.4, 0.2], [0.8, 0.6]], [[0.4, 0.2], [0.8, 0.6]]])
         >>> csi = CriticalSuccessIndex(0.5, keep_sequence_dim=0)

tests/unittests/image/test_csi.py

@@ -17,8 +17,8 @@
 import pytest
 import torch
 from sklearn.metrics import jaccard_score
-from torchmetrics.functional.image.csi import critical_success_index
-from torchmetrics.image.csi import CriticalSuccessIndex
+from torchmetrics.functional.regression.csi import critical_success_index
+from torchmetrics.regression.csi import CriticalSuccessIndex
 
 from unittests import BATCH_SIZE, NUM_BATCHES, _Input
 from unittests.helpers import seed_all