ClassificationMetric

Mother class for all classification metrics.

Parameters

• cm (river.metrics.confusion.ConfusionMatrix) – 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.

• works_with_weights

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

Methods

get

Return the current value of the metric.

is_better_than

revert

Revert the metric.

Parameters

• y_true
• y_pred
• sample_weight – defaults to 1.0

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)