► Keras 2 API 文档 / 指标 / 基于真正/假正例和假反例的分类指标

基于真正/假正例和假反例的分类指标

`AUC` 类

tf_keras.metrics.AUC(
    num_thresholds=200,
    curve="ROC",
    summation_method="interpolation",
    name=None,
    dtype=None,
    thresholds=None,
    multi_label=False,
    num_labels=None,
    label_weights=None,
    from_logits=False,
)

近似计算 ROC 或 PR 曲线的 AUC（曲线下面积）。

ROC（接收者操作特征；默认）或 PR（精确率召回率）曲线的 AUC（曲线下面积）是二元分类器的质量度量。与准确率不同，并且与交叉熵损失类似，ROC-AUC 和 PR-AUC 会评估模型的所有操作点。

此类使用黎曼和来近似 AUC。在指标累积阶段，预测会根据值累积到预定义的区间内。然后通过内插每个区间的平均值来计算 AUC。这些区间定义了评估的操作点。

此指标创建四个局部变量，true_positives、true_negatives、false_positives 和 false_negatives，用于计算 AUC。为了离散化 AUC 曲线，使用线性间隔的阈值集来计算召回率和精确率值的配对。因此，ROC 曲线下的面积使用召回率值的高度乘以假正例率来计算，而 PR 曲线下的面积使用精确率值的高度乘以召回率来计算。

此值最终作为 auc 返回，这是一个幂等操作，用于计算精确率与召回率值离散化曲线的下面积（使用上述变量计算）。num_thresholds 变量控制离散化的程度，较大的阈值数量更接近于真实 AUC。近似的质量可能会因 num_thresholds 而异。thresholds 参数可用于手动指定更均匀地分割预测的阈值。

为了获得真实 AUC 的最佳近似值，predictions 应在 [0, 1] 范围内近似均匀分布（如果 from_logits=False）。如果不是这种情况，AUC 近似的质量可能会很差。将 summation_method 设置为 'minoring' 或 'majoring' 可以通过提供 AUC 的下限或上限估计来帮助量化近似误差。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

参数

num_thresholds：（可选）离散化 ROC 曲线时要使用的阈值数量。值必须 > 1。默认为 200。
curve：（可选）指定要计算的曲线的名称，“ROC”（默认）或“PR”表示精确率召回率曲线。
summation_method：（可选）指定使用的黎曼求和方法。'interpolation'（默认）对 ROC 应用中点求和方案。对于 PR-AUC，内插（真/假）正例，但不内插精确率的比率（有关详细信息，请参阅 Davis & Goadrich 2006）；'minoring' 对递增区间应用左求和，对递减区间应用右求和；'majoring' 执行相反的操作。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。
thresholds：（可选）用作离散化曲线的阈值的一组浮点值。如果设置，则忽略 num_thresholds 参数。值应在 [0, 1] 范围内。对于一个小的正 epsilon 值，等于 {-epsilon, 1+epsilon} 的端点阈值将自动包含在内，以正确处理正好等于 0 或 1 的预测。
multi_label：布尔值，指示是否应将多标签数据视为多标签数据，其中 AUC 分别针对每个标签计算，然后跨标签平均，或者（如果为 False）数据在 AUC 计算之前是否应展平为单个标签。在后一种情况下，当多标签数据传递给 AUC 时，每个标签-预测对都被视为一个单独的数据点。对于多类数据，应将其设置为 False。
num_labels：（可选）标签的数量，在 multi_label 为 True 时使用。如果未指定 num_labels，则在第一次调用 update_state 时创建状态变量。
label_weights：（可选）用于计算多标签数据 AUC 的非负权重的列表、数组或张量。当 multi_label 为 True 时，权重应用于单个标签 AUC，当它们被平均以产生多标签 AUC 时。当它为 False 时，它们用于在计算扁平化数据的混淆矩阵时对单个标签预测进行加权。请注意，这与 class_weights 不同，因为 class_weights 根据其标签的值对示例进行加权，而 label_weights 仅取决于扁平化前该标签的索引；因此，label_weights 不应用于多类数据。
from_logits：布尔值，指示预测（y_pred 在 update_state 中）是概率还是 sigmoid 对数。根据经验，当使用 Keras 损失时，损失的 from_logits 构造函数参数应与 AUC 的 from_logits 构造函数参数匹配。

独立使用

>>> m = tf.keras.metrics.AUC(num_thresholds=3)
>>> m.update_state([0, 0, 1, 1], [0, 0.5, 0.3, 0.9])
>>> # threshold values are [0 - 1e-7, 0.5, 1 + 1e-7]
>>> # tp = [2, 1, 0], fp = [2, 0, 0], fn = [0, 1, 2], tn = [0, 2, 2]
>>> # tp_rate = recall = [1, 0.5, 0], fp_rate = [1, 0, 0]
>>> # auc = ((((1+0.5)/2)*(1-0)) + (((0.5+0)/2)*(0-0))) = 0.75
>>> m.result().numpy()
0.75

>>> m.reset_state()
>>> m.update_state([0, 0, 1, 1], [0, 0.5, 0.3, 0.9],
...                sample_weight=[1, 0, 0, 1])
>>> m.result().numpy()
1.0

与 compile() API 结合使用

# Reports the AUC of a model outputting a probability.
model.compile(optimizer='sgd',
              loss=tf.keras.losses.BinaryCrossentropy(),
              metrics=[tf.keras.metrics.AUC()])

# Reports the AUC of a model outputting a logit.
model.compile(optimizer='sgd',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.AUC(from_logits=True)])

[源代码]

`Precision` 类

tf_keras.metrics.Precision(
    thresholds=None, top_k=None, class_id=None, name=None, dtype=None
)

计算预测相对于标签的精确率。

该指标创建两个局部变量，true_positives 和 false_positives，用于计算精确率。此值最终作为 precision 返回，这是一个幂等操作，它简单地将 true_positives 除以 true_positives 和 false_positives 的总和。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

如果设置了 top_k，我们将计算精确率，即批次条目中预测值最高的 top-k 类中，有多少类是正确的，并且可以在该条目的标签中找到。

如果指定了 class_id，我们将通过仅考虑批次中 class_id 高于阈值和/或在 top-k 最高预测中的条目来计算精确率，并计算其中 class_id 确实是正确标签的条目的分数。

参数

thresholds：（可选）浮点值，或 [0, 1] 中的浮点阈值列表/元组。阈值与预测值进行比较以确定预测的真值（即，高于阈值则为 true，低于则为 false）。如果与设置 from_logits=True 的损失函数一起使用（即，对预测不应用 sigmoid），则 thresholds 应设置为 0。每个阈值都会生成一个指标值。如果既没有设置 thresholds 也没有设置 top_k，则默认为使用 thresholds=0.5 计算精确率。
top_k：（可选）默认情况下未设置。一个整数，指定计算精确率时要考虑的 top-k 预测。
class_id：（可选）我们想要二元指标的整数类 ID。这必须在半开区间 [0, num_classes) 内，其中 num_classes 是预测的最后一个维度。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.Precision()
>>> m.update_state([0, 1, 1, 1], [1, 0, 1, 1])
>>> m.result().numpy()
0.6666667

>>> m.reset_state()
>>> m.update_state([0, 1, 1, 1], [1, 0, 1, 1], sample_weight=[0, 0, 1, 0])
>>> m.result().numpy()
1.0

>>> # With top_k=2, it will calculate precision over y_true[:2]
>>> # and y_pred[:2]
>>> m = tf.keras.metrics.Precision(top_k=2)
>>> m.update_state([0, 0, 1, 1], [1, 1, 1, 1])
>>> m.result().numpy()
0.0

>>> # With top_k=4, it will calculate precision over y_true[:4]
>>> # and y_pred[:4]
>>> m = tf.keras.metrics.Precision(top_k=4)
>>> m.update_state([0, 0, 1, 1], [1, 1, 1, 1])
>>> m.result().numpy()
0.5

与 compile() API 结合使用

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[tf.keras.metrics.Precision()])

与 from_logits=True 的损失一起使用

model.compile(optimizer='adam',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.Precision(thresholds=0)])

[源代码]

`Recall` 类

tf_keras.metrics.Recall(
    thresholds=None, top_k=None, class_id=None, name=None, dtype=None
)

计算预测相对于标签的召回率。

此指标创建两个局部变量，true_positives 和 false_negatives，用于计算召回率。此值最终作为 recall 返回，这是一个幂等操作，它简单地将 true_positives 除以 true_positives 和 false_negatives 的总和。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

