Refactor/classification 10 (#1197)

* example * stat scores * revert * remove old tests * deprecate binned * remove init * warning functionals * docs update * add __new__ for class wrapping * update imports in docstrings * fix one mistake * fix doctests * Apply suggestions from code review * elif * kwargs * kwargs + elif * text * fix gpu testing Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Jirka <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Lightning-AI · Sep 13, 2022 · 852c6f3 · 852c6f3
1 parent d0a59c7
commit 852c6f3
Show file tree

Hide file tree

Showing 83 changed files with 1,611 additions and 4,219 deletions.
diff --git a/docs/source/classification/accuracy.rst b/docs/source/classification/accuracy.rst
@@ -16,41 +16,41 @@ ________________
 BinaryAccuracy
 ^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryAccuracy
+.. autoclass:: torchmetrics.classification.BinaryAccuracy
     :noindex:
 
 MulticlassAccuracy
 ^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassAccuracy
+.. autoclass:: torchmetrics.classification.MulticlassAccuracy
     :noindex:
 
 MultilabelAccuracy
 ^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelAccuracy
+.. autoclass:: torchmetrics.classification.MultilabelAccuracy
     :noindex:
 
 Functional Interface
 ____________________
 
-.. autofunction:: torchmetrics.functional.accuracy
+.. autofunction:: torchmetrics.functional.classification.accuracy
     :noindex:
 
 binary_accuracy
 ^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_accuracy
+.. autofunction:: torchmetrics.functional.classification.binary_accuracy
     :noindex:
 
 multiclass_accuracy
 ^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_accuracy
+.. autofunction:: torchmetrics.functional.classification.multiclass_accuracy
     :noindex:
 
 multilabel_accuracy
 ^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_accuracy
+.. autofunction:: torchmetrics.functional.classification.multilabel_accuracy
     :noindex:
diff --git a/docs/source/classification/auroc.rst b/docs/source/classification/auroc.rst
@@ -18,19 +18,19 @@ ________________
 BinaryAUROC
 ^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryAUROC
+.. autoclass:: torchmetrics.classification.BinaryAUROC
     :noindex:
 
 MulticlassAUROC
 ^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassAUROC
+.. autoclass:: torchmetrics.classification.MulticlassAUROC
     :noindex:
 
 MultilabelAUROC
 ^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelAUROC
+.. autoclass:: torchmetrics.classification.MultilabelAUROC
     :noindex:
 
 Functional Interface
@@ -42,17 +42,17 @@ ____________________
 binary_auroc
 ^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_auroc
+.. autofunction:: torchmetrics.functional.classification.binary_auroc
     :noindex:
 
 multiclass_auroc
 ^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_auroc
+.. autofunction:: torchmetrics.functional.classification.multiclass_auroc
     :noindex:
 
 multilabel_auroc
 ^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_auroc
+.. autofunction:: torchmetrics.functional.classification.multilabel_auroc
     :noindex:
diff --git a/docs/source/classification/average_precision.rst b/docs/source/classification/average_precision.rst
@@ -16,19 +16,19 @@ ________________
 BinaryAveragePrecision
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryAveragePrecision
+.. autoclass:: torchmetrics.classification.BinaryAveragePrecision
     :noindex:
 
 MulticlassAveragePrecision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassAveragePrecision
+.. autoclass:: torchmetrics.classification.MulticlassAveragePrecision
     :noindex:
 
 MultilabelAveragePrecision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelAveragePrecision
+.. autoclass:: torchmetrics.classification.MultilabelAveragePrecision
     :noindex:
 
 Functional Interface
@@ -40,17 +40,17 @@ ____________________
 binary_average_precision
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_average_precision
+.. autofunction:: torchmetrics.functional.classification.binary_average_precision
     :noindex:
 
 multiclass_average_precision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_average_precision
+.. autofunction:: torchmetrics.functional.classification.multiclass_average_precision
     :noindex:
 
 multilabel_average_precision
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_average_precision
+.. autofunction:: torchmetrics.functional.classification.multilabel_average_precision
     :noindex:
diff --git a/docs/source/classification/calibration_error.rst b/docs/source/classification/calibration_error.rst
@@ -18,13 +18,13 @@ ________________
 BinaryCalibrationError
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryCalibrationError
+.. autoclass:: torchmetrics.classification.BinaryCalibrationError
     :noindex:
 
 MulticlassCalibrationError
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassCalibrationError
+.. autoclass:: torchmetrics.classification.MulticlassCalibrationError
     :noindex:
 
 Functional Interface
@@ -36,11 +36,11 @@ ____________________
 binary_calibration_error
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_calibration_error
+.. autofunction:: torchmetrics.functional.classification.binary_calibration_error
     :noindex:
 
 multiclass_calibration_error
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_calibration_error
+.. autofunction:: torchmetrics.functional.classification.multiclass_calibration_error
     :noindex:
diff --git a/docs/source/classification/cohen_kappa.rst b/docs/source/classification/cohen_kappa.rst
@@ -21,14 +21,14 @@ CohenKappa
 BinaryCohenKappa
 ^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryCohenKappa
+.. autoclass:: torchmetrics.classification.BinaryCohenKappa
     :noindex:
     :exclude-members: update, compute
 
 MulticlassCohenKappa
 ^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassCohenKappa
+.. autoclass:: torchmetrics.classification.MulticlassCohenKappa
     :noindex:
     :exclude-members: update, compute
 
@@ -44,11 +44,11 @@ cohen_kappa
 binary_cohen_kappa
 ^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_cohen_kappa
+.. autofunction:: torchmetrics.functional.classification.binary_cohen_kappa
     :noindex:
 
 multiclass_cohen_kappa
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_cohen_kappa
+.. autofunction:: torchmetrics.functional.classification.multiclass_cohen_kappa
     :noindex:
diff --git a/docs/source/classification/confusion_matrix.rst b/docs/source/classification/confusion_matrix.rst
@@ -21,23 +21,20 @@ ConfusionMatrix
 BinaryConfusionMatrix
 ^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryConfusionMatrix
+.. autoclass:: torchmetrics.classification.BinaryConfusionMatrix
     :noindex:
-    :exclude-members: update, compute
 
 MulticlassConfusionMatrix
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassConfusionMatrix
+.. autoclass:: torchmetrics.classification.MulticlassConfusionMatrix
     :noindex:
-    :exclude-members: update, compute
 
 MultilabelConfusionMatrix
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelConfusionMatrix
+.. autoclass:: torchmetrics.classification.MultilabelConfusionMatrix
     :noindex:
-    :exclude-members: update, compute
 
 Functional Interface
 ____________________
@@ -51,17 +48,17 @@ confusion_matrix
 binary_confusion_matrix
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_confusion_matrix
+.. autofunction:: torchmetrics.functional.classification.binary_confusion_matrix
     :noindex:
 
 multiclass_confusion_matrix
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_confusion_matrix
+.. autofunction:: torchmetrics.functional.classification.multiclass_confusion_matrix
     :noindex:
 
 multilabel_confusion_matrix
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_confusion_matrix
+.. autofunction:: torchmetrics.functional.classification.multilabel_confusion_matrix
     :noindex:
diff --git a/docs/source/classification/coverage_error.rst b/docs/source/classification/coverage_error.rst
@@ -13,7 +13,7 @@ ________________
 .. autoclass:: torchmetrics.CoverageError
     :noindex:
 
-.. autoclass:: torchmetrics.MultilabelCoverageError
+.. autoclass:: torchmetrics.classification.MultilabelCoverageError
     :noindex:
 
 Functional Interface
@@ -22,5 +22,5 @@ ____________________
 .. autofunction:: torchmetrics.functional.coverage_error
     :noindex:
 
-.. autofunction:: torchmetrics.functional.multilabel_coverage_error
+.. autofunction:: torchmetrics.functional.classification.multilabel_coverage_error
     :noindex:
diff --git a/docs/source/classification/exact_match.rst b/docs/source/classification/exact_match.rst
@@ -13,7 +13,7 @@ ________________
 MultilabelExactMatch
 ^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelExactMatch
+.. autoclass:: torchmetrics.classification.MultilabelExactMatch
     :noindex:
 
 Functional Interface
@@ -22,5 +22,5 @@ ____________________
 multilabel_exact_match
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_exact_match
+.. autofunction:: torchmetrics.functional.classification.multilabel_exact_match
     :noindex:
diff --git a/docs/source/classification/f1_score.rst b/docs/source/classification/f1_score.rst
@@ -19,19 +19,19 @@ F1Score
 BinaryF1Score
 ^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryF1Score
+.. autoclass:: torchmetrics.classification.BinaryF1Score
     :noindex:
 
 MulticlassF1Score
 ^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassF1Score
+.. autoclass:: torchmetrics.classification.MulticlassF1Score
     :noindex:
 
 MultilabelF1Score
 ^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelF1Score
+.. autoclass:: torchmetrics.classification.MultilabelF1Score
     :noindex:
 
 Functional Interface
@@ -46,17 +46,17 @@ f1_score
 binary_f1_score
 ^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_f1_score
+.. autofunction:: torchmetrics.functional.classification.binary_f1_score
     :noindex:
 
 multiclass_f1_score
 ^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_f1_score
+.. autofunction:: torchmetrics.functional.classification.multiclass_f1_score
     :noindex:
 
 multilabel_f1_score
 ^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_f1_score
+.. autofunction:: torchmetrics.functional.classification.multilabel_f1_score
     :noindex:
diff --git a/docs/source/classification/fbeta_score.rst b/docs/source/classification/fbeta_score.rst
@@ -21,19 +21,19 @@ FBetaScore
 BinaryFBetaScore
 ^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.BinaryFBetaScore
+.. autoclass:: torchmetrics.classification.BinaryFBetaScore
     :noindex:
 
 MulticlassFBetaScore
 ^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MulticlassFBetaScore
+.. autoclass:: torchmetrics.classification.MulticlassFBetaScore
     :noindex:
 
 MultilabelFBetaScore
 ^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: torchmetrics.MultilabelFBetaScore
+.. autoclass:: torchmetrics.classification.MultilabelFBetaScore
     :noindex:
 
 Functional Interface
@@ -48,17 +48,17 @@ fbeta_score
 binary_fbeta_score
 ^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.binary_fbeta_score
+.. autofunction:: torchmetrics.functional.classification.binary_fbeta_score
     :noindex:
 
 multiclass_fbeta_score
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multiclass_fbeta_score
+.. autofunction:: torchmetrics.functional.classification.multiclass_fbeta_score
     :noindex:
 
 multilabel_fbeta_score
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. autofunction:: torchmetrics.functional.multilabel_fbeta_score
+.. autofunction:: torchmetrics.functional.classification.multilabel_fbeta_score
     :noindex: