# tfr.keras.losses.YetiLogisticLoss

|---|
| [![](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#L605-L715) |

Computes Yeti logistic loss between `y_true` and `y_pred`.

    tfr.keras.losses.YetiLogisticLoss(
        reduction: tf.losses.Reduction = tf.losses.Reduction.AUTO,
        name: Optional[str] = None,
        lambda_weight: Optional[https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/losses/YetiDCGLambdaWeight] = None,
        temperature: float = 0.1,
        sample_size: int = 8,
        gumbel_temperature: float = 1.0,
        seed: Optional[int] = None,
        ragged: bool = False
    )

Adapted to neural network models from the Yeti loss implemenation for GBDT in
([Lyzhin et al, 2022](https://arxiv.org/abs/2204.01500)).

In this code base, we support Yeti loss with the DCG lambda weight option.
The default uses the YetiDCGLambdaWeight with default settings. To customize,
please set the lambda_weight to YetiDCGLambdaWeight.

For each list of scores `s` in `y_pred` and list of labels `y` in `y_true`:

    loss = sum_a sum_i I[y_i > y_{i\pm 1}] * log(1 + exp(-(s^a_i - s^a_{i\pm 1})))

where

    s^a_i = s_i + gumbel(0, 1)^a

#### Standalone usage:

    y_true = [[1., 0.]]
    y_pred = [[0.6, 0.8]]
    loss = tfr.keras.losses.YetiLogisticLoss(sample_size=2, seed=1)
    loss(y_true, y_pred).numpy()
    0.90761846

    # 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.YetiLogisticLoss(seed=1, ragged=True)
    loss(y_true, y_pred).numpy()
    0.43420443

Usage with the `compile()` API:

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

#### Definition:

\\\[
\\mathcal{L}(\\{y\\}, \\{s\\}) =
\\sum_a \\sum_i \\sum_{j=i\\pm 1}I\[y_i \> y_j\] \\log(1 + \\exp(-(s\^a_i - s\^a_j)))
\\\]

<br />

<br />

| ## References ||
|---|---|
| <br /> - [Which Tricks are Important for Learning to Rank?, Lyzhin et al, 2022](https://arxiv.org/abs/2204.01500) ||

<br />

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

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

    @classmethod
    from_config(
        config, custom_objects=None
    )

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#L694-L701)

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

    __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 _RankingLoss.