From c3afd9a715cd059fb17bf0e4a12932fea12453d7 Mon Sep 17 00:00:00 2001 From: Andrew White Date: Fri, 1 Apr 2022 13:41:38 +0100 Subject: [PATCH 1/5] remove completeness_score from test ignore list --- sklearn/tests/test_docstrings.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sklearn/tests/test_docstrings.py b/sklearn/tests/test_docstrings.py index d61183e4f09be..07a8364a8377f 100644 --- a/sklearn/tests/test_docstrings.py +++ b/sklearn/tests/test_docstrings.py @@ -59,7 +59,6 @@ "sklearn.metrics.cluster._bicluster.consensus_score", "sklearn.metrics.cluster._supervised.adjusted_mutual_info_score", "sklearn.metrics.cluster._supervised.adjusted_rand_score", - "sklearn.metrics.cluster._supervised.completeness_score", "sklearn.metrics.cluster._supervised.entropy", "sklearn.metrics.cluster._supervised.fowlkes_mallows_score", "sklearn.metrics.cluster._supervised.homogeneity_completeness_v_measure", From 284996d6d0575ebc9bf3224a85e9df06030f11af Mon Sep 17 00:00:00 2001 From: Andrew White Date: Fri, 1 Apr 2022 13:45:03 +0100 Subject: [PATCH 2/5] correct section order of completeness_score --- sklearn/metrics/cluster/_supervised.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/sklearn/metrics/cluster/_supervised.py b/sklearn/metrics/cluster/_supervised.py index b09b1fcf1916c..209e5e0257982 100644 --- a/sklearn/metrics/cluster/_supervised.py +++ b/sklearn/metrics/cluster/_supervised.py @@ -582,6 +582,11 @@ def completeness_score(labels_true, labels_pred): completeness : float score between 0.0 and 1.0. 1.0 stands for perfectly complete labeling + See Also + -------- + homogeneity_score + v_measure_score + References ---------- @@ -589,11 +594,6 @@ def completeness_score(labels_true, labels_pred): conditional entropy-based external cluster evaluation measure `_ - See Also - -------- - homogeneity_score - v_measure_score - Examples -------- From 786d420b35774cff869f632d8bc2d3c4e1f486fd Mon Sep 17 00:00:00 2001 From: Andrew White Date: Fri, 1 Apr 2022 13:47:12 +0100 Subject: [PATCH 3/5] Capitalise and full stop on parameters and returns --- sklearn/metrics/cluster/_supervised.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sklearn/metrics/cluster/_supervised.py b/sklearn/metrics/cluster/_supervised.py index 209e5e0257982..b76c89f06b903 100644 --- a/sklearn/metrics/cluster/_supervised.py +++ b/sklearn/metrics/cluster/_supervised.py @@ -572,15 +572,15 @@ def completeness_score(labels_true, labels_pred): Parameters ---------- labels_true : int array, shape = [n_samples] - ground truth class labels to be used as a reference + Ground truth class labels to be used as a reference. labels_pred : array-like of shape (n_samples,) - cluster labels to evaluate + Cluster labels to evaluate. Returns ------- completeness : float - score between 0.0 and 1.0. 1.0 stands for perfectly complete labeling + Score between 0.0 and 1.0. 1.0 stands for perfectly complete labeling. See Also -------- From f90b4444cdb68e671f5a1caf538fd8c887903c37 Mon Sep 17 00:00:00 2001 From: Andrew White Date: Fri, 1 Apr 2022 14:03:44 +0100 Subject: [PATCH 4/5] Add description to See Also section --- sklearn/metrics/cluster/_supervised.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sklearn/metrics/cluster/_supervised.py b/sklearn/metrics/cluster/_supervised.py index b76c89f06b903..e5684d516bbcd 100644 --- a/sklearn/metrics/cluster/_supervised.py +++ b/sklearn/metrics/cluster/_supervised.py @@ -584,8 +584,8 @@ def completeness_score(labels_true, labels_pred): See Also -------- - homogeneity_score - v_measure_score + homogeneity_score : Homogeneity metric of cluster labeling. + v_measure_score : V-Measure (NMI with arithmetic mean option). References ---------- From fba57abb07770980ddef199214468e5df8cdb2dc Mon Sep 17 00:00:00 2001 From: Andrew White Date: Fri, 1 Apr 2022 14:12:33 +0100 Subject: [PATCH 5/5] Fix summary starts with infinitive verb --- sklearn/metrics/cluster/_supervised.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/metrics/cluster/_supervised.py b/sklearn/metrics/cluster/_supervised.py index e5684d516bbcd..a6a66884b70b2 100644 --- a/sklearn/metrics/cluster/_supervised.py +++ b/sklearn/metrics/cluster/_supervised.py @@ -554,7 +554,7 @@ def homogeneity_score(labels_true, labels_pred): def completeness_score(labels_true, labels_pred): - """Completeness metric of a cluster labeling given a ground truth. + """Compute completeness metric of a cluster labeling given a ground truth. A clustering result satisfies completeness if all the data points that are members of a given class are elements of the same cluster.