§
    ’©ºji	  ã            	       óX   — d dl mZ d dlZd dlmZ d dlmZ d
dededee         defd	„ZdS )é    )ÚOptionalN)ÚTensor)Ú"_check_retrieval_functional_inputsÚpredsÚtargetÚtop_kÚreturnc                 ó8  — t          | |¦  «        \  } }|€| j        d         }t          |t          ¦  «        r|dk    st	          d¦  «        ‚|t          j        | dd¬¦  «                 d|…                              ¦   «         }|dk                         ¦   «         S )a»  Compute the hit rate for information retrieval.

    The hit rate is 1.0 if there is at least one relevant document among all the top `k` retrieved documents.

    ``preds`` and ``target`` should be of the same shape and live on the same device. If no ``target`` is ``True``,
    ``0`` is returned. ``target`` must be either `bool` or `integers` and ``preds`` must be ``float``,
    otherwise an error is raised. If you want to measure HitRate@K, ``top_k`` must be a positive integer.

    Args:
        preds: estimated probabilities of each document to be relevant.
        target: ground truth about each document being relevant or not.
        top_k: consider only the top k elements (default: `None`, which considers them all)

    Returns:
        A single-value tensor with the hit rate (at ``top_k``) of the predictions ``preds`` w.r.t. the labels
          ``target``.

    Raises:
        ValueError:
            If ``top_k`` parameter is not `None` or an integer larger than 0

    Example:
        >>> from torch import tensor
        >>> preds = tensor([0.2, 0.3, 0.5])
        >>> target = tensor([True, False, True])
        >>> retrieval_hit_rate(preds, target, top_k=2)
        tensor(1.)

    Néÿÿÿÿr   z,`top_k` has to be a positive integer or NoneT)ÚdimÚ
descending)	r   ÚshapeÚ
isinstanceÚintÚ
ValueErrorÚtorchÚargsortÚsumÚfloat)r   r   r   Úrelevants       úz/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/functional/retrieval/hit_rate.pyÚretrieval_hit_rater      s—   € õ< 7°u¸fÑEÔE�M€Eˆ6à€}Ø”˜B”ˆå�u�cÑ"Ô"ð I u¨q¢y yÝÐGÑHÔHÐHà•e”m E¨r¸dÐCÑCÔCÔDÀVÀeÀVÔL×PÒPÑRÔR€HØ�qŠL×ÒÑ!Ô!Ð!ó    )N)Útypingr   r   r   Útorchmetrics.utilities.checksr   r   r   © r   r   ú<module>r      sŠ   ðð Ð Ð Ð Ð Ð à €€€Ø Ð Ð Ð Ð Ð à LÐ LÐ LÐ LÐ LÐ Lð'"ð '"˜fð '"¨fð '"¸XÀc¼]ð '"ÐV\ð '"ð '"ð '"ð '"ð '"ð '"r   