Package smile.validation.metric

Class MutualInformation

java.lang.Object

smile.validation.metric.MutualInformation

All Implemented Interfaces:

Serializable, ClusteringMetric

public class MutualInformation
extends Object
implements ClusteringMetric

Mutual Information for comparing clustering.

References

1. X. Vinh, J. Epps, J. Bailey. Information Theoretic Measures for Clusterings Comparison: Variants, Properties, Normalization and Correction for Chance. JMLR, 2010.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final MutualInformation	instance	Default instance.

Constructor Summary

Constructors

Constructor	Description
MutualInformation()

Method Summary

Modifier and Type	Method	Description
static double	of(int[] truth, int[] cluster)	Calculates the mutual information.
double	score(int[] truth, int[] cluster)	Returns a score to measure the quality of clustering.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

instance

public static final MutualInformation instance

Default instance.

Constructor Details

MutualInformation

public MutualInformation()

Method Details

score

public double score(int[] truth,
 int[] cluster)

Description copied from interface: ClusteringMetric

Returns a score to measure the quality of clustering.

Specified by:

score in interface ClusteringMetric

Parameters:

truth - the ground truth (or simply a clustering labels).

cluster - the alternative cluster labels.

Returns:

the metric.

of

public static double of(int[] truth,
 int[] cluster)

Calculates the mutual information.

Parameters:

truth - the ground truth (or simply a clustering labels).

cluster - the alternative cluster labels.

Returns:

the metric.

toString

public String toString()

Overrides:

toString in class Object