.. customcarditem::
   :header: Cosine Similarity
   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
   :tags: Regression

.. include:: ../links.rst

#################
Cosine Similarity
#################

Module Interface
________________

.. autoclass:: torchmetrics.CosineSimilarity
    :exclude-members: update, compute

Functional Interface
____________________

.. autofunction:: torchmetrics.functional.cosine_similarity