.. customcarditem::
   :header: Area Under the Receiver Operating Characteristic Curve (AUROC)
   :image: _static/fetched-s3-assets/tabular_classification.svg
   :tags: Classification

.. include:: ../links.rst

#####
AUROC
#####

Module Interface
________________

.. autoclass:: torchmetrics.AUROC
    :noindex:
    :exclude-members: update, compute
    :special-members: __new__

BinaryAUROC
^^^^^^^^^^^

.. autoclass:: torchmetrics.classification.BinaryAUROC
    :noindex:
    :exclude-members: update, compute

MulticlassAUROC
^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.classification.MulticlassAUROC
    :noindex:
    :exclude-members: update, compute

MultilabelAUROC
^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.classification.MultilabelAUROC
    :noindex:
    :exclude-members: update, compute

Functional Interface
____________________

.. autofunction:: torchmetrics.functional.auroc
    :noindex:

binary_auroc
^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.classification.binary_auroc
    :noindex:

multiclass_auroc
^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.classification.multiclass_auroc
    :noindex:

multilabel_auroc
^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.classification.multilabel_auroc
    :noindex: