# tf.keras.metrics.R2Score

<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#L418-L608) |

Computes R2 score.

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

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

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

<br />

    tf.keras.metrics.R2Score(
        class_aggregation='uniform_average',
        num_regressors=0,
        name='r2_score',
        dtype=None
    )

This is also called the
[coefficient of
determination](https://en.wikipedia.org/wiki/Coefficient_of_determination).

It indicates how close the fitted regression line
is to ground-truth data.

- The highest score possible is 1.0. It indicates that the predictors perfectly accounts for variation in the target.
- A score of 0.0 indicates that the predictors do not account for variation in the target.
- It can also be negative if the model is worse than random.

This metric can also compute the "Adjusted R2" score.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `class_aggregation` | Specifies how to aggregate scores corresponding to different output classes (or target dimensions), i.e. different dimensions on the last axis of the predictions. Equivalent to `multioutput` argument in Scikit-Learn. Should be one of `None` (no aggregation), `"uniform_average"`, `"variance_weighted_average"`. |
| `num_regressors` | Number of independent regressors used ("Adjusted R2" score). Defaults to 0 (standard R2 score). |
| `name` | Optional. string name of the metric instance. |
| `dtype` | Optional. data type of the metric result. |

<br />

#### Example:

    y_true = np.array([[1], [4], [3]], dtype=np.float32)
    y_pred = np.array([[2], [4], [4]], dtype=np.float32)
    metric = tf.keras.metrics.R2Score()
    metric.update_state(y_true, y_pred)
    result = metric.result()
    result.numpy()
    0.57142854

## 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/regression_metrics.py#L598-L600)

    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/regression_metrics.py#L560-L596)

    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#L532-L558)

    update_state(
        y_true, y_pred, sample_weight=None
    )

Accumulates statistics for the metric.

> [!NOTE]
> **Note:** This function is executed as a graph function in graph mode. This means: a) Operations on the same resource are executed in textual order. This should make it easier to do things like add the updated value of a variable to another, for example. b) You don't need to worry about collecting the update ops to execute. All update ops added to the graph by this function will be executed. As a result, code should generally work the same way with graph or eager execution.

<br />

<br />

<br />

| Args ||
|---|---|
| `*args` | <br /> <br /> |
| `**kwargs` | A mini-batch of inputs to the Metric. |

<br />