Merge branch 'master' into master

Author: rittik9

CHANGELOG.md

@@ -12,52 +12,59 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Added `NormalizedRootMeanSquaredError` metric to regression subpackage ([#2442](https://github.com/Lightning-AI/torchmetrics/pull/2442))
+-
 
 
-- Added `NegativePredictiveValue` to classification metrics ([#2433](https://github.com/Lightning-AI/torchmetrics/pull/2433))
+### Changed
 
+-
 
-- Added method `merge_state` to `Metric` ([#2786](https://github.com/Lightning-AI/torchmetrics/pull/2786))
 
+### Removed
 
-- Added a new audio metric `NISQA` ([#2792](https://github.com/PyTorchLightning/metrics/pull/2792))
+-
 
 
-- Added `Dice` metric to segmentation metrics ([#2725](https://github.com/Lightning-AI/torchmetrics/pull/2725))
+### Fixed
 
+- Fixed multiclass recall macro avg. ignore index ([#2710](https://github.com/Lightning-AI/torchmetrics/pull/2710))
 
-- Added support for propagation of the autograd graph in ddp setting ([#2754](https://github.com/Lightning-AI/torchmetrics/pull/2754))
 
+- Fixed iou scores in detection for either empty predictions/targets leading to wrong scores ([#2805](https://github.com/Lightning-AI/torchmetrics/pull/2805))
+
+
+---
+
+## [1.6.0] - 2024-11-12
+
+### Added
+
+- Added audio metric `NISQA` ([#2792](https://github.com/PyTorchLightning/metrics/pull/2792))
+- Added classification metric `LogAUC` ([#2377](https://github.com/Lightning-AI/torchmetrics/pull/2377))
+- Added classification metric `NegativePredictiveValue` ([#2433](https://github.com/Lightning-AI/torchmetrics/pull/2433))
+- Added regression metric `NormalizedRootMeanSquaredError` ([#2442](https://github.com/Lightning-AI/torchmetrics/pull/2442))
+- Added segmentation metric `Dice` ([#2725](https://github.com/Lightning-AI/torchmetrics/pull/2725))
+- Added method `merge_state` to `Metric` ([#2786](https://github.com/Lightning-AI/torchmetrics/pull/2786))
+- Added support for propagation of the autograd graph in ddp setting ([#2754](https://github.com/Lightning-AI/torchmetrics/pull/2754))
 
 ### Changed
 
 - Changed naming and input order arguments in `KLDivergence` ([#2800](https://github.com/Lightning-AI/torchmetrics/pull/2800))
 
-
 ### Deprecated
 
 - Deprecated Dice from classification metrics ([#2725](https://github.com/Lightning-AI/torchmetrics/pull/2725))
 
-
 ### Removed
 
 - Changed minimum supported Pytorch version to 2.0 ([#2671](https://github.com/Lightning-AI/torchmetrics/pull/2671))
-
-
 - Dropped support for Python 3.8 ([#2827](https://github.com/Lightning-AI/torchmetrics/pull/2827))
-
-
 - Removed `num_outputs` in `R2Score` ([#2800](https://github.com/Lightning-AI/torchmetrics/pull/2800))
 
-
 ### Fixed
 
-- Fixed multiclass recall macro avg. ignore index ([#2710](https://github.com/Lightning-AI/torchmetrics/pull/2710))
-
-
-- Fixed iou scores in detection for either empty predictions/targets leading to wrong scores ([#2805](https://github.com/Lightning-AI/torchmetrics/pull/2805))
-
+- Fixed segmentation `Dice` + `GeneralizedDice` for 2d index tensors ([#2832](https://github.com/Lightning-AI/torchmetrics/pull/2832))
+- Fixed mixed results of `rouge_score` with `accumulate='best'` ([#2830](https://github.com/Lightning-AI/torchmetrics/pull/2830))
 
 ---
 

docs/source/classification/logauc.rst

@@ -0,0 +1,55 @@
+.. customcarditem::
+   :header: Log Area Receiver Operating Characteristic (LogAUC)
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
+   :tags: Classification
+
+.. include:: ../links.rst
+
+#######
+Log AUC
+#######
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.LogAUC
+    :exclude-members: update, compute
+    :special-members: __new__
+
+BinaryLogAUC
+^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.BinaryLogAUC
+    :exclude-members: update, compute
+
+MulticlassLogAUC
+^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MulticlassLogAUC
+    :exclude-members: update, compute
+
+MultilabelLogAUC
+^^^^^^^^^^^^^^^^
+
+.. autoclass:: torchmetrics.classification.MultilabelLogAUC
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.logauc
+
+binary_logauc
+^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.binary_logauc
+
+multiclass_logauc
+^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multiclass_logauc
+
+multilabel_logauc
+^^^^^^^^^^^^^^^^^
+
+.. autofunction:: torchmetrics.functional.classification.multilabel_logauc

docs/source/links.rst

@@ -177,4 +177,5 @@
 .. _Hausdorff Distance: https://en.wikipedia.org/wiki/Hausdorff_distance
 .. _averaging curve objects: https://scikit-learn.org/stable/auto_examples/model_selection/plot_roc.html
 .. _Procrustes Disparity: https://en.wikipedia.org/wiki/Procrustes_analysis
+.. _Log AUC: https://pubmed.ncbi.nlm.nih.gov/20735049/
 .. _Negative Predictive Value: https://en.wikipedia.org/wiki/Positive_and_negative_predictive_values

requirements/_tests.txt

@@ -5,15 +5,15 @@ codecov ==2.1.13
 coverage ==7.6.*
 codecov ==2.1.13
 pytest ==8.3.*
-pytest-cov ==5.0.0
+pytest-cov ==6.0.0
 pytest-doctestplus ==1.2.1
 pytest-rerunfailures ==14.0
 pytest-timeout ==2.3.1
 pytest-xdist ==3.6.1
 phmdoctest ==1.4.0
 
 psutil ==6.*
-pyGithub >2.0.0, <2.5.0
+pyGithub >2.0.0, <2.6.0
 fire ==0.7.*
 
 cloudpickle >1.3, <=3.1.0

requirements/classification_test.txt

@@ -5,3 +5,4 @@ pandas >1.4.0, <=2.2.3
 netcal >1.0.0, <1.4.0 # calibration_error
 numpy <2.2.0
 fairlearn # group_fairness
+PyTDC ==0.4.1 ; python_version <"3.12"  # locauc, temporal_dependency

requirements/text.txt

@@ -2,8 +2,8 @@
 #  in case you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment
 
 nltk >3.8.1, <=3.9.1
-tqdm <4.67.0
-regex >=2021.9.24, <=2024.9.11
+tqdm <4.68.0
+regex >=2021.9.24, <=2024.11.6
 transformers >4.4.0, <4.47.0
 mecab-python3 >=1.0.6, <1.1.0
 ipadic >=1.0.0, <1.1.0

src/torchmetrics/__about__.py

@@ -1,8 +1,8 @@
-__version__ = "1.6.0dev"
+__version__ = "1.7.0dev"
 __author__ = "Lightning-AI et al."
 __author_email__ = "[email protected]"
 __license__ = "Apache-2.0"
-__copyright__ = f"Copyright (c) 2020-2023, {__author__}."
+__copyright__ = f"Copyright (c) 2020-2024, {__author__}."
 __homepage__ = "https://github.com/Lightning-AI/torchmetrics"
 __docs__ = "PyTorch native Metrics"
 __docs_url__ = "https://lightning.ai/docs/torchmetrics/stable/"

src/torchmetrics/__init__.py

@@ -68,6 +68,7 @@
     HammingDistance,
     HingeLoss,
     JaccardIndex,
+    LogAUC,
     MatthewsCorrCoef,
     NegativePredictiveValue,
     Precision,
@@ -196,6 +197,7 @@
     "JaccardIndex",
     "KLDivergence",
     "KendallRankCorrCoef",
+    "LogAUC",
     "LogCoshError",
     "MatchErrorRate",
     "MatthewsCorrCoef",

src/torchmetrics/classification/__init__.py

@@ -57,6 +57,7 @@
     MulticlassJaccardIndex,
     MultilabelJaccardIndex,
 )
+from torchmetrics.classification.logauc import BinaryLogAUC, LogAUC, MulticlassLogAUC, MultilabelLogAUC
 from torchmetrics.classification.matthews_corrcoef import (
     BinaryMatthewsCorrCoef,
     MatthewsCorrCoef,
@@ -223,6 +224,10 @@
     "MulticlassSensitivityAtSpecificity",
     "MultilabelSensitivityAtSpecificity",
     "SensitivityAtSpecificity",
+    "BinaryLogAUC",
+    "LogAUC",
+    "MulticlassLogAUC",
+    "MultilabelLogAUC",
     "BinaryNegativePredictiveValue",
     "MulticlassNegativePredictiveValue",
     "MultilabelNegativePredictiveValue",