Skip to content

Commit c6fb578

Browse files
committed
updated AMI documentation for issue scikit-learn#2686
.. _clustering:
1 parent f617253 commit c6fb578

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

sklearn/metrics/cluster/supervised.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -596,8 +596,11 @@ def adjusted_mutual_info_score(labels_true, labels_pred):
596596
Returns
597597
-------
598598
ami: float(upperlimited by 1.0)
599-
The AMI takes a value of 1 when the two partitions
600-
are identical and a value of 0 is expected for random partitions.
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).
601604
602605
See also
603606
--------

0 commit comments

Comments
 (0)