Newmetric: ClassificationReport

CHANGELOG.md

@@ -13,6 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added `ClassificationReport` with support for binary, multiclass, and multilabel classification tasks ([#3116](https://github.com/Lightning-AI/torchmetrics/pull/3116))
+
+
 -
 
 

docs/source/classification/classification_report.rst

@@ -0,0 +1,55 @@
+.. customcarditem::
+   :header: Classification Report
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
+   :tags: Classification
+
+.. include:: ../links.rst
+
+#####################
+Classification Report
+#####################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.ClassificationReport
+    :exclude-members: update, compute
+    :special-members: __new__
+
+BinaryClassificationReport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.BinaryClassificationReport
+    :exclude-members: update, compute
+
+MulticlassClassificationReport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MulticlassClassificationReport
+    :exclude-members: update, compute
+
+MultilabelClassificationReport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MultilabelClassificationReport
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.classification.classification_report
+
+binary_classification_report
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.binary_classification_report
+
+multiclass_classification_report
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multiclass_classification_report
+
+multilabel_classification_report
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multilabel_classification_report

src/torchmetrics/__init__.py

@@ -59,6 +59,7 @@
     Accuracy,
     AveragePrecision,
     CalibrationError,
+    ClassificationReport,
     CohenKappa,
     ConfusionMatrix,
     ExactMatch,
@@ -177,6 +178,7 @@
     "CalibrationError",
     "CatMetric",
     "CharErrorRate",
+    "ClassificationReport",
     "ClasswiseWrapper",
     "CohenKappa",
     "ConcordanceCorrCoef",

src/torchmetrics/classification/__init__.py

@@ -24,6 +24,12 @@
     CalibrationError,
     MulticlassCalibrationError,
 )
+from torchmetrics.classification.classification_report import (
+    BinaryClassificationReport,
+    ClassificationReport,
+    MulticlassClassificationReport,
+    MultilabelClassificationReport,
+)
 from torchmetrics.classification.cohen_kappa import BinaryCohenKappa, CohenKappa, MulticlassCohenKappa
 from torchmetrics.classification.confusion_matrix import (
     BinaryConfusionMatrix,
@@ -139,6 +145,7 @@
     "BinaryAccuracy",
     "BinaryAveragePrecision",
     "BinaryCalibrationError",
+    "BinaryClassificationReport",
     "BinaryCohenKappa",
     "BinaryConfusionMatrix",
     "BinaryEER",
@@ -163,6 +170,7 @@
     "BinarySpecificityAtSensitivity",
     "BinaryStatScores",
     "CalibrationError",
+    "ClassificationReport",
     "CohenKappa",
     "ConfusionMatrix",
     "ExactMatch",
@@ -177,6 +185,7 @@
     "MulticlassAccuracy",
     "MulticlassAveragePrecision",
     "MulticlassCalibrationError",
+    "MulticlassClassificationReport",
     "MulticlassCohenKappa",
     "MulticlassConfusionMatrix",
     "MulticlassEER",
@@ -202,6 +211,7 @@
     "MultilabelAUROC",
     "MultilabelAccuracy",
     "MultilabelAveragePrecision",
+    "MultilabelClassificationReport",
     "MultilabelConfusionMatrix",
     "MultilabelCoverageError",
     "MultilabelEER",