recall_score#

sklearn.metrics.recall_score(y_true, y_pred, *, labels=None, pos_label=1, average='binary', sample_weight=None, zero_division='warn')[source]#

计算召回率。

召回率是比率 tp / (tp + fn)，其中 tp 是真阳性（true positives）的数量，fn 是假阴性（false negatives）的数量。召回率的直观理解是分类器找到所有正样本的能力。

最佳值为 1，最差值为 0。

通过将多分类（multiclass）和多标签（multilabel）数据视为二分类问题的集合（每个标签一个问题），实现对二分类（binary）目标之外的支持。对于二分类（binary）情况，设置 average='binary' 将返回 pos_label 的召回率。如果 average 不是 'binary'，则忽略 pos_label，并计算两个类别的召回率，然后进行平均或返回两者（当 average=None 时）。类似地，对于多分类（multiclass）和多标签（multilabel）目标，所有 labels 的召回率会根据 average 参数返回或平均。使用 labels 指定要计算召回率的标签集。

在用户指南中阅读更多内容。

参数:
y_true1d array-like, or label indicator array / sparse matrix

真实（正确）目标值。稀疏矩阵仅在目标为 多标签 类型时受支持。

y_pred1d array-like, or label indicator array / sparse matrix

分类器返回的估计目标。稀疏矩阵仅在目标为 多标签 类型时受支持。

labels类似数组对象, default=None

当 average != 'binary' 时要包括的标签集，如果 average is None，则为它们的顺序。可以排除数据中存在的标签，例如在多类分类中排除“负类”。可以包括数据中不存在的标签，这些标签将被“分配”0个样本。对于多标签目标，标签是列索引。默认情况下，按排序顺序使用 y_true 和 y_pred 中的所有标签。

版本 0.17 中的变化: 针对多类问题改进了参数 labels。

pos_labelint, float, bool or str, default=1

如果 average='binary' 且数据为二元，则报告的类别，否则此参数将被忽略。对于多类或多标签目标，设置 labels=[pos_label] 和 average != 'binary' 以仅报告一个标签的指标。

average{‘micro’, ‘macro’, ‘samples’, ‘weighted’, ‘binary’} or None, default=’binary’

此参数对于多类/多标签目标是必需的。如果为 None，则返回每个类别的指标。否则，这决定了对数据执行的平均类型

'binary':

仅报告由 pos_label 指定的类别的结果。这仅适用于目标 (y_{true,pred}) 是二元的情况。

'micro':

通过计算总的真正例、假负例和假正例来全局计算指标。

'macro':

计算每个标签的指标，并找到它们的未加权平均值。这不考虑标签不平衡。

'weighted':

计算每个标签的度量指标，并找到按支持度（每个标签的真实实例数）加权的平均值。这会修改“宏平均（macro）”以解决标签不平衡问题；它可能导致 F-score 不在精确率和召回率之间。加权召回率等于准确率。

'samples':

计算每个实例的指标，并找到它们的平均值（仅对多标签分类有意义，这与 accuracy_score 不同）。

sample_weightshape 为 (n_samples,) 的 array-like, default=None

样本权重。

zero_division{“warn”, 0.0, 1.0, np.nan}, default=”warn”

设置当出现零除法时返回的值。

注意事项

  • 如果设置为“warn”，则其作用类似于 0，但也会发出警告。

  • 如果设置为 np.nan，则此类值将被排除在平均值之外。

版本 1.3 中的新增: 添加了 np.nan 选项。

返回:
recallfloat（如果 average 不是 None）或形状为 (n_unique_labels,) 的浮点数组

二分类中正类别的召回率，或多分类任务中每个类别召回率的加权平均值。

另请参阅

precision_recall_fscore_support

计算每个类别的精确度、召回率、F-measure 和支持度。

precision_score

计算比率 tp / (tp + fp)，其中 tp 是真阳性（true positives）的数量，fp 是假阳性（false positives）的数量。

balanced_accuracy_score

计算均衡准确率以处理不平衡数据集。

multilabel_confusion_matrix

计算每个类别或样本的混淆矩阵。

PrecisionRecallDisplay.from_estimator

给定估计器和一些数据，绘制精确度-召回率曲线。

PrecisionRecallDisplay.from_predictions

给定二元类别预测，绘制精确度-召回率曲线。

注意事项

当 true positive + false negative == 0 时，召回率返回 0 并引发 UndefinedMetricWarning。此行为可以通过 zero_division 进行修改。

示例

>>> import numpy as np
>>> from sklearn.metrics import recall_score
>>> y_true = [0, 1, 2, 0, 1, 2]
>>> y_pred = [0, 2, 1, 0, 0, 1]
>>> recall_score(y_true, y_pred, average='macro')
0.33
>>> recall_score(y_true, y_pred, average='micro')
0.33
>>> recall_score(y_true, y_pred, average='weighted')
0.33
>>> recall_score(y_true, y_pred, average=None)
array([1., 0., 0.])
>>> y_true = [0, 0, 0, 0, 0, 0]
>>> recall_score(y_true, y_pred, average=None)
array([0.5, 0. , 0. ])
>>> recall_score(y_true, y_pred, average=None, zero_division=1)
array([0.5, 1. , 1. ])
>>> recall_score(y_true, y_pred, average=None, zero_division=np.nan)
array([0.5, nan, nan])

>>> # multilabel classification
>>> y_true = [[0, 0, 0], [1, 1, 1], [0, 1, 1]]
>>> y_pred = [[0, 0, 0], [1, 1, 1], [1, 1, 0]]
>>> recall_score(y_true, y_pred, average=None)
array([1. , 1. , 0.5])