o
    ¶ôjð  ã                   @   sŠ   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„ deƒZdS )é    )Ú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_TYPEú(WeightedMeanAbsolutePercentageError.plotc                       s¾   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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 )Ú#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                    sB   t ƒ jdi |¤Ž | jdt d¡dd� | jdt d¡dd� d S )Nr   r   Úsum)ÚdefaultÚdist_reduce_fxr   © )ÚsuperÚ__init__Ú	add_stateÚtorchÚtensor)Úselfr   ©Ú	__class__r   úp/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/regression/wmape.pyr   H   s   z,WeightedMeanAbsolutePercentageError.__init__ÚpredsÚtargetc                 C   s.   t ||ƒ\}}|  j|7  _|  j|7  _dS )z*Update state with predictions and targets.N)r   r   r   )r!   r%   r&   r   r   r   r   r$   ÚupdateM   s   z*WeightedMeanAbsolutePercentageError.updatec                 C   s   t | j| jƒS )z;Compute weighted mean absolute percentage error over state.)r   r   r   )r!   r   r   r$   ÚcomputeT   s   z+WeightedMeanAbsolutePercentageError.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 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*   r   r   r$   ÚplotX   s   (r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   r   r'   r(   r   r   r   r   r   r,   Ú__classcell__r   r   r"   r$   r       s&   
 ÿÿÿþ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   r$   Ú<module>   s   