§
    ’©ºjo
  ã            	       ó\   — 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dS )é    )ÚOptionalN)ÚTensorÚtensor)Ú"_check_retrieval_functional_inputsÚpredsÚtargetÚtop_kÚreturnc                 ó¼  — t          | |¦  «        \  } }|€| j        d         n|}t          |t          ¦  «        r|dk    st	          d¦  «        ‚d|z
  }|                     ¦   «         st          d| j        ¬¦  «        S |t          j	        | dd¬	¦  «                 d|…                              ¦   «          
                    ¦   «         }||                     ¦   «         z  S )
aë  Compute the Fall-out for information retrieval, as explained in `IR Fall-out`_.

    Fall-out is the fraction of non-relevant documents retrieved among all the non-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 Fall-out@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 fall-out (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_fall_out
        >>> preds = tensor([0.2, 0.3, 0.5])
        >>> target = tensor([True, False, True])
        >>> retrieval_fall_out(preds, target, top_k=2)
        tensor(1.)

    Néÿÿÿÿr   z,`top_k` has to be a positive integer or Noneé   g        )ÚdeviceT)ÚdimÚ
descending)r   ÚshapeÚ
isinstanceÚintÚ
ValueErrorÚsumr   r   ÚtorchÚargsortÚfloat)r   r   r	   Úrelevants       úz/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/functional/retrieval/fall_out.pyÚretrieval_fall_outr      sÑ   € õ: 7°u¸fÑEÔE�M€Eˆ6à$˜}ˆEŒK˜ŒOˆO°%€Eå�u�cÑ"Ô"ð I u¨q¢y yÝÐGÑHÔHÐHà�‰Z€Fà�:Š:‰<Œ<ð 0Ý�c %¤,Ð/Ñ/Ô/Ð/à•e”m E¨r¸dÐCÑCÔCÔDÀVÀeÀVÔL×PÒPÑRÔR×XÒXÑZÔZ€HØ�f—j’j‘l”lÑ"Ð"ó    )N)	Útypingr   r   r   r   Útorchmetrics.utilities.checksr   r   r   © r   r   ú<module>r       s�   ðð Ð Ð Ð Ð Ð à €€€Ø  Ð  Ð  Ð  Ð  Ð  Ð  Ð  à LÐ LÐ LÐ LÐ LÐ Lð*#ð *#˜fð *#¨fð *#¸XÀc¼]ð *#ÐV\ð *#ð *#ð *#ð *#ð *#ð *#r   