Skip to content

WeightedF1

Weighted-average F1 score.

This works by computing the F1 score per class, and then performs a global weighted average by using the support of each class.

Parameters

  • cm

    Default → 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

Examples

from river import metrics

y_true = [0, 1, 2, 2, 2]
y_pred = [0, 0, 2, 2, 1]

metric = metrics.WeightedF1()

for yt, yp in zip(y_true, y_pred):
    metric.update(yt, yp)
    print(metric)

WeightedF1: 100.00%
WeightedF1: 33.33%
WeightedF1: 55.56%
WeightedF1: 66.67%
WeightedF1: 61.33%

Methods

get

Return the current value of the metric.

is_better_than

Indicate if the current metric is better than another one.

Parameters

  • other

revert

Revert the metric.

Parameters

  • y_true
  • y_pred
  • w — defaults to 1.0

update

Update the metric.

Parameters

  • y_true
  • y_pred
  • w — defaults to 1.0

works_with

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

Parameters