a
    d
                     @   sH   d dl mZ d dlmZmZ d dlmZ d	eeee eedddZ	dS )
    )Optional)Tensortensor)"_check_retrieval_functional_inputsNF)predstargettop_k
adaptive_kreturnc                 C   s   t | |\} }t|ts td|du s:|rD|| jd krD| jd }t|trV|dks^td| sttd| jdS || j	t
|| jd ddd	    }|| 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 booleanNr   z,`top_k` has to be a positive integer or Noneg        )device)Zdim   )r   
isinstancebool
ValueErrorshapeintsumr   r   Ztopkminfloat)r   r   r   r	   Zrelevant r   t/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/functional/retrieval/precision.pyretrieval_precision   s     

*r   )NF)
typingr   Ztorchr   r   Ztorchmetrics.utilities.checksr   r   r   r   r   r   r   r   <module>   s   