§
    ’©ºj¦  ã                   ó°   — d dl mZ d dlmZmZmZ d dlZd dlmZ d dlm	Z	 d dl
mZ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ÚOptionalÚUnionN)ÚTensor)ÚLiteral)Ú_theils_u_computeÚ_theils_u_update)Ú_nominal_input_validation)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzTheilsU.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
<   eed<   	 	 ddeded         dee
         deddf
ˆ fd„Zdededdfd„Zdefd„Zddeeee         df         dee         defd„Zˆ xZS )ÚTheilsUaÞ  Compute `Theil's U`_ statistic measuring the association between two categorical (nominal) data series.

    .. math::
        U(X|Y) = \frac{H(X) - H(X|Y)}{H(X)}

    where :math:`H(X)` is entropy of variable :math:`X` while :math:`H(X|Y)` is the conditional entropy of :math:`X`
    given :math:`Y`. It is also know as the Uncertainty Coefficient. Theils's U is an asymmetric coefficient, i.e.
    :math:`TheilsU(preds, target) \neq TheilsU(target, preds)`, so the order of the inputs matters. The output values
    lies in [0, 1], where a 0 means y has no information about x while value 1 means y has complete information about x.

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

    - ``preds`` (:class:`~torch.Tensor`): Either 1D or 2D tensor of categorical (nominal) data from the first data
      series (called X in the above definition) with shape ``(batch_size,)`` or ``(batch_size, num_classes)``,
      respectively.
    - ``target`` (:class:`~torch.Tensor`): Either 1D or 2D tensor of categorical (nominal) data from the second data
      series (called Y in the above definition) with shape ``(batch_size,)`` or ``(batch_size, num_classes)``,
      respectively.

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

    - ``theils_u`` (:class:`~torch.Tensor`): Scalar tensor containing the Theil's U statistic.

    Args:
        num_classes: Integer specifying the number of classes
        nan_strategy: Indication of whether to replace or drop ``NaN`` values
        nan_replace_value: Value to replace ``NaN``s when ``nan_strategy = 'replace'``
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example::

        >>> from torch import randint
        >>> from torchmetrics.nominal import TheilsU
        >>> preds = randint(10, (10,))
        >>> target = randint(10, (10,))
        >>> metric = TheilsU(num_classes=10)
        >>> metric(preds, target)
        tensor(0.8530)

    FÚfull_state_updateÚis_differentiableTÚhigher_is_betterç        Úplot_lower_boundg      ð?Úplot_upper_boundÚconfmatÚreplaceÚnum_classesÚnan_strategy)r   ÚdropÚnan_replace_valueÚkwargsÚreturnNc                 óÚ   •—  t          ¦   «         j        di |¤Ž || _        t          ||¦  «         || _        || _        |                      dt          j        ||¦  «        d¬¦  «         d S )Nr   Úsum)Údist_reduce_fx© )	ÚsuperÚ__init__r   r   r   r   Ú	add_stateÚtorchÚzeros)Úselfr   r   r   r   Ú	__class__s        €úm/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/nominal/theils_u.pyr%   zTheilsU.__init__P   sv   ø€ ð 	�‰ŒÔÐ"Ð"˜6Ð"Ð"Ð"Ø&ˆÔå! ,Ð0AÑBÔBÐBØ(ˆÔØ!2ˆÔà�Š�y¥%¤+¨k¸;Ñ"GÔ"GÐX]ˆÑ^Ô^Ð^Ð^Ð^ó    ÚpredsÚtargetc                 ój   — t          ||| j        | j        | j        ¦  «        }| xj        |z  c_        dS )z*Update state with predictions and targets.N)r
   r   r   r   r   )r)   r-   r.   r   s       r+   ÚupdatezTheilsU.update`   s5   € å" 5¨&°$Ô2BÀDÔDUÐW[ÔWmÑnÔnˆØˆŒ˜ÑˆŒˆˆr,   c                 ó*   — t          | j        ¦  «        S )zCompute Theil's U statistic.)r	   r   )r)   s    r+   ÚcomputezTheilsU.computee   s   € å  ¤Ñ.Ô.Ð.r,   ÚvalÚaxc                 ó.   — |                       ||¦  «        S )a&  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

            >>> # Example plotting a single value
            >>> import torch
            >>> from torchmetrics.nominal import TheilsU
            >>> metric = TheilsU(num_classes=10)
            >>> metric.update(torch.randint(10, (10,)), torch.randint(10, (10,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> import torch
            >>> from torchmetrics.nominal import TheilsU
            >>> metric = TheilsU(num_classes=10)
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(torch.randint(10, (10,)), torch.randint(10, (10,))))
            >>> fig_, ax_ = metric.plot(values)

        )Ú_plot)r)   r3   r4   s      r+   ÚplotzTheilsU.ploti   s   € ðL �zŠz˜#˜rÑ"Ô"Ð"r,   )r   r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   Úintr   r   r   r%   r0   r2   r   r   r   r   r7   Ú__classcell__)r*   s   @r+   r   r      s‡  ø€ € € € € € ð'ð 'ðR $Ð�tÐ#Ð#Ñ#Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�dÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!Ø€O€O�Oð
 4=Ø-0ð	_ð _àð_ð Ð/Ô0ð_ð $ Eœ?ð	_ð
 ð_ð 
ð_ð _ð _ð _ð _ð _ð  ˜Fð  ¨Fð  °tð  ð  ð  ð  ð
/˜ð /ð /ð /ð /ð&#ð &#˜˜f h¨vÔ&6¸Ð<Ô=ð &#È(ÐS[ÔJ\ð &#Ðhvð &#ð &#ð &#ð &#ð &#ð &#ð &#ð &#r,   r   )Úcollections.abcr   Útypingr   r   r   r'   r   Útyping_extensionsr   Ú(torchmetrics.functional.nominal.theils_ur	   r
   Ú%torchmetrics.functional.nominal.utilsr   Útorchmetrics.metricr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r#   r,   r+   ú<module>rJ      s  ðð %Ð $Ð $Ð $Ð $Ð $Ø 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'à €€€Ø Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %à XÐ XÐ XÐ XÐ XÐ XÐ XÐ XØ KÐ KÐ KÐ KÐ KÐ KØ &Ð &Ð &Ð &Ð &Ð &Ø @Ð @Ð @Ð @Ð @Ð @Ø @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð (Ø&Ð'Ððp#ð p#ð p#ð p#ð p#ˆfñ p#ô p#ð p#ð p#ð p#r,   