maxframe.learn.metrics.f1_score#

maxframe.learn.metrics.f1_score(y_true, y_pred, *, labels=None, pos_label=1, average='binary', sample_weight=None, zero_division='warn', execute=False, session=None, run_kwargs=None)[源代码]#

计算 F1 分数，也称为平衡 F 分数或 F 度量

F1 分数可以解释为精确率和召回率的加权平均值，其中 F1 分数的最佳值为 1，最差值为 0。精确率和召回率对 F1 分数的相对贡献相等。F1 分数的公式为：

F1 = 2 * (precision * recall) / (precision + recall)

在多类和多标签情况下，这是每个类别的 F1 分数的平均值，其权重取决于 average 参数。

更多信息请参阅 用户指南。

参数:

  • y_true (1d array-like, or label indicator array / sparse matrix) -- 真实（正确）的目标值。

  • y_pred (1d array-like, or label indicator array / sparse matrix) -- 由分类器返回的预测目标值。

  • labels (list, optional) -- 当 average != 'binary' 时要包含的标签集合，以及当 average is None 时它们的顺序。数据中存在的标签可以被排除，例如在计算多类平均值时忽略多数负类，而数据中不存在的标签将在宏平均中导致 0 组件。对于多标签目标，标签是列索引。默认情况下，将使用 y_true 和 y_pred 中的所有标签并按排序顺序排列。

  • pos_label (str or int, 1 by default) -- 如果 average='binary' 且数据是二分类的，则报告该类别。如果数据是多类或多标签的，则此参数将被忽略；设置 labels=[pos_label] 且 average != 'binary' 将仅报告该标签的分数。

  • average (string, [None, 'binary' (default), 'micro', 'macro', 'samples', 'weighted']) -- 此参数对于多类/多标签目标是必需的。如果为 None，则返回每个类别的分数。否则，此参数决定对数据执行的平均类型：'binary'： 仅报告由 pos_label 指定的类别的结果。 此选项仅适用于目标（y_{true,pred}）是二分类的情况。 'micro'： 通过计算总的真正例、假负例和假正例全局计算指标。 'macro'： 计算每个标签的指标，并求其未加权平均值。这不考虑标签不平衡。 'weighted'： 计算每个标签的指标，并按支持度（每个标签的真正例数）加权平均。这会调整 “macro” 以考虑标签不平衡；它可能导致 F 分数不在精确率和召回率之间。 'samples'： 计算每个实例的指标，并求其平均值（仅在多标签分类中与 accuracy_score() 不同时有意义）。

  • sample_weight (array-like of shape (n_samples,), default=None) -- 样本权重。

  • zero_division ("warn", 0 or 1, default="warn") -- 设置在零除法时返回的值，即所有预测和标签均为负时的情况。如果设置为 "warn"，则其作用为 0，但也会引发警告。

返回:

f1_score -- 在二分类任务中为正类的 F1 分数，或多类任务中每个类别的 F1 分数的加权平均值。

返回类型:

float or array of float, shape = [n_unique_labels]

参见

fbeta_score, precision_recall_fscore_support, jaccard_score, multilabel_confusion_matrix

引用

示例

>>> from maxframe.learn.metrics import f1_score
>>> y_true = [0, 1, 2, 0, 1, 2]
>>> y_pred = [0, 2, 1, 0, 0, 1]
>>> f1_score(y_true, y_pred, average='macro')
0.26...
>>> f1_score(y_true, y_pred, average='micro')
0.33...
>>> f1_score(y_true, y_pred, average='weighted')
0.26...
>>> f1_score(y_true, y_pred, average=None)
array([0.8, 0. , 0. ])
>>> y_true = [0, 0, 0, 0, 0, 0]
>>> y_pred = [0, 0, 0, 0, 0, 0]
>>> f1_score(y_true, y_pred, zero_division=1)
1.0...

备注

当 true positive + false positive == 0 时，precision 未定义；当 true positive + false negative == 0 时，recall 未定义。在这种情况下，默认情况下指标将被设为 0，f-score 也是如此，并且将引发 UndefinedMetricWarning。此行为可以通过 zero_division 进行修改。