credit.losses.xsigmoid
======================

.. py:module:: credit.losses.xsigmoid


Classes
-------

.. autoapisummary::

   credit.losses.xsigmoid.XSigmoidLoss


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

.. py:class:: XSigmoidLoss(reduction='mean')

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


   X-Sigmoid Loss Function.

   This loss function computes a modified loss by using a sigmoid function
   transformation. It is designed to handle large errors in a non-linear fashion.

   :param reduction: Specifies the reduction to apply to the output.
                     'mean' | 'none'. 'mean': the output is averaged; 'none': no reduction is applied.
   :type reduction: str


   .. py:attribute:: reduction
      :value: 'mean'



   .. py:method:: forward(y_t, y_prime_t)

      Forward pass for X-Sigmoid loss.

      :param y_t: Target tensor.
      :type y_t: torch.Tensor
      :param y_prime_t: Predicted tensor.
      :type y_prime_t: torch.Tensor

      :returns: X-Sigmoid loss value.
      :rtype: torch.Tensor