<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#L601-L724) |

Computes the cross-entropy loss between true labels and predicted labels.

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

    tf.keras.losses.BinaryCrossentropy(
        from_logits=False,
        label_smoothing=0.0,
        axis=-1,
        reduction='sum_over_batch_size',
        name='binary_crossentropy',
        dtype=None
    )

### Used in the notebooks

| Used in the guide | Used in the tutorials |
|---|---|
| - [Distributed training with TensorFlow](https://www.tensorflow.org/guide/distributed_training) - [Estimators](https://www.tensorflow.org/guide/estimator) - [Migrate \`tf.feature_column\`s to Keras preprocessing layers](https://www.tensorflow.org/guide/migrate/migrating_feature_columns) - [Using Counterfactual Logit Pairing with Keras](https://www.tensorflow.org/responsible_ai/model_remediation/counterfactual/guide/counterfactual_keras) | - [Load a pandas DataFrame](https://www.tensorflow.org/tutorials/load_data/pandas_dataframe) - [Transfer learning and fine-tuning](https://www.tensorflow.org/tutorials/images/transfer_learning) - [Basic text classification](https://www.tensorflow.org/tutorials/keras/text_classification) - [Parameter server training with ParameterServerStrategy](https://www.tensorflow.org/tutorials/distribute/parameter_server_training) - [CycleGAN](https://www.tensorflow.org/tutorials/generative/cyclegan) |

Use this cross-entropy loss for binary (0 or 1) classification applications.
The loss function requires the following inputs:

- `y_true` (true label): This is either 0 or 1.
- `y_pred` (predicted value): This is the model's prediction, i.e, a single floating-point value which either represents a [logit](https://en.wikipedia.org/wiki/Logit), (i.e, value in \[-inf, inf\] when `from_logits=True`) or a probability (i.e, value in \[0., 1.\] when `from_logits=False`).

<br />

<br />

<br />

| ## Args ||
|---|---|
| `from_logits` | Whether to interpret `y_pred` as a tensor of [logit](https://en.wikipedia.org/wiki/Logit) values. By default, we assume that `y_pred` is probabilities (i.e., values in \[0, 1\]). |
| `label_smoothing` | Float in range \[0, 1\]. When 0, no smoothing occurs. When \> 0, we compute the loss between the predicted labels and a smoothed version of the true labels, where the smoothing squeezes the labels towards 0.5. Larger values of `label_smoothing` correspond to heavier smoothing. |
| `axis` | The axis along which to compute crossentropy (the features axis). Defaults to `-1`. |
| `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. |
| `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 />

#### Examples:

**Recommended Usage:** (set `from_logits=True`)

With `compile()` API:

    model.compile(
        loss=keras.losses.BinaryCrossentropy(from_logits=True),
        ...
    )

As a standalone function:

    # Example 1: (batch_size = 1, number of samples = 4)
    y_true = np.array([0, 1, 0, 0])
    y_pred = np.array([-18.6, 0.51, 2.94, -12.8])
    bce = keras.losses.BinaryCrossentropy(from_logits=True)
    bce(y_true, y_pred)
    0.8654

    # Example 2: (batch_size = 2, number of samples = 4)
    y_true = np.array([[0, 1], [0, 0]])
    y_pred = np.array([[-18.6, 0.51], [2.94, -12.8]])
    # Using default 'auto'/'sum_over_batch_size' reduction type.
    bce = keras.losses.BinaryCrossentropy(from_logits=True)
    bce(y_true, y_pred)
    0.8654
    # Using 'sample_weight' attribute
    bce(y_true, y_pred, sample_weight=[0.8, 0.2])
    0.243
    # Using 'sum' reduction` type.
    bce = keras.losses.BinaryCrossentropy(from_logits=True,
        reduction="sum")
    bce(y_true, y_pred)
    1.730
    # Using 'none' reduction type.
    bce = keras.losses.BinaryCrossentropy(from_logits=True,
        reduction=None)
    bce(y_true, y_pred)
    array([0.235, 1.496], dtype=float32)

**Default Usage:** (set `from_logits=False`)

    # Make the following updates to the above "Recommended Usage" section
    # 1. Set `from_logits=False`
    keras.losses.BinaryCrossentropy() # OR ...('from_logits=False')
    # 2. Update `y_pred` to use probabilities instead of logits
    y_pred = [0.6, 0.3, 0.2, 0.8] # OR [[0.6, 0.3], [0.2, 0.8]]

<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#L715-L724)

    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.