Join us at TensorFlow World, Oct 28-31. Use code TF20 for 20% off select passes. Register now

tf.keras.metrics.TopKCategoricalAccuracy

TensorFlow 2.0 version View source on GitHub

Class TopKCategoricalAccuracy

Computes how often targets are in the top K predictions.

Aliases:

  • Class tf.compat.v1.keras.metrics.TopKCategoricalAccuracy
  • Class tf.compat.v2.keras.metrics.TopKCategoricalAccuracy
  • Class tf.compat.v2.metrics.TopKCategoricalAccuracy

Usage:

m = tf.keras.metrics.TopKCategoricalAccuracy()
m.update_state([[0, 0, 1], [0, 1, 0]], [[0.1, 0.9, 0.8], [0.05, 0.95, 0]])
print('Final result: ', m.result().numpy())  # Final result: 1.0

Usage with tf.keras API:

model = tf.keras.Model(inputs, outputs)
model.compile('sgd', metrics=[tf.keras.metrics.TopKCategoricalAccuracy()])

__init__

View source

__init__(
    k=5,
    name='top_k_categorical_accuracy',
    dtype=None
)

Creates a TopKCategoricalAccuracy instance.

Args:

  • k: (Optional) Number of top elements to look at for computing accuracy. Defaults to 5.
  • name: (Optional) string name of the metric instance.
  • dtype: (Optional) data type of the metric result.

Methods

reset_states

View source

reset_states()

Resets all of the metric state variables.

This function is called between epochs/steps, when a metric is evaluated during training.

result

View source

result()

update_state

View source

update_state(
    y_true,
    y_pred,
    sample_weight=None
)

Accumulates metric statistics.

y_true and y_pred should have the same shape.

Args:

  • y_true: The ground truth values.
  • y_pred: The predicted values.
  • sample_weight: Optional weighting of each example. Defaults to 1. Can be a Tensor whose rank is either 0, or the same rank as y_true, and must be broadcastable to y_true.

Returns:

Update op.