如果设置了 top_k，则召回率将计算为批次条目标签中，有多少类在 top-k 预测中。

如果指定了 class_id，我们将通过仅考虑批次中 class_id 位于标签中的条目来计算召回率，并计算其中 class_id 高于阈值和/或在 top-k 预测中的条目的分数。

参数

thresholds：（可选）浮点值，或 [0, 1] 中的浮点阈值列表/元组。阈值与预测值进行比较以确定预测的真值（即，高于阈值则为 true，低于则为 false）。如果与设置 from_logits=True 的损失函数一起使用（即，对预测不应用 sigmoid），则 thresholds 应设置为 0。每个阈值都会生成一个指标值。如果既没有设置 thresholds 也没有设置 top_k，则默认为使用 thresholds=0.5 计算召回率。
top_k：（可选）默认情况下未设置。一个整数，指定计算召回率时要考虑的 top-k 预测。
class_id：（可选）我们想要二元指标的整数类 ID。这必须在半开区间 [0, num_classes) 内，其中 num_classes 是预测的最后一个维度。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.Recall()
>>> m.update_state([0, 1, 1, 1], [1, 0, 1, 1])
>>> m.result().numpy()
0.6666667

>>> m.reset_state()
>>> m.update_state([0, 1, 1, 1], [1, 0, 1, 1], sample_weight=[0, 0, 1, 0])
>>> m.result().numpy()
1.0

与 compile() API 结合使用

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[tf.keras.metrics.Recall()])

与 from_logits=True 的损失一起使用

model.compile(optimizer='adam',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.Recall(thresholds=0)])

[源代码]

`TruePositives` 类

tf_keras.metrics.TruePositives(thresholds=None, name=None, dtype=None)

计算真正例的数量。

如果给定 sample_weight，则计算真正例权重的总和。此指标创建一个局部变量 true_positives，用于跟踪真正例的数量。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

参数

thresholds：（可选）浮点值，或 [0, 1] 中的浮点阈值列表/元组。阈值与预测值进行比较以确定预测的真值（即，高于阈值则为 true，低于则为 false）。如果与设置 from_logits=True 的损失函数一起使用（即，对预测不应用 sigmoid），则 thresholds 应设置为 0。每个阈值都会生成一个指标值。默认为 0.5。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.TruePositives()
>>> m.update_state([0, 1, 1, 1], [1, 0, 1, 1])
>>> m.result().numpy()
2.0

>>> m.reset_state()
>>> m.update_state([0, 1, 1, 1], [1, 0, 1, 1], sample_weight=[0, 0, 1, 0])
>>> m.result().numpy()
1.0

与 compile() API 结合使用

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[tf.keras.metrics.TruePositives()])

与 from_logits=True 的损失一起使用

model.compile(optimizer='adam',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.TruePositives(thresholds=0)])

[源代码]

`TrueNegatives` 类

tf_keras.metrics.TrueNegatives(thresholds=None, name=None, dtype=None)

计算真反例的数量。

如果给定 sample_weight，则计算真反例权重的总和。此指标创建一个局部变量 accumulator，用于跟踪真反例的数量。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

参数

thresholds：（可选）浮点值，或 [0, 1] 中的浮点阈值列表/元组。阈值与预测值进行比较以确定预测的真值（即，高于阈值则为 true，低于则为 false）。如果与设置 from_logits=True 的损失函数一起使用（即，对预测不应用 sigmoid），则 thresholds 应设置为 0。每个阈值都会生成一个指标值。默认为 0.5。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.TrueNegatives()
>>> m.update_state([0, 1, 0, 0], [1, 1, 0, 0])
>>> m.result().numpy()
2.0

>>> m.reset_state()
>>> m.update_state([0, 1, 0, 0], [1, 1, 0, 0], sample_weight=[0, 0, 1, 0])
>>> m.result().numpy()
1.0

与 compile() API 结合使用

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[tf.keras.metrics.TrueNegatives()])

与 from_logits=True 的损失一起使用

model.compile(optimizer='adam',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.TrueNegatives(thresholds=0)])

[源代码]

`FalsePositives` 类

tf_keras.metrics.FalsePositives(thresholds=None, name=None, dtype=None)

计算假正例的数量。

如果给定 sample_weight，则计算假正例权重的总和。此指标创建一个局部变量 accumulator，用于跟踪假正例的数量。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

