recall_score#
- sklearn.metrics.recall_score(y_true, y_pred, *, labels=None, pos_label=1, average='binary', sample_weight=None, zero_division='warn')#
计算召回率。
召回率是比率
tp / (tp + fn)，其中tp是真阳性的数量，fn是假阴性的数量。召回率直观地表示分类器找到所有正样本的能力。最佳值是 1，最差值是 0。
对超出术语:
binary目标的支持是通过将 multiclass 和 multilabel 数据视为二元问题的集合来实现的，每个标签一个。对于 binary 情况，设置average='binary'将返回pos_label的召回率。如果average不是'binary'，则忽略pos_label，并计算两个类别的召回率然后平均或同时返回（当average=None时）。类似地，对于 multiclass 和 multilabel 目标，所有labels的召回率根据average参数返回或平均。使用labels指定要计算召回率的标签集。更多信息请参阅 用户指南 。
- Parameters:
- y_true1d array-like, 或标签指示器数组 / 稀疏矩阵
真实（正确）的目标值。
- y_pred1d array-like, 或标签指示器数组 / 稀疏矩阵
分类器返回的估计目标。
- labelsarray-like, 默认=None
当
average != 'binary'时要包含的标签集，以及当average is None时的顺序。数据中存在的标签可以被排除，例如在多类分类中排除一个“负类”。数据中不存在的标签可以被包含，并将被“分配”0 个样本。对于多标签目标，标签是列索引。默认情况下，y_true和y_pred中的所有标签按排序顺序使用。Changed in version 0.17: 多类问题的
labels参数改进。- pos_labelint, float, bool 或 str, 默认=1
如果
average='binary'且数据是二元的，则报告的类别，否则忽略此参数。对于多类或多标签目标，设置labels=[pos_label]和average != 'binary'以仅报告一个标签的指标。- average{‘micro’, ‘macro’, ‘samples’, ‘weighted’, ‘binary’} 或 None, 默认=’binary’
此参数对于多类/多标签目标是必需的。如果
None，则返回每个类别的分数。否则，这决定了对数据执行的平均类型：'binary':仅报告由
pos_label指定的类别的结果。仅在目标 (y_{true,pred}) 是二元时适用。'micro':通过计算总的真阳性、假阴性和假阳性的总数来全局计算指标。
'macro':计算每个标签的指标，并找到它们的未加权平均值。这不考虑标签不平衡。
'weighted':计算每个标签的指标，并根据支持（每个标签的真实例数）找到它们的加权平均值。这改变了 ‘macro’ 以考虑标签不平衡；它可能导致 F-score 不在精确率和召回率之间。加权召回率等于准确率。
'samples':计算每个实例的指标，并找到它们的平均值（仅在多标签分类中有意义，这与
accuracy_score不同）。
- sample_weightarray-like of shape (n_samples,), 默认=None
样本权重。
- zero_division{“warn”, 0.0, 1.0, np.nan}, 默认=”warn”
设置在除以零时返回的值。
注意： - 如果设置为 “warn”，这相当于 0，但也会引发警告。 - 如果设置为
np.nan，此类值将从平均值中排除。Added in version 1.3:
np.nan选项已添加。
- Returns:
- recallfloat（如果 average 不是 None）或 float 数组的形状 (n_unique_labels,)
二元分类中正类别的召回率或每个类别召回率的加权平均值。
See also
precision_recall_fscore_support计算每个类别的精确率、召回率、F-measure 和支持。
precision_score计算比率
tp / (tp + fp)，其中tp是真阳性的数量，fp是假阳性的数量。balanced_accuracy_score计算平衡准确率以处理不平衡数据集。
multilabel_confusion_matrix计算每个类别或样本的混淆矩阵。
PrecisionRecallDisplay.from_estimator给定估计器和数据绘制精确率-召回率曲线。
PrecisionRecallDisplay.from_predictions给定二元类别预测绘制精确率-召回率曲线。
Notes
当
真阳性 + 假阴性 == 0时，召回率返回 0 并引发UndefinedMetricWarning。此行为可以通过zero_division修改。Examples
>>> 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])
>>> # 多标签分类 >>> 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])
