.. customcarditem::
   :header: Retrieval Hit Rate
   :image: _static/fetched-s3-assets/text_classification.svg
   :tags: Retrieval

.. include:: ../links.rst

##################
Retrieval Hit Rate
##################

Module Interface
________________

.. autoclass:: torchmetrics.retrieval.RetrievalHitRate
    :exclude-members: update, compute

Functional Interface
____________________

.. autofunction:: torchmetrics.functional.retrieval.retrieval_hit_rate