recall#

EstimatorReport.metrics.recall(*, data_source='test', average=None)[source]#

Compute the recall score.

Parameters:
data_source{“test”, “train”}, default=”test”

The data source to use.

  • “test” : use the test set provided when creating the report.

  • “train” : use the train set provided when creating the report.

average{“binary”,”macro”, “micro”, “weighted”, “samples”} or None, default=None

Used with multiclass problems. If None, the metrics for each class are returned. Otherwise, this determines the type of averaging performed on the data:

  • “binary”: Only report results for the class specified by the report’s pos_label. This is applicable only if targets (y_{true,pred}) are binary.

  • “micro”: Calculate metrics globally by counting the total true positives, false negatives and false positives.

  • “macro”: Calculate metrics for each label, and find their unweighted mean. This does not take label imbalance into account.

  • “weighted”: Calculate metrics for each label, and find their average weighted by support (the number of true instances for each label). This alters ‘macro’ to account for label imbalance; it can result in an F-score that is not between precision and recall. Weighted recall is equal to accuracy.

  • “samples”: Calculate metrics for each instance, and find their average (only meaningful for multilabel classification where this differs from accuracy_score()).

Note

If pos_label is specified and average is None, then we report only the statistics of the positive class (i.e. equivalent to average="binary").

Returns:
float or dict

The recall score.

Examples

>>> from sklearn.datasets import load_breast_cancer
>>> from sklearn.linear_model import LogisticRegression
>>> from skore import train_test_split
>>> from skore import EstimatorReport
>>> X, y = load_breast_cancer(return_X_y=True)
>>> split_data = train_test_split(X=X, y=y, random_state=0, as_dict=True)
>>> classifier = LogisticRegression(max_iter=10_000)
>>> report = EstimatorReport(classifier, **split_data, pos_label=1)
>>> report.metrics.recall()
0.93...