
    i                         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e      Zy)    )Sequence)AnyOptionalUnion)Tensortensor)_minkowski_distance_compute_minkowski_distance_update)Metric)TorchMetricsUserError)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEzMinkowskiDistance.plotc                        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ZdededdfdZdefdZ	 ddeeeee   f      dee   defdZ x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                     t        |   di | t        |t        t        f      r|dk\  st        d|       || _        | j                  dt        d      d       y )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__s      v/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/regression/minkowski.pyr"   zMinkowskiDistance.__init__A   s[    "6"1ucl+Q'*hijhk(lmm+VC[QVW    predstargetsc                 \    t        ||| j                        }| xj                  |z  c_        y)z*Update state with predictions and targets.N)r
   r   r   )r'   r+   r,   r   s       r)   updatezMinkowskiDistance.updateI   s'    7wO#55r*   c                 B    t        | j                  | j                        S )zCompute metric.)r	   r   r   )r'   s    r)   computezMinkowskiDistance.computeN   s    *4+B+BDFFKKr*   valaxc                 &    | j                  ||      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'   r1   r2   s      r)   plotzMinkowskiDistance.plotR   s    P zz#r""r*   )NN)__name__
__module____qualname____doc__r   r   bool__annotations__r   r   r   r$   r   r   r"   r.   r0   r   r   r   r   r5   __classcell__)r(   s   @r)   r   r      s    6 )-x~,',htn,(-x~-!e!X% X3 X4 X6F 6V 6 6
L L
 _c(#E&(6*:":;<(#IQRZI[(#	(#r*   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)   <module>rF      s<    % ' '   p & C @ @01\# \#r*   