libauc.losses
=====================


libauc.losses.auc
------------------------

An overview of the :obj:`~libauc.losses.auc` module can be found below:

.. list-table::

   * - :obj:`~libauc.losses.auc.AUCMLoss`
     - AUC-Margin loss with squared-hinge surrogate loss for optimizing AUROC
   * - :obj:`~libauc.losses.auc.CompositionalAUCLoss`
     - Compositional AUC loss with squared-hinge surrogate loss for optimizing AUROC
   * - :obj:`~libauc.losses.auc.AveragePrecisionLoss`
     - Average Precision loss with squared-hinge surrogate loss for optimizing AUPRC
   * - :obj:`~libauc.losses.auc.pAUCLoss`
     - A wrapper for Partial AUC losses to optimize One-way and Two-way Partial AUROC
   * - :obj:`~libauc.losses.auc.pAUC_CVaR_Loss`
     - Partial AUC loss based on DRO-CVaR to optimize One-way Partial AUROC
   * - :obj:`~libauc.losses.auc.pAUC_DRO_Loss`
     - Partial AUC loss based on KL-DRO to One-way Partial AUROC
   * - :obj:`~libauc.losses.auc.tpAUC_KL_Loss`
     - Partial AUC loss based on DRO-KL to optimize two-way partial AUROC
   * - :obj:`~libauc.losses.auc.PairwiseAUCLoss`
     - Pairwise AUC loss to optimize AUROC based on different surrogate losses
   * - :obj:`~libauc.losses.auc.MultiLabelAUCMLoss`
     - AUC-Margin loss with squared-hinge surrogate loss to optimize multi-label AUROC 
   * - :obj:`~libauc.losses.auc.meanAveragePrecisionLoss`
     - Mean Average Precision loss based on squared-hinge surrogate loss to optimize mAP   
   * - :obj:`~libauc.losses.auc.MultiLabelpAUCLoss`
     - Partial AUC loss with squared-hinge surrogate loss to optimize multi-label Paritial AUROC.          

.. automodule:: libauc.losses.auc
  
.. autoclass:: libauc.losses.auc.AUCMLoss
   :members:
   :exclude-members: training

.. autoclass:: libauc.losses.auc.CompositionalAUCLoss
   :members:
   :undoc-members:
   :exclude-members: training

.. autoclass:: libauc.losses.auc.AveragePrecisionLoss
   :members:
   :undoc-members:
   :exclude-members: training

.. autoclass:: libauc.losses.auc.pAUCLoss
   :members:
   :undoc-members:
   :exclude-members: training, get_loss

.. autoclass:: libauc.losses.auc.pAUC_CVaR_Loss
   :members:
   :undoc-members:
   :exclude-members: training

.. autoclass:: libauc.losses.auc.pAUC_DRO_Loss
   :members:
   :undoc-members:

.. autoclass:: libauc.losses.auc.tpAUC_KL_Loss
   :members:
   :undoc-members:

.. autoclass:: libauc.losses.auc.PairwiseAUCLoss
   :members:
   :undoc-members:

.. autoclass:: libauc.losses.auc.meanAveragePrecisionLoss
   :members:
   :undoc-members:

.. autoclass:: libauc.losses.auc.MultiLabelAUCMLoss
   :members:
   :undoc-members:
   :exclude-members: get_a, get_b, get_alpha

.. autoclass:: libauc.losses.auc.MultiLabelpAUCLoss
   :members:
   :undoc-members:
   :exclude-members: get_loss


libauc.losses.ranking
----------------------------

An overview of the :obj:`~libauc.losses.ranking` module can be found below:

.. automodule:: libauc.losses.ranking
   :members:
   :undoc-members:
   :autosummary:
   :autosummary-no-nesting:
   

libauc.losses.contrastive
---------------------------------

An overview of the :obj:`~libauc.losses.contrastive` module can be found below:

.. automodule:: libauc.losses.contrastive
   :members:
   :undoc-members:
   :autosummary:
   :autosummary-no-nesting:
   :exclude-members: all_gather_layer,concat_all_gather,gather_features,get_loss,CrossEntropyLoss


libauc.losses.mil
---------------------------------

An overview of the :obj:`~libauc.losses.mil` module can be found below:

.. automodule:: libauc.losses.mil
   :members:
   :undoc-members:
   :autosummary:
   :autosummary-no-nesting:
   :exclude-members: get_surrogate_loss,get_loss


libauc.losses.losses
---------------------------

An overview of the :obj:`~libauc.losses.losses` module can be found below:

.. automodule:: libauc.losses.losses
   :members:
   :undoc-members:
   :autosummary:
   :autosummary-no-nesting:


libauc.losses.surrogate
------------------------------
 
An overview of the :obj:`~libauc.losses.surrogate` module can be found below:

.. automodule:: libauc.losses.surrogate
   :members:
   :undoc-members:
   :autosummary:
   :autosummary-no-nesting: