o
    ´ôjV   ã                   @   s¦   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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mZ esId
gZG dd„ deƒZdS )é    )ÚSequence)ÚAnyÚListÚOptionalÚUnion)ÚTensor)ÚLiteral)Ú_kendall_corrcoef_computeÚ_kendall_corrcoef_updateÚ_MetricVariantÚ_TestAlternative)ÚMetric)Údim_zero_cat)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEúKendallRankCorrCoef.plotc                       sð   e Zd ZU dZdZdZdZdZee	d< dZ
ee	d< ee e	d	< ee e	d
< 				d ded dedeed  dededdf‡ fdd„Zd	ed
eddfdd„Zdeeeeef f fdd„Z	d!deeeee f  dee defdd„Z‡  ZS )"ÚKendallRankCorrCoefa±  Compute `Kendall Rank Correlation Coefficient`_.

    .. math::
        tau_a = \frac{C - D}{C + D}

    where :math:`C` represents concordant pairs, :math:`D` stands for discordant pairs.

    .. math::
        tau_b = \frac{C - D}{\sqrt{(C + D + T_{preds}) * (C + D + T_{target})}}

    where :math:`C` represents concordant pairs, :math:`D` stands for discordant pairs and :math:`T` represents
    a total number of ties.

    .. math::
        tau_c = 2 * \frac{C - D}{n^2 * \frac{m - 1}{m}}

    where :math:`C` represents concordant pairs, :math:`D` stands for discordant pairs, :math:`n` is a total number
    of observations and :math:`m` is a ``min`` of unique values in ``preds`` and ``target`` sequence.

    Definitions according to Definition according to `The Treatment of Ties in Ranking Problems`_.

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

    - ``preds`` (:class:`~torch.Tensor`): Sequence of data in float tensor of either shape ``(N,)`` or ``(N,d)``
    - ``target`` (:class:`~torch.Tensor`): Sequence of data in float tensor of either shape ``(N,)`` or ``(N,d)``

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

    - ``kendall`` (:class:`~torch.Tensor`): A tensor with the correlation tau statistic,
      and if it is not None, the p-value of corresponding statistical test.

    Args:
        variant: Indication of which variant of Kendall's tau to be used
        t_test: Indication whether to run t-test
        alternative: Alternative hypothesis for t-test. Possible values:
            - 'two-sided': the rank correlation is nonzero
            - 'less': the rank correlation is negative (less than zero)
            - 'greater':  the rank correlation is positive (greater than zero)
        num_outputs: Number of outputs in multioutput setting
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Raises:
        ValueError: If ``t_test`` is not of a type bool
        ValueError: If ``t_test=True`` and ``alternative=None``

    Example (single output regression):
        >>> from torch import tensor
        >>> from torchmetrics.regression import KendallRankCorrCoef
        >>> preds = tensor([2.5, 0.0, 2, 8])
        >>> target = tensor([3, -0.5, 2, 1])
        >>> kendall = KendallRankCorrCoef()
        >>> kendall(preds, target)
        tensor(0.3333)

    Example (multi output regression):
        >>> from torchmetrics.regression import KendallRankCorrCoef
        >>> preds = tensor([[2.5, 0.0], [2, 8]])
        >>> target = tensor([[3, -0.5], [2, 1]])
        >>> kendall = KendallRankCorrCoef(num_outputs=2)
        >>> kendall(preds, target)
        tensor([1., 1.])

    Example (single output regression with t-test):
        >>> from torchmetrics.regression import KendallRankCorrCoef
        >>> preds = tensor([2.5, 0.0, 2, 8])
        >>> target = tensor([3, -0.5, 2, 1])
        >>> kendall = KendallRankCorrCoef(t_test=True, alternative='two-sided')
        >>> kendall(preds, target)
        (tensor(0.3333), tensor(0.4969))

    Example (multi output regression with t-test):
        >>> from torchmetrics.regression import KendallRankCorrCoef
        >>> preds = tensor([[2.5, 0.0], [2, 8]])
        >>> target = tensor([[3, -0.5], [2, 1]])
        >>> kendall = KendallRankCorrCoef(t_test=True, alternative='two-sided', num_outputs=2)
        >>> kendall(preds, target)
        (tensor([1., 1.]), tensor([nan, nan]))

    FNTg        Úplot_lower_boundg      ð?Úplot_upper_boundÚpredsÚtargetÚbú	two-sidedé   Úvariant)Úar   ÚcÚt_testÚalternative)r   ÚlessÚgreaterÚnum_outputsÚkwargsÚreturnc                    s–   t ƒ jdi |¤Ž t|tƒstdt|ƒ› d�ƒ‚|r"|d u r"tdƒ‚t t|ƒ¡| _	|r3t
 t|ƒ¡nd | _|| _| jdg dd� | jdg dd� d S )	Nz>Argument `t_test` is expected to be of a type `bool`, but got Ú.zCArgument `alternative` is required if `t_test=True` but got `None`.r   Úcat)Údist_reduce_fxr   © )ÚsuperÚ__init__Ú
isinstanceÚboolÚ
ValueErrorÚtyper   Úfrom_strÚstrr   r   r   r"   Ú	add_state)Úselfr   r   r   r"   r#   ©Ú	__class__r(   úr/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/regression/kendall.pyr*   ~   s   
zKendallRankCorrCoef.__init__c                 C   s$   t ||| j| j| jd�\| _| _dS )zJUpdate variables required to compute Kendall rank correlation coefficient.)r"   N)r
   r   r   r"   )r2   r   r   r(   r(   r5   Úupdate“   s   ûzKendallRankCorrCoef.updatec                 C   s>   t | jƒ}t | jƒ}t||| j| jƒ\}}|dur||fS |S )zgCompute Kendall rank correlation coefficient, and optionally p-value of corresponding statistical test.N)r   r   r   r	   r   r   )r2   r   r   ÚtauÚp_valuer(   r(   r5   Úcompute�   s   

üzKendallRankCorrCoef.computeÚvalÚaxc                 C   s   |   ||¡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

            >>> from torch import randn
            >>> # Example plotting a single value
            >>> from torchmetrics.regression import KendallRankCorrCoef
            >>> metric = KendallRankCorrCoef()
            >>> metric.update(randn(10,), randn(10,))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import randn
            >>> # Example plotting multiple values
            >>> from torchmetrics.regression import KendallRankCorrCoef
            >>> metric = KendallRankCorrCoef()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )Ú_plot)r2   r:   r;   r(   r(   r5   Úplot¬   s   (r   )r   Fr   r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__Úis_differentiableÚhigher_is_betterÚfull_state_updater   ÚfloatÚ__annotations__r   r   r   r   r,   r   Úintr   r*   r6   r   Útupler9   r   r   r   r=   Ú__classcell__r(   r(   r3   r5   r   $   sH   
 Pûþý
üûúù
ÿÿÿþr   N)Úcollections.abcr   Útypingr   r   r   r   Útorchr   Útyping_extensionsr   Ú*torchmetrics.functional.regression.kendallr	   r
   r   r   Útorchmetrics.metricr   Útorchmetrics.utilities.datar   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r(   r(   r(   r5   Ú<module>   s   