precision_recall_fscore_support

sklearn.metrics.precision_recall_fscore_support(y_true, y_pred, *, beta=1.0, labels=None, pos_label=1, average=None, warn_for=('precision', 'recall', 'f-score'), sample_weight=None, zero_division='warn')

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

精确率（precision）是 tp / (tp + fp) 的比值，其中 tp 是真正例的数量，fp 是假正例的数量。直观地说，精确率是分类器不将负样本标记为正样本的能力。

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

F-beta 分数可以解释为精确率和召回率的加权调和平均值，其中 F-beta 分数在 1 时达到最佳值，在 0 时达到最差值。

F-beta 分数将召回率的权重看得比精确率重 beta 倍。beta == 1.0 意味着召回率和精确率同等重要。

支持度（support）是每个类别在 y_true 中出现的次数。

除了 二分类 目标外，支持度也可以通过将 多分类 和 多标签 数据视为一系列二分类问题（每个标签一个）来实现。对于 二分类 情况，设置 average='binary' 将返回 pos_label 的指标。如果 average 不为 'binary'，则忽略 pos_label，计算两个类别的指标，然后进行平均或全部返回（当 average=None 时）。同样，对于 多分类 和 多标签 目标，所有 labels 的指标要么被返回，要么根据 average 参数进行平均。使用 labels 指定要计算指标的标签集合。

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

参数:

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

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

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

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

betafloat, default=1.0

F 分数中召回率相对于精确率的强度。

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':

计算每个标签的指标，并找到按支持度（每个标签的真实实例数）加权的平均值。这会修改“宏平均”以考虑标签不平衡；它可能导致 F 分数不在精确率和召回率之间。

'samples':

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

warn_for列表、元组或集合，供内部使用

这决定了当函数仅用于返回其指标之一时，将发出哪些警告。

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

样本权重。

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

设置除以零时返回的值

• 召回率：当没有正标签时

• 精确率：当没有正预测时

• F 分数：两者皆无时

注意事项

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

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

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

返回:

precision浮点数（如果 average 不为 None）或浮点数组，形状 = [n_unique_labels]

精确率得分。

recall浮点数（如果 average 不为 None）或浮点数组，形状 = [n_unique_labels]

召回率得分。

fbeta_score浮点数（如果 average 不为 None）或浮点数组，形状 = [n_unique_labels]

F-beta 分数。

supportNone（如果 average 不为 None）或整数数组，形状 = [n_unique_labels]

每个标签在 y_true 中出现的次数。

注意事项

当 真正例 + 假正例 == 0 时，精确率未定义。当 真正例 + 假负例 == 0 时，召回率未定义。当 真正例 + 假负例 + 假正例 == 0 时，F 分数未定义。在此类情况下，默认情况下指标将设置为 0，并会引发 UndefinedMetricWarning。此行为可以通过 zero_division 进行修改。

References

[1]

维基百科关于精确率和召回率的条目.

[2]

F1-score 的维基百科条目.

[3]

多标签分类的判别方法，《知识发现与数据挖掘进展》（2004），第 22-30 页，作者：Shantanu Godbole, Sunita Sarawagi.

示例

>>> import numpy as np
>>> from sklearn.metrics import precision_recall_fscore_support
>>> y_true = np.array(['cat', 'dog', 'pig', 'cat', 'dog', 'pig'])
>>> y_pred = np.array(['cat', 'pig', 'dog', 'cat', 'cat', 'dog'])
>>> precision_recall_fscore_support(y_true, y_pred, average='macro')
(0.222, 0.333, 0.267, None)
>>> precision_recall_fscore_support(y_true, y_pred, average='micro')
(0.33, 0.33, 0.33, None)
>>> precision_recall_fscore_support(y_true, y_pred, average='weighted')
(0.222, 0.333, 0.267, None)

可以计算每个标签的精确率、召回率、F1 分数和支持度，而不是进行平均

>>> precision_recall_fscore_support(y_true, y_pred, average=None,
... labels=['pig', 'dog', 'cat'])
(array([0.        , 0.        , 0.66]),
 array([0., 0., 1.]), array([0. , 0. , 0.8]),
 array([2, 2, 2]))