
    i                         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	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UnionN)Tensor)0_weighted_mean_absolute_percentage_error_compute/_weighted_mean_absolute_percentage_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEz(WeightedMeanAbsolutePercentageError.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<   eed	<   eed
<   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 )#WeightedMeanAbsolutePercentageErroraw  Compute weighted mean absolute percentage error (`WMAPE`_).

    The output of WMAPE metric is a non-negative floating point, where the optimal value is 0. It is computes as:

    .. math::
        \text{WMAPE} = \frac{\sum_{t=1}^n | y_t - \hat{y}_t | }{\sum_{t=1}^n |y_t| }

    Where :math:`y` is a tensor of target values, and :math:`\hat{y}` is a tensor of predictions.

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

    - ``preds`` (:class:`~torch.Tensor`): Predictions from model
    - ``target`` (:class:`~torch.Tensor`): Ground truth float tensor with shape ``(N,d)``

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

    - ``wmape`` (:class:`~torch.Tensor`): A tensor with non-negative floating point wmape value between 0 and 1

    Args:
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example:
        >>> from torch import randn
        >>> preds = randn(20,)
        >>> target = randn(20,)
        >>> wmape = WeightedMeanAbsolutePercentageError()
        >>> wmape(preds, target)
        tensor(1.3967)

    Tis_differentiableFhigher_is_betterfull_state_update        plot_lower_boundsum_abs_error	sum_scalekwargsreturnNc                     t        |   di | | j                  dt        j                  d      d       | j                  dt        j                  d      d       y )Nr   r   sum)defaultdist_reduce_fxr    )super__init__	add_statetorchtensor)selfr   	__class__s     r/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/regression/wmape.pyr   z,WeightedMeanAbsolutePercentageError.__init__H   sJ    "6"S0ARWX{ELL,=eT    predstargetc                 v    t        ||      \  }}| xj                  |z  c_        | xj                  |z  c_        y)z*Update state with predictions and targets.N)r	   r   r   )r#   r'   r(   r   r   s        r%   updatez*WeightedMeanAbsolutePercentageError.updateM   s4    #RSXZ`#a ym+)#r&   c                 B    t        | j                  | j                        S )z;Compute weighted mean absolute percentage error over state.)r   r   r   )r#   s    r%   computez+WeightedMeanAbsolutePercentageError.computeT   s    ?@R@RTXTbTbccr&   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 WeightedMeanAbsolutePercentageError
            >>> metric = WeightedMeanAbsolutePercentageError()
            >>> 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 WeightedMeanAbsolutePercentageError
            >>> metric = WeightedMeanAbsolutePercentageError()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )_plot)r#   r-   r.   s      r%   plotz(WeightedMeanAbsolutePercentageError.plotX   s    P zz#r""r&   )NN)__name__
__module____qualname____doc__r   bool__annotations__r   r   r   floatr   r   r   r*   r,   r   r   r   r   r   r1   __classcell__)r$   s   @r%   r   r       s    > #t""d"#t#!e!U U U
$F $F $t $d d
 _c(#E&(6*:":;<(#IQRZI[(#	(#r&   r   )collections.abcr   typingr   r   r   r!   r   (torchmetrics.functional.regression.wmaper   r	   torchmetrics.metricr
   torchmetrics.utilities.importsr   torchmetrics.utilities.plotr   r   __doctest_skip__r   r   r&   r%   <module>rA      s@    % ' '   ' @ @BC`#& `#r&   