New metrics: Homogeneity, Completness, V-Measure (Lightning-AI#2053)

Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
matsumotosan · Sep 15, 2023 · 8da841c · 8da841c
1 parent b7b118a
commit 8da841c
Show file tree

Hide file tree

Showing 10 changed files with 626 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     - `DunnIndex` ([#2049](https://github.com/Lightning-AI/torchmetrics/pull/2049))
 
+    - `HomogeneityScore` ([#2053](https://github.com/Lightning-AI/torchmetrics/pull/2053))
+
+    - `CompletenessScore` ([#2053](https://github.com/Lightning-AI/torchmetrics/pull/2053))
+
+    - `VMeasureScore` ([#2053](https://github.com/Lightning-AI/torchmetrics/pull/2053))
+
     - `FowlkesMallowsIndex` ([#2066](https://github.com/Lightning-AI/torchmetrics/pull/2066))
 
     - `DaviesBouldinScore` ([#2071](https://github.com/Lightning-AI/torchmetrics/pull/2071))

diff --git a/docs/source/clustering/completeness_score.rst b/docs/source/clustering/completeness_score.rst
@@ -0,0 +1,21 @@
+.. customcarditem::
+   :header: Completeness Score
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/default.svg
+   :tags: Clustering
+
+.. include:: ../links.rst
+
+##################
+Completeness Score
+##################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.clustering.CompletenessScore
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.clustering.completeness_score
diff --git a/docs/source/clustering/homogeneity_score.rst b/docs/source/clustering/homogeneity_score.rst
@@ -0,0 +1,21 @@
+.. customcarditem::
+   :header: Homogeneity Score
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/default.svg
+   :tags: Clustering
+
+.. include:: ../links.rst
+
+#################
+Homogeneity Score
+#################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.clustering.HomogeneityScore
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.clustering.homogeneity_score
diff --git a/docs/source/clustering/v_measure_score.rst b/docs/source/clustering/v_measure_score.rst
@@ -0,0 +1,21 @@
+.. customcarditem::
+   :header: V-Measure Score
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/default.svg
+   :tags: Clustering
+
+.. include:: ../links.rst
+
+###############
+V-Measure Score
+###############
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.clustering.VMeasureScore
+    :exclude-members: update, compute
+
+Functional Interface
+____________________
+
+.. autofunction:: torchmetrics.functional.clustering.v_measure_score
diff --git a/docs/source/links.rst b/docs/source/links.rst
@@ -158,5 +158,8 @@
 .. _fork of pycocotools: https://github.com/ppwwyyxx/cocoapi
 .. _Adjusted Rand Score: https://en.wikipedia.org/wiki/Rand_index#Adjusted_Rand_index
 .. _Dunn Index: https://en.wikipedia.org/wiki/Dunn_index
+.. _V-Measure Score: https://www.aclweb.org/anthology/D07-1043.pdf
+.. _Homogeneity Score: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.homogeneity_score.html
+.. _Completeness Score: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.completeness_score.html
 .. _Davies-Bouldin Score: https://en.wikipedia.org/wiki/Davies%E2%80%93Bouldin_index
 .. _Fowlkes-Mallows Index: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.fowlkes_mallows_score.html#sklearn.metrics.fowlkes_mallows_score
diff --git a/src/torchmetrics/clustering/__init__.py b/src/torchmetrics/clustering/__init__.py
@@ -16,17 +16,25 @@
 from torchmetrics.clustering.davies_bouldin_score import DaviesBouldinScore
 from torchmetrics.clustering.dunn_index import DunnIndex
 from torchmetrics.clustering.fowlkes_mallows_index import FowlkesMallowsIndex
+from torchmetrics.clustering.homogeneity_completeness_v_measure import (
+    CompletenessScore,
+    HomogeneityScore,
+    VMeasureScore,
+)
 from torchmetrics.clustering.mutual_info_score import MutualInfoScore
 from torchmetrics.clustering.normalized_mutual_info_score import NormalizedMutualInfoScore
 from torchmetrics.clustering.rand_score import RandScore
 
 __all__ = [
     "AdjustedRandScore",
     "CalinskiHarabaszScore",
+    "CompletenessScore",
     "DaviesBouldinScore",
     "DunnIndex",
     "FowlkesMallowsIndex",
+    "HomogeneityScore",
     "MutualInfoScore",
     "NormalizedMutualInfoScore",
     "RandScore",
+    "VMeasureScore",
 ]