libauc.datasets
=======================

This module aims to provide several popular dataset wrappers collected and adapted from public codebases to test LibAUC algorithms. We modified some of them to make them adaptable to some LibAUC algorithms that require tracking an index for each individual sample, such as :obj:`~libauc.losses.auc.APLoss`, :obj:`~libauc.losses.auc.pAUCLoss`, :obj:`~libauc.losses.contrastive.GCLoss`. We recommend users to cite the original papers when using these wrappers. Here is an overview of this module:

.. list-table::

   * - **Dataset**
     - **Reference**
   * - :obj:`~libauc.datasets.cat\_vs\_dog.CAT_VS_DOG`: Cat_vs_Dog
     - `elson2007asirra <https://www.microsoft.com/en-us/research/publication/asirra-a-captcha-that-exploits-interest-aligned-manual-image-categorization/>`__    
   * - :obj:`~libauc.datasets.cifar.CIFAR10`: Cifar10
     - `krizhevsky2009learning <http://www.cs.utoronto.ca/~kriz/learning-features-2009-TR.pdf>`__   
   * - :obj:`~libauc.datasets.cifar.CIFAR100`: Cifar100
     - `krizhevsky2009learning <http://www.cs.utoronto.ca/~kriz/learning-features-2009-TR.pdf>`__    
   * - :obj:`~libauc.datasets.stl10.STL10`: STL10
     - `coates2011analysis <https://cs.stanford.edu/~acoates/papers/coatesleeng_aistats_2011.pdf>`__    
   * - :obj:`~libauc.datasets.chexpert.CheXpert`: CheXpert
     - `irvin2019chexpert <https://arxiv.org/abs/1901.07031>`__    
   * - :obj:`~libauc.datasets.movielens.MoiveLens`: MovieLens20M
     - `ml_yt_trailers <https://grouplens.org/datasets/movielens/>`__   
   * - :obj:`~libauc.datasets.melanoma.Melanoma`: Melanoma
     - `rotemberg2021patient <https://www.nature.com/articles/s41597-021-00815-z>`__    
   * - :obj:`~libauc.datasets.folder.ImageFolder`: A generic data loader
     - `PyTorch <https://pytorch.org/vision/stable/generated/torchvision.datasets.ImageFolder.html>`__    
       
Please refer to the source code for more details about each implementation. 

libauc.datasets.cat\_vs\_dog 
-----------------------------------

.. automodule:: libauc.datasets.cat_vs_dog
   :members:
   :undoc-members:
   :exclude-members: 

libauc.datasets.cifar
----------------------------

.. automodule:: libauc.datasets.cifar
   :members:
   :undoc-members:
   :exclude-members:


libauc.datasets.stl10
----------------------------

.. automodule:: libauc.datasets.stl10
   :members:
   :undoc-members:
   :exclude-members:

libauc.datasets.chexpert
-------------------------------

.. automodule:: libauc.datasets.chexpert
   :members:
   :noindex:
   :undoc-members:
   :exclude-members: class_counts, data_size, image_augmentation, imbalance_ratio, num_classes

libauc.datasets.folder
-----------------------------

.. automodule:: libauc.datasets.folder
   :members:
   :undoc-members:
   :exclude-members:

libauc.datasets.melanoma
-------------------------------

.. automodule:: libauc.datasets.melanoma
   :members:
   :undoc-members:
   :exclude-members: class_counts, get_train_val_split, imbalance_ratio, num_classes

libauc.datasets.movielens
--------------------------------

.. automodule:: libauc.datasets.movielens
   :members:
   :undoc-members:
   :exclude-members: