# tf.keras.metrics.MeanRelativeError

<br />

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

Computes the mean relative error by normalizing with the given values.

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

#### View aliases


**Main aliases**

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

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

\`tf.compat.v1.keras.metrics.MeanRelativeError\`

<br />

    tf.keras.metrics.MeanRelativeError(
        normalizer, name=None, dtype=None
    )

This metric creates two local variables, `total` and `count` that are used
to compute the mean relative error. This is weighted by `sample_weight`, and
it is ultimately returned as `mean_relative_error`: an idempotent operation
that simply divides `total` by `count`.

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

<br />

<br />

<br />

| ## Args ||
|---|---|
| `normalizer` | The normalizer values with same shape as predictions. |
| `name` | (Optional) string name of the metric instance. |
| `dtype` | (Optional) data type of the metric result. |

<br />

#### Standalone usage:

    m = tf.keras.metrics.MeanRelativeError(normalizer=[1, 3, 2, 3])
    m.update_state([1, 3, 2, 3], [2, 4, 6, 8])

    # metric = mean(|y_pred - y_true| / normalizer)
    #        = mean([1, 1, 4, 5] / [1, 3, 2, 3]) = mean([1, 1/3, 2, 5/3])
    #        = 5/4 = 1.25
    m.result().numpy()
    1.25

Usage with `compile()` API:

    model.compile(
      optimizer='sgd',
      loss='mse',
      metrics=[tf.keras.metrics.MeanRelativeError(normalizer=[1, 3])])

## Methods

### `merge_state`

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

    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.13.1/keras/metrics/base_metric.py#L249-L265)

    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.13.1/keras/metrics/base_metric.py#L551-L563)

    result()

Computes and returns the scalar metric value tensor or a dict of scalars.

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

<br />

<br />

<br />

| Returns ||
|---|---|
| A scalar tensor, or a dictionary of scalar tensors. ||

<br />

### `update_state`

[View source](https://github.com/keras-team/keras/tree/v2.13.1/keras/metrics/regression_metrics.py#L81-L116)

    update_state(
        y_true, y_pred, sample_weight=None
    )

Accumulates metric statistics.

<br />

<br />

<br />

| 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`. |

<br />

<br />

<br />

<br />

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

<br />