§
    ’©ºj  ã                   óœ   — d dl mZ d dlmZmZmZmZ d dlmZ d dl	m
Z
 d dlmZ d dlmZ d dlmZ d dlmZmZ esd	gZ G d
„ de¦  «        ZdS )é    )ÚSequence)ÚAnyÚCallableÚOptionalÚUnion)ÚTensor)ÚLiteral)Úretrieval_normalized_dcg)ÚRetrievalMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzRetrievalNormalizedDCG.plotc                   ó"  ‡ — e Zd ZU dZdZeed<   dZeed<   dZeed<   dZ	e
ed<   d	Ze
ed
<   	 	 	 	 ddedee         dee         deed         ef         deddfˆ fd„Zdededefd„Z	 ddeeeee         f                  dee         defd„Zˆ xZS )ÚRetrievalNormalizedDCGav  Compute `Normalized Discounted Cumulative Gain`_.

    Works with binary or positive integer target data. Accepts float predictions from a model output.

    As input to ``forward`` and ``update`` the metric accepts the following input:

    - ``preds`` (:class:`~torch.Tensor`): A float tensor of shape ``(N, ...)``
    - ``target`` (:class:`~torch.Tensor`): A long or bool tensor of shape ``(N, ...)``
    - ``indexes`` (:class:`~torch.Tensor`): A long tensor of shape ``(N, ...)`` which indicate to which query a
      prediction belongs

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``ndcg@k`` (:class:`~torch.Tensor`): A single-value tensor with the nDCG of the predictions
      ``preds`` w.r.t. the labels ``target``

    All ``indexes``, ``preds`` and ``target`` must have the same dimension and will be flatten at the beginning,
    so that for example, a tensor of shape ``(N, M)`` is treated as ``(N * M, )``. Predictions will be first grouped by
    ``indexes`` and then will be computed as the mean of the metric over each query.


    Args:
        empty_target_action:
            Specify what to do with queries that do not have at least a positive ``target``. Choose from:

            - ``'neg'``: those queries count as ``0.0`` (default)
            - ``'pos'``: those queries count as ``1.0``
            - ``'skip'``: skip those queries; if all queries are skipped, ``0.0`` is returned
            - ``'error'``: raise a ``ValueError``

        ignore_index: Ignore predictions where the target is equal to this number.
        top_k: Consider only the top k elements for each query (default: ``None``, which considers them all)
        aggregation:
            Specify how to aggregate over indexes. Can either a custom callable function that takes in a single tensor
            and returns a scalar value or one of the following strings:

            - ``'mean'``: average value is returned
            - ``'median'``: median value is returned
            - ``'max'``: max value is returned
            - ``'min'``: min value is returned

        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Raises:
        ValueError:
            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
        ValueError:
            If ``ignore_index`` is not `None` or an integer.
        ValueError:
            If ``top_k`` is not ``None`` or not an integer greater than 0.

    Example:
        >>> from torch import tensor
        >>> from torchmetrics.retrieval import RetrievalNormalizedDCG
        >>> indexes = tensor([0, 0, 0, 1, 1, 1, 1])
        >>> preds = tensor([0.2, 0.3, 0.5, 0.1, 0.3, 0.5, 0.2])
        >>> target = tensor([False, False, True, False, True, False, True])
        >>> ndcg = RetrievalNormalizedDCG()
        >>> ndcg(preds, target, indexes=indexes)
        tensor(0.8467)

    FÚis_differentiableTÚhigher_is_betterÚfull_state_updateg        Úplot_lower_boundg      ð?Úplot_upper_boundÚnegNÚmeanÚempty_target_actionÚignore_indexÚtop_kÚaggregation)r   ÚmedianÚminÚmaxÚkwargsÚreturnc                 ó¶   •—  t          ¦   «         j        d|||dœ|¤Ž |�*t          |t          ¦  «        r|dk    st	          d¦  «        ‚|| _        d| _        d S )N)r   r   r   r   z,`top_k` has to be a positive integer or NoneT© )ÚsuperÚ__init__Ú
isinstanceÚintÚ
ValueErrorr   Úallow_non_binary_target)Úselfr   r   r   r   r   Ú	__class__s         €úk/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/retrieval/ndcg.pyr$   zRetrievalNormalizedDCG.__init__c   s€   ø€ ð 	�‰ŒÔð 	
Ø 3Ø%Ø#ð	
ð 	
ð ð		
ð 	
ð 	
ð Ð¥j°½Ñ&<Ô&<ÐÀÈÂÀÝÐKÑLÔLÐLØˆŒ
Ø'+ˆÔ$Ð$Ð$ó    ÚpredsÚtargetc                 ó0   — t          ||| j        ¬¦  «        S )N)r   )r
   r   )r)   r-   r.   s      r+   Ú_metriczRetrievalNormalizedDCG._metricw   s   € Ý'¨¨v¸T¼ZÐHÑHÔHÐHr,   ÚvalÚaxc                 ó.   — |                       ||¦  «        S )as  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> import torch
            >>> from torchmetrics.retrieval import RetrievalNormalizedDCG
            >>> # Example plotting a single value
            >>> metric = RetrievalNormalizedDCG()
            >>> metric.update(torch.rand(10,), torch.randint(2, (10,)), indexes=torch.randint(2,(10,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> import torch
            >>> from torchmetrics.retrieval import RetrievalNormalizedDCG
            >>> # Example plotting multiple values
            >>> metric = RetrievalNormalizedDCG()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(torch.rand(10,), torch.randint(2, (10,)), indexes=torch.randint(2,(10,))))
            >>> fig, ax = metric.plot(values)

        )Ú_plot)r)   r1   r2   s      r+   ÚplotzRetrievalNormalizedDCG.plotz   s   € ðP �zŠz˜#˜rÑ"Ô"Ð"r,   )r   NNr   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   Ústrr   r&   r   r	   r   r   r$   r   r0   r   r   r   r5   Ú__classcell__)r*   s   @r+   r   r      sˆ  ø€ € € € € € ð=ð =ð~ $Ð�tÐ#Ð#Ñ#Ø!Ð�dÐ!Ð!Ñ!Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!ð $)Ø&*Ø#ØPVð,ð ,à ð,ð ˜s”mð,ð ˜Œ}ð	,ð
 ˜7Ð#AÔBÀHÐLÔMð,ð ð,ð 
ð,ð ,ð ,ð ,ð ,ð ,ð(I˜Vð I¨Vð I¸ð Ið Ið Ið Ið _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r,   r   N)Úcollections.abcr   Útypingr   r   r   r   Útorchr   Útyping_extensionsr	   Ú&torchmetrics.functional.retrieval.ndcgr
   Útorchmetrics.retrieval.baser   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r"   r,   r+   ú<module>rH      sþ   ðð %Ð $Ð $Ð $Ð $Ð $Ø 1Ð 1Ð 1Ð 1Ð 1Ð 1Ð 1Ð 1Ð 1Ð 1Ð 1Ð 1à Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %à KÐ KÐ KÐ KÐ KÐ KØ 7Ð 7Ð 7Ð 7Ð 7Ð 7Ø @Ð @Ð @Ð @Ð @Ð @Ø @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð 7Ø5Ð6ÐðE#ð E#ð E#ð E#ð E#˜_ñ E#ô E#ð E#ð E#ð E#r,   