o
    µôjû  ã                   @   s’   d dl mZ d dlmZmZmZ d dlmZ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„ deƒZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensorÚtensor)Ú_minkowski_distance_computeÚ_minkowski_distance_update)ÚMetric)ÚTorchMetricsUserError)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEúMinkowskiDistance.plotc                       sÆ   e Zd ZU dZdZee ed< dZee ed< dZ	ee ed< dZ
e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fdd„Z	ddeeeee f  dee defdd„Z‡  ZS )ÚMinkowskiDistanceaÇ  Compute `Minkowski Distance`_.

    .. math::
        d_{\text{Minkowski}} = \sum_{i}^N (| y_i - \hat{y_i} |^p)^\frac{1}{p}

    where
        :math: `y` is a tensor of target values,
        :math: `\hat{y}` is a tensor of predictions,
        :math: `\p` is a non-negative integer or floating-point number

    This metric can be seen as generalized version of the standard euclidean distance which corresponds to minkowski
    distance with p=2.

    Args:
        p: int or float larger than 1, exponent to which the difference between preds and target is to be raised
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example:
        >>> from torchmetrics.regression import MinkowskiDistance
        >>> target = tensor([1.0, 2.8, 3.5, 4.5])
        >>> preds = tensor([6.1, 2.11, 3.1, 5.6])
        >>> minkowski_distance = MinkowskiDistance(3)
        >>> minkowski_distance(preds, target)
        tensor(5.1220)

    TÚis_differentiableFÚhigher_is_betterÚfull_state_updateç        Úplot_lower_boundÚminkowski_dist_sumÚpÚkwargsÚreturnNc                    sT   t ƒ jdi |¤Ž t|ttfƒr|dkstd|› �ƒ‚|| _| jdtdƒdd� d S )Né   z>Argument ``p`` must be a float or int greater than 1, but got r   r   Úsum)ÚdefaultÚdist_reduce_fx© )	ÚsuperÚ__init__Ú
isinstanceÚfloatÚintr   r   Ú	add_stater   )Úselfr   r   ©Ú	__class__r   út/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/regression/minkowski.pyr    A   s
   zMinkowskiDistance.__init__ÚpredsÚtargetsc                 C   s    t ||| jƒ}|  j|7  _dS )z*Update state with predictions and targets.N)r	   r   r   )r%   r)   r*   r   r   r   r(   ÚupdateI   s   zMinkowskiDistance.updatec                 C   s   t | j| jƒS )zCompute metric.)r   r   r   )r%   r   r   r(   ÚcomputeN   s   zMinkowskiDistance.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 MinkowskiDistance
            >>> metric = MinkowskiDistance(p=3)
            >>> 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 MinkowskiDistance
            >>> metric = MinkowskiDistance(p=3)
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )Ú_plot)r%   r-   r.   r   r   r(   ÚplotR   s   (r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   r   ÚboolÚ__annotations__r   r   r   r"   r   r   r    r+   r,   r   r   r   r   r0   Ú__classcell__r   r   r&   r(   r      s$   
 ÿÿÿþr   N)Úcollections.abcr   Útypingr   r   r   Útorchr   r   Ú,torchmetrics.functional.regression.minkowskir   r	   Útorchmetrics.metricr
   Ú!torchmetrics.utilities.exceptionsr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r   r   r   r(   Ú<module>   s   