
    i!
              	       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)

    Nr   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        }/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/functional/retrieval/recall.pyretrieval_recallr      s    : 7ufEME6}Buc"uqyGHH::<c%,,//kk%!)VU5E5Ef5MNOu}}UtLMfuUYY[aacHfjjl""    )N)	typingr   r   r   r   torchmetrics.utilities.checksr   r   r    r   r   <module>r"      s9        L+#F +#F +#8C= +#TZ +#r   