<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/losses/losses.py#L1302-L1373) |

Computes the Dice loss value between `y_true` and `y_pred`.

Inherits From: [`Loss`](https://www.tensorflow.org/api_docs/python/tf/keras/Loss)

    tf.keras.losses.Dice(
        reduction='sum_over_batch_size',
        name='dice',
        axis=None,
        dtype=None
    )

#### Formula:

    loss = 1 - (2 * sum(y_true * y_pred)) / (sum(y_true) + sum(y_pred))

<br />

<br />

<br />

| ## Args ||
|---|---|
| `reduction` | Type of reduction to apply to the loss. In almost all cases this should be `"sum_over_batch_size"`. Supported options are `"sum"`, `"sum_over_batch_size"`, `"mean"`, `"mean_with_sample_weight"` or `None`. `"sum"` sums the loss, `"sum_over_batch_size"` and `"mean"` sum the loss and divide by the sample size, and `"mean_with_sample_weight"` sums the loss and divides by the sum of the sample weights. `"none"` and `None` perform no aggregation. Defaults to `"sum_over_batch_size"`. |
| `name` | Optional name for the loss instance. |
| `axis` | Tuple for which dimensions the loss is calculated. Defaults to `None`. |
| `dtype` | The dtype of the loss's computations. Defaults to `None`, which means using [`keras.backend.floatx()`](https://www.tensorflow.org/api_docs/python/tf/keras/backend/floatx). [`keras.backend.floatx()`](https://www.tensorflow.org/api_docs/python/tf/keras/backend/floatx) is a `"float32"` unless set to different value (via [`keras.backend.set_floatx()`](https://www.tensorflow.org/api_docs/python/tf/keras/backend/set_floatx)). If a [`keras.DTypePolicy`](https://www.tensorflow.org/api_docs/python/tf/keras/DTypePolicy) is provided, then the `compute_dtype` will be utilized. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| Dice loss value. ||

<br />

#### Example:

    y_true = [[[[1.0], [1.0]], [[0.0], [0.0]]],
              [[[1.0], [1.0]], [[0.0], [0.0]]]]
    y_pred = [[[[0.0], [1.0]], [[0.0], [1.0]]],
              [[[0.4], [0.0]], [[0.0], [0.9]]]]
    axis = (1, 2, 3)
    loss = keras.losses.Dice(axis=axis, reduction=None)(y_true, y_pred)
    assert loss.shape == (2,)
    loss
    array([0.5, 0.75757575], shape=(2,), dtype=float32)

    loss = keras.losses.Dice()(y_true, y_pred)
    assert loss.shape == ()
    loss
    array(0.6164384, shape=(), dtype=float32)

    y_true = np.array(y_true)
    y_pred = np.array(y_pred)
    loss = keras.losses.Dice(axis=axis, reduction=None)(y_true, y_pred)
    assert loss.shape == (2,)
    loss
    array([0.5, 0.75757575], shape=(2,), dtype=float32)

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `dtype` | <br /> <br /> |

<br />

## Methods

### `call`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/losses/losses.py#L28-L34)

    call(
        y_true, y_pred
    )

### `from_config`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/losses/losses.py#L42-L46)

    @classmethod
    from_config(
        config
    )

### `get_config`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/losses/losses.py#L1370-L1373)

    get_config()

### `__call__`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/losses/loss.py#L56-L85)

    __call__(
        y_true, y_pred, sample_weight=None
    )

Call self as a function.