
    i                     X    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d	ef
d
Z	y)    )OptionalN)Tensortensor)"_check_retrieval_functional_inputspredstargettop_k
adaptive_kreturnc                 *   t        | |      \  } }t        |t              st        d      ||r!|| j                  d   kD  r| j                  d   }t        |t
              r|dkD  st        d      |j                         st        d| j                        S t        j                  | dkD  |t        j                  |            }|| j                  t        || j                  d         d      d      j                         j                         }||z  S )	a  Compute the precision metric for information retrieval.

    Precision is the fraction of relevant documents among all the 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 Precision@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)
        adaptive_k: adjust `k` to `min(k, number of documents)` for each query

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

    Raises:
        ValueError:
            If ``top_k`` is not `None` or an integer larger than 0.
        ValueError:
            If ``adaptive_k`` is not boolean.

    Example:
        >>> preds = tensor([0.2, 0.3, 0.5])
        >>> target = tensor([True, False, True])
        >>> retrieval_precision(preds, target, top_k=2)
        tensor(0.5000)

    z `adaptive_k` has to be a booleanr   z,`top_k` has to be a positive integer or Noneg        )device)dim   )r   
isinstancebool
ValueErrorshapeintsumr   r   torchwhere
zeros_liketopkminfloat)r   r   r	   r
   target_filteredrelevants         /Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/functional/retrieval/precision.pyretrieval_precisionr       s    @ 7ufEME6j$';<<}B(?Buc"uqyGHH::<c%,,//kk%!)VU5E5Ef5MNOuzz#eU[[_*E2zNqQRVVX^^`He    )NF)
typingr   r   r   r   torchmetrics.utilities.checksr   r   r   r     r!   r   <module>r%      sA        L1v 1v 1hsm 1`d 1qw 1r!   