参数

thresholds：（可选）浮点值，或 [0, 1] 中的浮点阈值列表/元组。阈值与预测值进行比较以确定预测的真值（即，高于阈值则为 true，低于则为 false）。如果与设置 from_logits=True 的损失函数一起使用（即，对预测不应用 sigmoid），则 thresholds 应设置为 0。每个阈值都会生成一个指标值。默认为 0.5。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.FalsePositives()
>>> m.update_state([0, 1, 0, 0], [0, 0, 1, 1])
>>> m.result().numpy()
2.0

>>> m.reset_state()
>>> m.update_state([0, 1, 0, 0], [0, 0, 1, 1], sample_weight=[0, 0, 1, 0])
>>> m.result().numpy()
1.0

与 compile() API 结合使用

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[tf.keras.metrics.FalsePositives()])

与 from_logits=True 的损失一起使用

model.compile(optimizer='adam',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.FalsePositives(thresholds=0)])

[源代码]

`FalseNegatives` 类

tf_keras.metrics.FalseNegatives(thresholds=None, name=None, dtype=None)

计算假反例的数量。

如果给定 sample_weight，则计算假反例权重的总和。此指标创建一个局部变量 accumulator，用于跟踪假反例的数量。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

参数

thresholds：（可选）浮点值，或 [0, 1] 中的浮点阈值列表/元组。阈值与预测值进行比较以确定预测的真值（即，高于阈值则为 true，低于则为 false）。如果与设置 from_logits=True 的损失函数一起使用（即，对预测不应用 sigmoid），则 thresholds 应设置为 0。每个阈值都会生成一个指标值。默认为 0.5。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.FalseNegatives()
>>> m.update_state([0, 1, 1, 1], [0, 1, 0, 0])
>>> m.result().numpy()
2.0

>>> m.reset_state()
>>> m.update_state([0, 1, 1, 1], [0, 1, 0, 0], sample_weight=[0, 0, 1, 0])
>>> m.result().numpy()
1.0

与 compile() API 结合使用

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[tf.keras.metrics.FalseNegatives()])

与 from_logits=True 的损失一起使用

model.compile(optimizer='adam',
              loss=tf.keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[tf.keras.metrics.FalseNegatives(thresholds=0)])

[源代码]

`PrecisionAtRecall` 类

tf_keras.metrics.PrecisionAtRecall(
    recall, num_thresholds=200, class_id=None, name=None, dtype=None
)

计算召回率 >= 指定值的最佳精确率。

此指标创建四个局部变量，true_positives、true_negatives、false_positives 和 false_negatives，用于计算给定召回率下的精确率。计算给定召回率值的阈值并用于评估相应的精确率。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

如果指定了 class_id，我们将通过仅考虑批次中 class_id 高于阈值预测的条目来计算精确率，并计算其中 class_id 确实是正确标签的条目的分数。

参数

recall：范围在 [0, 1] 内的标量值。
num_thresholds：（可选）用于匹配给定召回率的阈值数量。默认为 200。
class_id：（可选）我们想要二元指标的整数类 ID。这必须在半开区间 [0, num_classes) 内，其中 num_classes 是预测的最后一个维度。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.PrecisionAtRecall(0.5)
>>> m.update_state([0, 0, 0, 1, 1], [0, 0.3, 0.8, 0.3, 0.8])
>>> m.result().numpy()
0.5

>>> m.reset_state()
>>> m.update_state([0, 0, 0, 1, 1], [0, 0.3, 0.8, 0.3, 0.8],
...                sample_weight=[2, 2, 2, 1, 1])
>>> m.result().numpy()
0.33333333

与 compile() API 结合使用

model.compile(
    optimizer='sgd',
    loss='binary_crossentropy',
    metrics=[tf.keras.metrics.PrecisionAtRecall(recall=0.8)])

[源代码]

`SensitivityAtSpecificity` 类

tf_keras.metrics.SensitivityAtSpecificity(
    specificity, num_thresholds=200, class_id=None, name=None, dtype=None
)

计算在特异度大于等于指定值时的最佳灵敏度。

给定特异度下的灵敏度。

灵敏度衡量正确识别为阳性的实际阳性比例 (tp / (tp + fn))。特异度衡量正确识别为阴性的实际阴性比例 (tn / (tn + fp))。

