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


Computes the (weighted) sum of the given values.

Inherits From: Metric, Layer, Module

For example, if values is [1, 3, 5, 7] then the sum is 16. If the weights were specified as [1, 1, 0, 0] then the sum would be 4.

This metric creates one variable, total, that is used to compute the sum of values. This is ultimately returned as sum.

If sample_weight is None, weights default to 1. Use sample_weight of 0 to mask values.

name (Optional) string name of the metric instance.
dtype (Optional) data type of the metric result.

Standalone usage:

m = tf.keras.metrics.Sum()
m.update_state([1, 3, 5, 7])

Usage with compile() API:

model.compile(optimizer='sgd', loss='mse')



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 statistics for computing the metric.

values Per-example value.
sample_weight Optional weighting of each example. Defaults to 1.

Update op.