# tfr.keras.losses.SigmoidCrossEntropyLoss

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/python/keras/losses.py#L1385-L1432) |

Computes the Sigmoid cross-entropy loss between `y_true` and `y_pred`.

    tfr.keras.losses.SigmoidCrossEntropyLoss(
        reduction: tf.losses.Reduction = tf.losses.Reduction.AUTO,
        name: Optional[str] = None,
        ragged: bool = False
    )

    loss = -(y_true log(sigmoid(y_pred)) + (1 - y_true) log(1 - sigmoid(y_pred)))

> [!NOTE]
> **Note:** This loss does not support graded relevance labels and should only be used with binary relevance labels (\\(y \\in \[0, 1\]\\)).

#### Standalone usage:

    y_true = [[1., 0.]]
    y_pred = [[0.6, 0.8]]
    loss = tfr.keras.losses.SigmoidCrossEntropyLoss()
    loss(y_true, y_pred).numpy()
    0.8042943

    # Using ragged tensors
    y_true = tf.ragged.constant([[1., 0.], [0., 1., 0.]])
    y_pred = tf.ragged.constant([[0.6, 0.8], [0.5, 0.8, 0.4]])
    loss = tfr.keras.losses.SigmoidCrossEntropyLoss(ragged=True)
    loss(y_true, y_pred).numpy()
    0.64446354

Usage with the `compile()` API:

    model.compile(optimizer='sgd',
        loss=tfr.keras.losses.SigmoidCrossEntropyLoss())

#### Definition:

\\\[
\\mathcal{L}(\\{y\\}, \\{s\\}) = - \\sum_{i} y_i
\\log(\\text{sigmoid}(s_i)) + (1 - y_i) \\log(1 - \\text{sigmoid}(s_i))
\\\]

<br />

<br />

<br />

| ## Args ||
|---|---|
| `reduction` | Type of [`tf.keras.losses.Reduction`](https://www.tensorflow.org/api_docs/python/tf/keras/losses/Reduction) to apply to loss. Default value is `AUTO`. `AUTO` indicates that the reduction option will be determined by the usage context. For almost all cases this defaults to `SUM_OVER_BATCH_SIZE`. When used under a [`tf.distribute.Strategy`](https://www.tensorflow.org/api_docs/python/tf/distribute/Strategy), except via [`Model.compile()`](https://www.tensorflow.org/api_docs/python/tf/keras/Model#compile) and [`Model.fit()`](https://www.tensorflow.org/api_docs/python/tf/keras/Model#fit), using `AUTO` or `SUM_OVER_BATCH_SIZE` will raise an error. Please see this custom training [tutorial](https://www.tensorflow.org/tutorials/distribute/custom_training) for more details. |
| `name` | Optional name for the instance. |

<br />

## Methods

### `from_config`

    @classmethod
    from_config(
        config
    )

Instantiates a `Loss` from its config (output of `get_config()`).

<br />

<br />

<br />

| Args ||
|---|---|
| `config` | Output of `get_config()`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A `Loss` instance. ||

<br />

### `get_config`

[View source](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/python/keras/losses.py#L280-L283)

    get_config() -> Dict[str, Any]

Returns the config dictionary for a `Loss` instance.

### `__call__`

[View source](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/python/keras/losses.py#L262-L270)

    __call__(
        y_true: https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorLike,
        y_pred: https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorLike,
        sample_weight: Optional[utils.TensorLike] = None
    ) -> tf.Tensor

See tf.keras.losses.Loss.