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mZ es9dgZG d	d
„ d
eƒZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensorÚtensor)Ú'_mean_absolute_percentage_error_computeÚ&_mean_absolute_percentage_error_update)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEú MeanAbsolutePercentageError.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 )ÚMeanAbsolutePercentageErroraÀ  Compute `Mean Absolute Percentage Error`_ (MAPE).

    .. math:: \text{MAPE} = \frac{1}{n}\sum_{i=1}^n\frac{|   y_i - \hat{y_i} |}{\max(\epsilon, | y_i |)}

    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 values

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

    - ``mean_abs_percentage_error`` (:class:`~torch.Tensor`): A tensor with the mean absolute percentage error over
      state

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

    Note:
        MAPE output is a non-negative floating point. Best result is ``0.0`` . But it is important to note that,
        bad predictions, can lead to arbitrarily large values. Especially when some ``target`` values are close to 0.
        This `MAPE implementation returns`_ a very large number instead of ``inf``.

    Example:
        >>> from torch import tensor
        >>> from torchmetrics.regression import MeanAbsolutePercentageError
        >>> target = tensor([1, 10, 1e6])
        >>> preds = tensor([0.9, 15, 1.2e6])
        >>> mean_abs_percentage_error = MeanAbsolutePercentageError()
        >>> mean_abs_percentage_error(preds, target)
        tensor(0.2667)

    TÚis_differentiableFÚhigher_is_betterÚfull_state_updateç        Úplot_lower_boundÚsum_abs_per_errorÚtotalÚkwargsÚreturnNc                    s>   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_stater   )Úselfr   ©Ú	__class__r   úo/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/regression/mape.pyr   K   s   z$MeanAbsolutePercentageError.__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   Únum_obsr   r   r#   ÚupdateT   s   z"MeanAbsolutePercentageError.updatec                 C   s   t | j| jƒS )z2Compute mean absolute percentage error over state.)r   r   r   )r    r   r   r#   Úcompute[   s   z#MeanAbsolutePercentageError.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 MeanAbsolutePercentageError
            >>> metric = MeanAbsolutePercentageError()
            >>> 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 MeanAbsolutePercentageError
            >>> metric = MeanAbsolutePercentageError()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )Ú_plot)r    r)   r*   r   r   r#   Úplot_   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   N)Úcollections.abcr   Útypingr   r   r   Útorchr   r   Ú'torchmetrics.functional.regression.maper   r	   Útorchmetrics.metricr
   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r   r   r   r#   Ú<module>   s   