Keras 3 API 文档 / 度量 / 概率度量

概率度量

[来源]

BinaryCrossentropy

keras.metrics.BinaryCrossentropy(
    name="binary_crossentropy", dtype=None, from_logits=False, label_smoothing=0
)

计算标签和预测之间的交叉熵度量。

当只有两个标签类别(0 和 1)时,使用此交叉熵度量类。

参数

  • name: (可选)度量实例的字符串名称。
  • dtype: (可选)度量结果的数据类型。
  • from_logits: (可选)输出是否应为 logits 张量。默认情况下,我们认为输出编码概率分布。
  • label_smoothing: (可选)[0, 1] 中的浮点数。当 > 0 时,标签值会被平滑,这意味着标签值的置信度会得到放松。例如,label_smoothing=0.2 表示我们将对标签“0”使用 0.1 的值,对标签“1”使用 0.9 的值。

示例

示例

>>> m = keras.metrics.BinaryCrossentropy()
>>> m.update_state([[0, 1], [0, 0]], [[0.6, 0.4], [0.4, 0.6]])
>>> m.result()
0.81492424
>>> m.reset_state()
>>> m.update_state([[0, 1], [0, 0]], [[0.6, 0.4], [0.4, 0.6]],
...                sample_weight=[1, 0])
>>> m.result()
0.9162905

compile() API 结合使用

model.compile(
    optimizer='sgd',
    loss='mse',
    metrics=[keras.metrics.BinaryCrossentropy()])

[来源]

CategoricalCrossentropy

keras.metrics.CategoricalCrossentropy(
    name="categorical_crossentropy",
    dtype=None,
    from_logits=False,
    label_smoothing=0,
    axis=-1,
)

计算标签和预测之间的交叉熵度量。

当有多个标签类别(2 个或更多)时,使用此交叉熵度量类。它假设标签是独热编码的,例如,当标签值为 [2, 0, 1] 时,则 y_true[[0, 0, 1], [1, 0, 0], [0, 1, 0]]

参数

  • name: (可选)度量实例的字符串名称。
  • dtype: (可选)度量结果的数据类型。
  • from_logits: (可选)输出是否应为 logits 张量。默认情况下,我们认为输出编码概率分布。
  • label_smoothing: (可选)[0, 1] 中的浮点数。当 > 0 时,标签值会被平滑,这意味着标签值的置信度会得到放松。例如,label_smoothing=0.2 表示我们将对标签“0”使用 0.1 的值,对标签“1”使用 0.9 的值。
  • axis: (可选)默认为 -1。计算熵的维度。

示例

示例

>>> # EPSILON = 1e-7, y = y_true, y` = y_pred
>>> # y` = clip_ops.clip_by_value(output, EPSILON, 1. - EPSILON)
>>> # y` = [[0.05, 0.95, EPSILON], [0.1, 0.8, 0.1]]
>>> # xent = -sum(y * log(y'), axis = -1)
>>> #      = -((log 0.95), (log 0.1))
>>> #      = [0.051, 2.302]
>>> # Reduced xent = (0.051 + 2.302) / 2
>>> m = keras.metrics.CategoricalCrossentropy()
>>> m.update_state([[0, 1, 0], [0, 0, 1]],
...                [[0.05, 0.95, 0], [0.1, 0.8, 0.1]])
>>> m.result()
1.1769392
>>> m.reset_state()
>>> m.update_state([[0, 1, 0], [0, 0, 1]],
...                [[0.05, 0.95, 0], [0.1, 0.8, 0.1]],
...                sample_weight=np.array([0.3, 0.7]))
>>> m.result()
1.6271976

compile() API 结合使用

model.compile(
    optimizer='sgd',
    loss='mse',
    metrics=[keras.metrics.CategoricalCrossentropy()])

[来源]

SparseCategoricalCrossentropy

keras.metrics.SparseCategoricalCrossentropy(
    name="sparse_categorical_crossentropy", dtype=None, from_logits=False, axis=-1
)

