logitorch.losses.unlikelihood_loss
==================================

.. py:module:: logitorch.losses.unlikelihood_loss


Classes
-------

.. autoapisummary::

   logitorch.losses.unlikelihood_loss.CrossEntropyAndUnlikelihoodLoss
   logitorch.losses.unlikelihood_loss.UnlikelihoodLoss


Module Contents
---------------

.. py:class:: CrossEntropyAndUnlikelihoodLoss(ignore_index=-100, epsilon=1e-10)

   Bases: :py:obj:`torch.nn.Module`


   Calculates the cross-entropy and unlikelihood loss for a given prediction and target values.

   Args:
       ignore_index (int, optional): Index to ignore in the loss calculation. Defaults to -100.
       epsilon (float, optional): Small value added to the denominator to avoid division by zero. Defaults to 1e-10.


   .. py:method:: forward(pred_values, target_values, known_labels, unknown_labels)

      Forward pass of the cross-entropy and unlikelihood loss calculation.

      Args:
          pred_values (torch.Tensor): Predicted values.
          target_values (torch.Tensor): Target values.
          known_labels (torch.Tensor): Known labels.
          unknown_labels (torch.Tensor): Unknown labels.

      Returns:
          torch.Tensor: Calculated loss.



   .. py:attribute:: epsilon
      :value: 1e-10



   .. py:attribute:: ignore_index
      :value: -100



.. py:class:: UnlikelihoodLoss(ignore_index=-100, epsilon=1e-10)

   Bases: :py:obj:`torch.nn.Module`


   Calculates the unlikelihood loss for a given prediction and target values.

   Args:
       ignore_index (int, optional): Index to ignore in the loss calculation. Defaults to -100.
       epsilon (float, optional): Small value added to the denominator to avoid division by zero. Defaults to 1e-10.


   .. py:method:: forward(pred_values, target_values)

      Forward pass of the unlikelihood loss calculation.

      Args:
          pred_values (torch.Tensor): Predicted values.
          target_values (torch.Tensor): Target values.

      Returns:
          torch.Tensor: Calculated loss.



   .. py:attribute:: epsilon
      :value: 1e-10



   .. py:attribute:: ignore_index
      :value: -100