a
    d                     @   s   d dl mZ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sndgZG d	d
 d
eZdS )    )AnyOptionalSequence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
< edd fddZeeddddZedddZdeeeee f  ee edddZ  ZS )#WeightedMeanAbsolutePercentageErrora  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:
        >>> import torch
        >>> _ = torch.manual_seed(42)
        >>> preds = torch.randn(20,)
        >>> target = torch.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_scaleN)kwargsreturnc                    sB   t  jf i | | jdtddd | jdtddd d S )Nr   r   sum)defaultZdist_reduce_fxr   )super__init__Z	add_statetorchZtensor)selfr   	__class__ f/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/regression/wmape.pyr   G   s    z,WeightedMeanAbsolutePercentageError.__init__)predstargetr   c                 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!   updateL   s    z*WeightedMeanAbsolutePercentageError.update)r   c                 C   s   t | j| jS )z;Compute weighted mean absolute percentage error over state.)r   r   r   )r   r    r    r!   computeS   s    z+WeightedMeanAbsolutePercentageError.compute)valaxr   c                 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)

        )Z_plot)r   r&   r'   r    r    r!   plotW   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   )typingr   r   r   r   r   r   Z(torchmetrics.functional.regression.wmaper   r   Ztorchmetrics.metricr	   Ztorchmetrics.utilities.importsr
   Ztorchmetrics.utilities.plotr   r   Z__doctest_skip__r   r    r    r    r!   <module>   s   