Skip to content

Commit fa0ecd4

Browse files
Vincent-Maladiereglemaitre
authored andcommitted
DOC Ensures that mutual_info_score passes numpydoc validation (#24091)
1 parent f5b82c9 commit fa0ecd4

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

sklearn/metrics/cluster/_supervised.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -768,14 +768,14 @@ def mutual_info_score(labels_true, labels_pred, *, contingency=None):
768768
Mutual information, a non-negative value, measured in nats using the
769769
natural logarithm.
770770
771-
Notes
772-
-----
773-
The logarithm used is the natural logarithm (base-e).
774-
775771
See Also
776772
--------
777773
adjusted_mutual_info_score : Adjusted against chance Mutual Information.
778774
normalized_mutual_info_score : Normalized Mutual Information.
775+
776+
Notes
777+
-----
778+
The logarithm used is the natural logarithm (base-e).
779779
"""
780780
if contingency is None:
781781
labels_true, labels_pred = check_clusterings(labels_true, labels_pred)

sklearn/tests/test_docstrings.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
"sklearn.metrics.cluster._supervised.adjusted_rand_score",
4040
"sklearn.metrics.cluster._supervised.entropy",
4141
"sklearn.metrics.cluster._supervised.fowlkes_mallows_score",
42-
"sklearn.metrics.cluster._supervised.mutual_info_score",
4342
"sklearn.metrics.cluster._supervised.normalized_mutual_info_score",
4443
"sklearn.metrics.cluster._supervised.pair_confusion_matrix",
4544
"sklearn.metrics.cluster._supervised.rand_score",

0 commit comments

Comments
 (0)