a
    d	                     @   sN   d dl mZ d dlZd dlmZmZ d dlmZ deeee edddZdS )	    )OptionalN)Tensortensor)"_check_retrieval_functional_inputs)predstargettop_kreturnc                 C   s   t | |\} }|p| jd }t|ts>|dkr>td| d|| jt|| jd dddd  }| sxtd| j	d	S t
|d}d
|d d
  S )aJ  Compute reciprocal rank (for information retrieval). See `Mean Reciprocal Rank`_.

    ``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.

    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)

    Return:
        a single-value tensor with the reciprocal rank (RR) of the predictions ``preds`` wrt the labels ``target``.

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

    Example:
        >>> from torchmetrics.functional.retrieval import retrieval_reciprocal_rank
        >>> preds = torch.tensor([0.2, 0.3, 0.5])
        >>> target = torch.tensor([False, True, False])
        >>> retrieval_reciprocal_rank(preds, target)
        tensor(0.5000)

    r   zAArgument ``top_k`` has to be a positive integer or None, but got .T)sortedZdim   g        )deviceg      ?)r   shape
isinstanceint
ValueErrorZtopkminsumr   r   torchZnonzeroview)r   r   r   position r   z/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/functional/retrieval/reciprocal_rank.pyretrieval_reciprocal_rank   s    $r   )N)	typingr   r   r   r   Ztorchmetrics.utilities.checksr   r   r   r   r   r   r   <module>   s   