Homogeneity¶

Homogeneity Score.

Homogeneity metric ¹ of a cluster labeling given a ground truth.

In order to satisfy the homogeneity criteria, a clustering must assign only those data points that are members of a single class to a single cluster. That is, the class distribution within each cluster should be skewed to a single class, that is, zero entropy. We determine how close a given clustering is to this ideal by examining the conditional entropy of the class distribution given the proposed clustering.

However, in an imperfect situation, the size of this value is dependent on the size of the dataset and the distribution of class sizes. Therefore, instead of taking the raw conditional entropy, we normalize by the maximum reduction in entropy the clustering information could provide.

As such, we define homogeneity as:

\[ h = \begin{cases} 1 if H(C) = 0, \\ 1 - \frac{H(C|K)}{H(C)} otherwise. \end{cases}. \]

Parameters¶

cm – defaults to None

This parameter allows sharing the same confusion matrix between multiple metrics. Sharing a confusion matrix reduces the amount of storage and computation time.

Attributes¶

bigger_is_better

Indicate if a high value is better than a low one or not.
requires_labels

Indicates if labels are required, rather than probabilities.
sample_correction
works_with_weights

Indicate whether the model takes into consideration the effect of sample weights

Examples¶

>>> from river import metrics

>>> y_true = [1, 1, 2, 2, 3, 3]
>>> y_pred = [1, 1, 1, 2, 2, 2]

>>> metric = metrics.Homogeneity()
>>> for yt, yp in zip(y_true, y_pred):
...     print(metric.update(yt, yp).get())
1.0
1.0
0.0
0.311278
0.37515
0.42062

>>> metric
Homogeneity: 0.42062

Methods¶

clone

Return a fresh estimator with the same parameters.

The clone has the same parameters but has not been updated with any data. This works by looking at the parameters from the class signature. Each parameter is either - recursively cloned if it's a River classes. - deep-copied via copy.deepcopy if not. If the calling object is stochastic (i.e. it accepts a seed parameter) and has not been seeded, then the clone will not be idempotent. Indeed, this method's purpose if simply to return a new instance with the same input parameters.

get

Return the current value of the metric.

revert

Revert the metric.

Parameters

y_true
y_pred
sample_weight – defaults to 1.0
correction – defaults to None

update

Update the metric.

Parameters

y_true
y_pred
sample_weight – defaults to 1.0

works_with

Indicates whether or not a metric can work with a given model.

Parameters

model (river.base.estimator.Estimator)

References¶

Andrew Rosenberg and Julia Hirschberg (2007). V-Measure: A conditional entropy-based external cluster evaluation measure. Proceedings of the 2007 Joing Conference on Empirical Methods in Natural Language Processing and Computational Natural Language Learning, pp. 410 - 420, Prague, June 2007. ↩