[Refactor] Classification 4/n (#1151)

* docs * update * hamming * working specificity * hamming base structure * init files for specificity * done with specificity * bit working hamming * working hamming * init files * docstring * specificity fix docs * fix float division * local/global * Apply suggestions from code review Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jirka <jirka.borovec@seznam.cz> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Lightning-AI · Sep 13, 2022 · 32e2190 · 32e2190
1 parent 96a78a9
commit 32e2190
Show file tree

Hide file tree

Showing 15 changed files with 2,922 additions and 547 deletions.
diff --git a/docs/source/classification/hamming_distance.rst b/docs/source/classification/hamming_distance.rst
@@ -10,11 +10,53 @@ Hamming Distance
 Module Interface
 ________________
 
+HammingDistance
+^^^^^^^^^^^^^^^
+
 .. autoclass:: torchmetrics.HammingDistance
  :noindex:
 
+BinaryHammingDistance
+^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.BinaryHammingDistance
+ :noindex:
+
+MulticlassHammingDistance
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.MulticlassHammingDistance
+ :noindex:
+
+MultilabelHammingDistance
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.MultilabelHammingDistance
+ :noindex:
+
 Functional Interface
 ____________________
 
+hamming_distance
+^^^^^^^^^^^^^^^^
+
 .. autofunction:: torchmetrics.functional.hamming_distance
  :noindex:
+
+binary_hamming_distance
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.binary_hamming_distance
+ :noindex:
+
+multiclass_hamming_distance
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.multiclass_hamming_distance
+ :noindex:
+
+multilabel_hamming_distance
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.multilabel_hamming_distance
+ :noindex:
diff --git a/docs/source/classification/specificity.rst b/docs/source/classification/specificity.rst
@@ -13,8 +13,45 @@ ________________
 .. autoclass:: torchmetrics.Specificity
  :noindex:
 
+BinarySpecificity
+^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.BinarySpecificity
+ :noindex:
+
+MulticlassSpecificity
+^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.MulticlassSpecificity
+ :noindex:
+
+MultilabelSpecificity
+^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.MultilabelSpecificity
+ :noindex:
+
+
 Functional Interface
 ____________________
 
 .. autofunction:: torchmetrics.functional.specificity
  :noindex:
+
+binary_specificity
+^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.binary_specificity
+ :noindex:
+
+multiclass_specificity
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.multiclass_specificity
+ :noindex:
+
+multilabel_specificity
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.multilabel_specificity
+ :noindex:
diff --git a/src/torchmetrics/__init__.py b/src/torchmetrics/__init__.py
@@ -30,10 +30,12 @@
  BinaryConfusionMatrix,
  BinaryF1Score,
  BinaryFBetaScore,
+ BinaryHammingDistance,
  BinaryJaccardIndex,
  BinaryMatthewsCorrCoef,
  BinaryPrecision,
  BinaryRecall,
+ BinarySpecificity,
  BinaryStatScores,
  BinnedAveragePrecision,
  BinnedPrecisionRecallCurve,
@@ -56,18 +58,22 @@
  MulticlassConfusionMatrix,
  MulticlassF1Score,
  MulticlassFBetaScore,
+ MulticlassHammingDistance,
  MulticlassJaccardIndex,
  MulticlassMatthewsCorrCoef,
  MulticlassPrecision,
  MulticlassRecall,
+ MulticlassSpecificity,
  MulticlassStatScores,
  MultilabelConfusionMatrix,
  MultilabelF1Score,
  MultilabelFBetaScore,
+ MultilabelHammingDistance,
  MultilabelJaccardIndex,
  MultilabelMatthewsCorrCoef,
  MultilabelPrecision,
  MultilabelRecall,
+ MultilabelSpecificity,
  MultilabelStatScores,
  Precision,
  PrecisionRecallCurve,
@@ -173,6 +179,9 @@
  "MulticlassFBetaScore",
  "MultilabelFBetaScore",
  "HammingDistance",
+ "BinaryHammingDistance",
+ "MultilabelHammingDistance",
+ "MulticlassHammingDistance",
  "HingeLoss",
  "JaccardIndex",
  "BinaryJaccardIndex",
@@ -231,6 +240,9 @@
  "SignalNoiseRatio",
  "SpearmanCorrCoef",
  "Specificity",
+ "BinarySpecificity",
+ "MulticlassSpecificity",
+ "MultilabelSpecificity",
  "SpectralAngleMapper",
  "SpectralDistortionIndex",
  "SQuAD",

diff --git a/src/torchmetrics/classification/__init__.py b/src/torchmetrics/classification/__init__.py
@@ -44,7 +44,12 @@
  MultilabelF1Score,
  MultilabelFBetaScore,
 )
-from torchmetrics.classification.hamming import HammingDistance # noqa: F401
+from torchmetrics.classification.hamming import ( # noqa: F401
+ BinaryHammingDistance,
+ HammingDistance,
+ MulticlassHammingDistance,
+ MultilabelHammingDistance,
+)
 from torchmetrics.classification.hinge import HingeLoss # noqa: F401
 from torchmetrics.classification.jaccard import ( # noqa: F401
  BinaryJaccardIndex,
@@ -76,4 +81,9 @@
  LabelRankingLoss,
 )
 from torchmetrics.classification.roc import ROC # noqa: F401
-from torchmetrics.classification.specificity import Specificity # noqa: F401
+from torchmetrics.classification.specificity import ( # noqa: F401
+ BinarySpecificity,
+ MulticlassSpecificity,
+ MultilabelSpecificity,
+ Specificity,
+)