# tf.keras.metrics.MeanTensor

<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#L3129-L3252) |

Computes the element-wise (weighted) mean of the given tensors.

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.MeanTensor`](https://www.tensorflow.org/api_docs/python/tf/keras/metrics/MeanTensor)
**Compat aliases for migration**

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

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

<br />

    tf.keras.metrics.MeanTensor(
        name='mean_tensor', dtype=None, shape=None
    )

`MeanTensor` returns a tensor with the same shape of the input tensors. The
mean value is updated by keeping local variables `total` and `count`. The
`total` tracks the sum of the weighted values, and `count` stores the sum of
the weighted counts.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `name` | (Optional) string name of the metric instance. |
| `dtype` | (Optional) data type of the metric result. |
| `shape` | (Optional) A list of integers, a tuple of integers, or a 1-D Tensor of type int32. If not specified, the shape is inferred from the values at the first call of update_state. |

<br />

#### Standalone usage:

    m = tf.keras.metrics.MeanTensor()
    m.update_state([0, 1, 2, 3])
    m.update_state([4, 5, 6, 7])
    m.result().numpy()
    array([2., 3., 4., 5.], dtype=float32)

    m.update_state([12, 10, 8, 6], sample_weight= [0, 0.2, 0.5, 1])
    m.result().numpy()
    array([2.       , 3.6363635, 4.8      , 5.3333335], dtype=float32)

    m = tf.keras.metrics.MeanTensor(dtype=tf.float64, shape=(1, 4))
    m.result().numpy()
    array([[0., 0., 0., 0.]])
    m.update_state([[0, 1, 2, 3]])
    m.update_state([[4, 5, 6, 7]])
    m.result().numpy()
    array([[2., 3., 4., 5.]])

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `count` | <br /> <br /> |
| `total` | <br /> <br /> |

<br />

## 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#L3248-L3252)

    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#L3240-L3246)

    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#L3196-L3238)

    update_state(
        values, sample_weight=None
    )

Accumulates statistics for computing the element-wise mean.

<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 />