Skip to content

Commit f1c8dcb

Browse files
committed
update ami doc for feedback on PR
1 parent c6fb578 commit f1c8dcb

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

sklearn/metrics/cluster/supervised.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -596,11 +596,9 @@ def adjusted_mutual_info_score(labels_true, labels_pred):
596596
Returns
597597
-------
598598
ami: float(upperlimited by 1.0)
599-
The AMI returns a value of 1 when the two partitions
600-
are identical (ie perfectly matched), and a value of 0 is expected
601-
for random partitions. A negative value greater than may also
602-
be returned if the actual mutual information is less than the
603-
expectation value of the mutual information (independent labelling).
599+
The AMI returns a value of 1 when the two partitions are identical
600+
(ie perfectly matched). Random partitions (independent labellings) have
601+
an expected AMI around 0 on average hence can be negative.
604602
605603
See also
606604
--------

0 commit comments

Comments
 (0)