o
    yi
                     @   sP   d dl m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dZ	dS )    )Optional)Tensortensor)"_check_retrieval_functional_inputsNFpredstargetk
adaptive_kreturnc                 C   s   t | |\} }t|tstd|du s|r"|| jd kr"| jd }t|tr+|dks/td| s:td| jdS || j	t
|| jd ddd	    }|| S )
a  Computes 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, ``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.
        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 ``k``) of the predictions ``preds`` w.r.t. the labels ``target``.

    Raises:
        ValueError:
            If ``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, k=2)
        tensor(0.5000)
    z `adaptive_k` has to be a booleanNr   z(`k` has to be a positive integer or Noneg        )device)dim   )r   
isinstancebool
ValueErrorshapeintsumr   r   topkminfloat)r   r   r   r	   relevant r   _/home/ubuntu/.local/lib/python3.10/site-packages/torchmetrics/functional/retrieval/precision.pyretrieval_precision   s   

*r   )NF)
typingr   torchr   r   torchmetrics.utilities.checksr   r   r   r   r   r   r   r   <module>   s   (