ML Community Day is November 9! Join us for updates from TensorFlow, JAX, and more Learn more


Wraps a stateless metric function with the Mean metric.

Inherits From: Mean, Metric, Layer, Module

You could use this class to quickly build a mean metric from a function. The function needs to have the signature fn(y_true, y_pred) and return a per-sample loss array. MeanMetricWrapper.result() will return the average metric value across all samples seen so far.

For example:

def accuracy(y_true, y_pred):
  return tf.cast(tf.math.equal(y_true, y_pred), tf.float32)

accuracy_metric = tf.keras.metrics.MeanMetricWrapper(fn=accuracy)

keras_model.compile(..., metrics=accuracy_metric)

fn The metric function to wrap, with signature fn(y_true, y_pred, **kwargs).
name (Optional) string name of the metric instance.
dtype (Optional) data type of the metric result.
**kwargs Keyword arguments to pass on to fn.



View source

Resets all of the metric state variables.

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


View source

Computes and returns the metric value tensor.

Result computation is an idempotent operation that simply calculates the metric value using the state variables.


View source

Accumulates metric statistics.

For sparse categorical metrics, the shapes of y_true and y_pred are different.

y_true Ground truth label values. shape = [batch_size, d0, .. dN-1] or shape = [batch_size, d0, .. dN-1, 1].
y_pred The predicted probability values. shape = [batch_size, d0, .. dN].
sample_weight Optional sample_weight acts as a coefficient for the metric. If a scalar is provided, then the metric is simply scaled by the given value. If sample_weight is a tensor of size [batch_size], then the metric for each sample of the batch is rescaled by the corresponding element in the sample_weight