Ë
    þÍ:j!
  ã            	       óT   — d dl mZ d dlZd dlmZmZ d dlmZ d
dededee   defd	„Zy)é    )ÚOptionalN)ÚTensorÚtensor)Ú"_check_retrieval_functional_inputsÚpredsÚtargetÚtop_kÚreturnc                 óÄ  — t        | |«      \  } }|€| j                  d   }t        |t        «      r|dkD  st	        d«      ‚|j                  «       st        d| j                  ¬«      S t        j                  | dkD  |t        j                  |«      «      }|t        j                  | dd¬«         d| j                  «       j                  «       }||j                  «       z  S )	aÁ  Compute the recall metric for information retrieval.

    Recall is the fraction of relevant documents retrieved among all the relevant 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 Recall@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 recall (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  torchmetrics.functional import retrieval_recall
        >>> preds = tensor([0.2, 0.3, 0.5])
        >>> target = tensor([True, False, True])
        >>> retrieval_recall(preds, target, top_k=2)
        tensor(0.5000)

    Néÿÿÿÿr   z,`top_k` has to be a positive integer or Noneg        )ÚdeviceT)ÚdimÚ
descending)r   ÚshapeÚ
isinstanceÚintÚ
ValueErrorÚsumr   r   ÚtorchÚwhereÚ
zeros_likeÚargsortÚfloat)r   r   r	   Útarget_filteredÚrelevants        ú}/home/mcse/projects/srt_converter/srt-converter-venv/lib/python3.12/site-packages/torchmetrics/functional/retrieval/recall.pyÚretrieval_recallr      s¾   € ô: 7°u¸fÓE�M€Eˆ6à€}Ø—‘˜B‘ˆä�uœcÔ" u¨q¢yÜÐGÓHÐHà�:‰:Œ<Ü�c %§,¡,Ô/Ð/ä—k‘k %¨!¡)¨V´U×5EÑ5EÀfÓ5MÓN€OØœuŸ}™}¨U¸ÀtÔLÑMÈfÈuÐU×YÑYÓ[×aÑaÓc€Hà�f—j‘j“lÑ"Ð"ó    )N)	Útypingr   r   r   r   Útorchmetrics.utilities.checksr   r   r   © r   r   ú<module>r"      s9   ðõ ã ß  å Lñ+#˜Fð +#¨Fð +#¸8ÀC¹=ð +#ÐTZô +#r   