计算标签和预测之间的交叉熵度量。

当有两个或更多标签类别时,使用此交叉熵度量。它期望标签以整数形式提供。如果您想提供独热编码的标签,请改用 CategoricalCrossentropy 度量。

对于 y_pred,每个特征应该有 num_classes 个浮点数,而对于 y_true,每个特征应该只有一个浮点数。

参数

  • name: (可选)度量实例的字符串名称。
  • dtype: (可选)度量结果的数据类型。
  • from_logits: (可选)输出是否应为 logits 张量。默认情况下,我们认为输出编码概率分布。
  • axis: (可选)默认为 -1。计算熵的维度。

示例

示例

>>> # y_true = one_hot(y_true) = [[0, 1, 0], [0, 0, 1]]
>>> # logits = log(y_pred)
>>> # softmax = exp(logits) / sum(exp(logits), axis=-1)
>>> # softmax = [[0.05, 0.95, EPSILON], [0.1, 0.8, 0.1]]
>>> # xent = -sum(y * log(softmax), 1)
>>> # log(softmax) = [[-2.9957, -0.0513, -16.1181],
>>> #                [-2.3026, -0.2231, -2.3026]]
>>> # y_true * log(softmax) = [[0, -0.0513, 0], [0, 0, -2.3026]]
>>> # xent = [0.0513, 2.3026]
>>> # Reduced xent = (0.0513 + 2.3026) / 2
>>> m = keras.metrics.SparseCategoricalCrossentropy()
>>> m.update_state([1, 2],
...                [[0.05, 0.95, 0], [0.1, 0.8, 0.1]])
>>> m.result()
1.1769392
>>> m.reset_state()
>>> m.update_state([1, 2],
...                [[0.05, 0.95, 0], [0.1, 0.8, 0.1]],
...                sample_weight=np.array([0.3, 0.7]))
>>> m.result()
1.6271976

compile() API 结合使用

model.compile(
    optimizer='sgd',
    loss='mse',
    metrics=[keras.metrics.SparseCategoricalCrossentropy()])

[来源]

KLDivergence

keras.metrics.KLDivergence(name="kl_divergence", dtype=None)

计算 y_truey_pred 之间的 Kullback-Leibler 散度度量。

公式

metric = y_true * log(y_true / y_pred)

预期 y_truey_pred 为概率分布,其值介于 0 和 1 之间。它们将被剪裁到 [0, 1] 范围内。

参数

  • name: (可选)度量实例的字符串名称。
  • dtype: (可选)度量结果的数据类型。

示例

>>> m = keras.metrics.KLDivergence()
>>> m.update_state([[0, 1], [0, 0]], [[0.6, 0.4], [0.4, 0.6]])
>>> m.result()
0.45814306
>>> m.reset_state()
>>> m.update_state([[0, 1], [0, 0]], [[0.6, 0.4], [0.4, 0.6]],
...                sample_weight=[1, 0])
>>> m.result()
0.9162892

compile() API 结合使用

model.compile(optimizer='sgd',
              loss='mse',
              metrics=[keras.metrics.KLDivergence()])

[来源]

Poisson

keras.metrics.Poisson(name="poisson", dtype=None)

计算 y_truey_pred 之间的泊松度量。

公式

metric = y_pred - y_true * log(y_pred)

参数

  • name: (可选)度量实例的字符串名称。
  • dtype: (可选)度量结果的数据类型。

示例

示例

>>> m = keras.metrics.Poisson()
>>> m.update_state([[0, 1], [0, 0]], [[1, 1], [0, 0]])
>>> m.result()
0.49999997
>>> m.reset_state()
>>> m.update_state([[0, 1], [0, 0]], [[1, 1], [0, 0]],
...                sample_weight=[1, 0])
>>> m.result()
0.99999994

compile() API 结合使用

model.compile(optimizer='sgd',
              loss='mse',
              metrics=[keras.metrics.Poisson()])