.. customcarditem::
   :header: Recall
   :image: _static/fetched-s3-assets/tabular_classification.svg
   :tags: Classification

.. include:: ../links.rst

######
Recall
######

Module Interface
________________

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

BinaryRecall
^^^^^^^^^^^^

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

MulticlassRecall
^^^^^^^^^^^^^^^^

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

MultilabelRecall
^^^^^^^^^^^^^^^^

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

Functional Interface
____________________

.. autofunction:: torchmetrics.functional.recall
    :noindex:

binary_recall
^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.classification.binary_recall
    :noindex:

multiclass_recall
^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.classification.multiclass_recall
    :noindex:

multilabel_recall
^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.classification.multilabel_recall
    :noindex: