# tf.keras.metrics.Sum

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/keras-team/keras/tree/v2.7.0/keras/metrics.py#L503-L537) |

Computes the (weighted) sum of the given values.

Inherits From: [`Metric`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/keras/metrics/Metric), [`Layer`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/keras/layers/Layer), [`Module`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/Module)

#### View aliases


**Main aliases**

[`tf.metrics.Sum`](https://www.tensorflow.org/api_docs/python/tf/keras/metrics/Sum)
**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.keras.metrics.Sum`](https://www.tensorflow.org/api_docs/python/tf/keras/metrics/Sum)

<br />

    tf.keras.metrics.Sum(
        name='sum', dtype=None
    )

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.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `name` | (Optional) string name of the metric instance. |
| `dtype` | (Optional) data type of the metric result. |

<br />

#### Standalone usage:

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

Usage with `compile()` API:

    model.add_metric(tf.keras.metrics.Sum(name='sum_1')(outputs))
    model.compile(optimizer='sgd', loss='mse')

## Methods

### `merge_state`

[View source](https://github.com/keras-team/keras/tree/v2.7.0/keras/metrics.py#L288-L322)

    merge_state(
        metrics
    )

Merges the state from one or more metrics.

This method can be used by distributed systems to merge the state computed
by different metric instances. Typically the state will be stored in the
form of the metric's weights. For example, a tf.keras.metrics.Mean metric
contains a list of two weight values: a total and a count. If there were two
instances of a tf.keras.metrics.Accuracy that each independently aggregated
partial state for an overall accuracy calculation, these two metric's states
could be combined as follows:

    m1 = tf.keras.metrics.Accuracy()
    _ = m1.update_state([[1], [2]], [[0], [2]])

    m2 = tf.keras.metrics.Accuracy()
    _ = m2.update_state([[3], [4]], [[3], [4]])

    m2.merge_state([m1])
    m2.result().numpy()
    0.75

<br />

<br />

<br />

| Args ||
|---|---|
| `metrics` | an iterable of metrics. The metrics must have compatible state. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If the provided iterable does not contain metrics matching the metric's required specifications. |

<br />

### `reset_state`

[View source](https://github.com/keras-team/keras/tree/v2.7.0/keras/metrics.py#L251-L266)

    reset_state()

Resets all of the metric state variables.

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

### `result`

[View source](https://github.com/keras-team/keras/tree/v2.7.0/keras/metrics.py#L489-L500)

    result()

Computes and returns the metric value tensor.

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

### `update_state`

[View source](https://github.com/keras-team/keras/tree/v2.7.0/keras/metrics.py#L422-L487)

    update_state(
        values, sample_weight=None
    )

Accumulates statistics for computing the metric.

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| Update op. ||

<br />