此指标创建四个局部变量，真正例、真负例、假阳例和假阴例，用于计算给定特异度下的灵敏度。计算给定特异度值的阈值，并用于评估相应的灵敏度。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

如果指定了 class_id，我们将通过仅考虑批次中 class_id 高于阈值预测的条目来计算精确率，并计算其中 class_id 确实是正确标签的条目的分数。

有关特异度和灵敏度的更多信息，请参阅此处。

参数

特异度：范围在[0, 1]内的标量值。
num_thresholds：（可选）用于匹配给定特异度的阈值数量。默认为200。
class_id：（可选）我们想要二元指标的整数类 ID。这必须在半开区间 [0, num_classes) 内，其中 num_classes 是预测的最后一个维度。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.SensitivityAtSpecificity(0.5)
>>> m.update_state([0, 0, 0, 1, 1], [0, 0.3, 0.8, 0.3, 0.8])
>>> m.result().numpy()
0.5

>>> m.reset_state()
>>> m.update_state([0, 0, 0, 1, 1], [0, 0.3, 0.8, 0.3, 0.8],
...                sample_weight=[1, 1, 2, 2, 1])
>>> m.result().numpy()
0.333333

与 compile() API 结合使用

model.compile(
    optimizer='sgd',
    loss='binary_crossentropy',
    metrics=[tf.keras.metrics.SensitivityAtSpecificity()])

[源代码]

`SpecificityAtSensitivity` 类

tf_keras.metrics.SpecificityAtSensitivity(
    sensitivity, num_thresholds=200, class_id=None, name=None, dtype=None
)

计算在灵敏度大于等于指定值时的最佳特异度。

灵敏度衡量正确识别为阳性的实际阳性比例 (tp / (tp + fn))。特异度衡量正确识别为阴性的实际阴性比例 (tn / (tn + fp))。

此指标创建四个局部变量，真正例、真负例、假阳例和假阴例，用于计算给定灵敏度下的特异度。计算给定灵敏度值的阈值，并用于评估相应的特异度。

如果 sample_weight 为 None，则权重默认为 1。使用 sample_weight 为 0 来掩盖值。

如果指定了 class_id，我们将通过仅考虑批次中 class_id 高于阈值预测的条目来计算精确率，并计算其中 class_id 确实是正确标签的条目的分数。

有关特异度和灵敏度的更多信息，请参阅此处。

参数

灵敏度：范围在[0, 1]内的标量值。
num_thresholds：（可选）用于匹配给定灵敏度的阈值数量。默认为200。
class_id：（可选）我们想要二元指标的整数类 ID。这必须在半开区间 [0, num_classes) 内，其中 num_classes 是预测的最后一个维度。
name：（可选）指标实例的字符串名称。
dtype：（可选）指标结果的数据类型。

独立使用

>>> m = tf.keras.metrics.SpecificityAtSensitivity(0.5)
>>> m.update_state([0, 0, 0, 1, 1], [0, 0.3, 0.8, 0.3, 0.8])
>>> m.result().numpy()
0.66666667

>>> m.reset_state()
>>> m.update_state([0, 0, 0, 1, 1], [0, 0.3, 0.8, 0.3, 0.8],
...                sample_weight=[1, 1, 2, 2, 2])
>>> m.result().numpy()
0.5

与 compile() API 结合使用

model.compile(
    optimizer='sgd',
    loss='binary_crossentropy',
    metrics=[tf.keras.metrics.SpecificityAtSensitivity()])

基于真正/假正例和假反例的分类指标

AUC 类

Precision 类

Recall 类

TruePositives 类

TrueNegatives 类

FalsePositives 类

FalseNegatives 类

PrecisionAtRecall 类

SensitivityAtSpecificity 类

SpecificityAtSensitivity 类

基于真正/假正例和假反例的分类指标

AUC 类

Precision 类

Recall 类

TruePositives 类

TrueNegatives 类

FalsePositives 类

FalseNegatives 类

PrecisionAtRecall 类

SensitivityAtSpecificity 类

SpecificityAtSensitivity 类

`AUC` 类

`Precision` 类

`Recall` 类

`TruePositives` 类

`TrueNegatives` 类

`FalsePositives` 类

`FalseNegatives` 类

`PrecisionAtRecall` 类

`SensitivityAtSpecificity` 类

`SpecificityAtSensitivity` 类