§
    ’©º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)Ú_cramers_v_computeÚ_cramers_v_update)Ú_nominal_input_validation)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzCramersV.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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 )ÚCramersVa9	  Compute `Cramer's V`_ statistic measuring the association between two categorical (nominal) data series.

    .. math::
        V = \sqrt{\frac{\chi^2 / n}{\min(r - 1, k - 1)}}

    where

    .. math::
        \chi^2 = \sum_{i,j} \ frac{\left(n_{ij} - \frac{n_{i.} n_{.j}}{n}\right)^2}{\frac{n_{i.} n_{.j}}{n}}

    where :math:`n_{ij}` denotes the number of times the values :math:`(A_i, B_j)` are observed with :math:`A_i, B_j`
    represent frequencies of values in ``preds`` and ``target``, respectively. Cramer's V is a symmetric coefficient,
    i.e. :math:`V(preds, target) = V(target, preds)`, so order of input arguments does not matter. The output values
    lies in [0, 1] with 1 meaning the perfect association.

    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 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 with shape ``(batch_size,)`` or ``(batch_size, num_classes)``, respectively.

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

    - ``cramers_v`` (:class:`~torch.Tensor`): Scalar tensor containing the Cramer's V statistic.

    Args:
        num_classes: Integer specifying the number of classes
        bias_correction: Indication of whether to use bias correction.
        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.

    Raises:
        ValueError:
            If `nan_strategy` is not one of `'replace'` and `'drop'`
        ValueError:
            If `nan_strategy` is equal to `'replace'` and `nan_replace_value` is not an `int` or `float`

    Example::

        >>> from torch import randint, randn
        >>> from torchmetrics.nominal import CramersV
        >>> preds = randint(0, 4, (100,))
        >>> target = (preds + randn(100)).round().clamp(0, 4)
        >>> cramers_v = CramersV(num_classes=5)
        >>> cramers_v(preds, target)
        tensor(0.5284)

    FÚfull_state_updateÚis_differentiableTÚhigher_is_betterç        Úplot_lower_boundg      ð?Úplot_upper_boundÚconfmatÚreplaceÚnum_classesÚbias_correctionÚ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   r   Ú	add_stateÚtorchÚzeros)Úselfr   r   r   r   r   Ú	__class__s         €úl/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/nominal/cramers.pyr&   zCramersV.__init__Z   s~   ø€ ð 	�‰ŒÔÐ"Ð"˜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CramersV.updatel   s5   € å# E¨6°4Ô3CÀTÔEVÐX\ÔXnÑoÔoˆØˆŒ˜ÑˆŒˆˆr-   c                 ó6   — t          | j        | j        ¦  «        S )zCompute Cramer's V statistic.)r	   r   r   )r*   s    r,   ÚcomputezCramersV.computeq   s   € å! $¤,°Ô0DÑEÔEÐEr-   ÚvalÚaxc                 ó.   — |                       ||¦  «        S )a4  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 CramersV
            >>> metric = CramersV(num_classes=5)
            >>> metric.update(torch.randint(0, 4, (100,)), torch.randint(0, 4, (100,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

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

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