
    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mZ esdgZ G d	 d
e      Zy)    )Sequence)AnyOptionalUnion)Tensortensor)1_symmetric_mean_absolute_percentage_error_compute0_symmetric_mean_absolute_percentage_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEz)SymmetricMeanAbsolutePercentageError.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<   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 )$SymmetricMeanAbsolutePercentageErroraG  Compute symmetric mean absolute percentage error (`SMAPE`_).

    .. math:: \text{SMAPE} = \frac{2}{n}\sum_1^n\frac{|   y_i - \hat{y_i} |}{\max(| y_i | + | \hat{y_i} |, \epsilon)}

    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:

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

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

    Example:
        >>> from torchmetrics.regression import SymmetricMeanAbsolutePercentageError
        >>> target = tensor([1, 10, 1e6])
        >>> preds = tensor([0.9, 15, 1.2e6])
        >>> smape = SymmetricMeanAbsolutePercentageError()
        >>> smape(preds, target)
        tensor(0.2290)

    Tis_differentiableFhigher_is_betterfull_state_update        plot_lower_boundg       @plot_upper_boundsum_abs_per_errortotalkwargsreturnNc                     t        |   di | | j                  dt        d      d       | j                  dt        d      d       y )Nr   r   sum)defaultdist_reduce_fxr    )super__init__	add_stater   )selfr   	__class__s     {/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/regression/symmetric_mape.pyr!   z-SymmetricMeanAbsolutePercentageError.__init__E   sC     	"6"*F3KPUVwsEJ    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   num_obss        r%   updatez+SymmetricMeanAbsolutePercentageError.updateN   s6    %UV[]c%d"7"33

g
r&   c                 B    t        | j                  | j                        S )z2Compute mean absolute percentage error over state.)r	   r   r   )r#   s    r%   computez,SymmetricMeanAbsolutePercentageError.computeU   s    @AWAWY]YcYcddr&   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 SymmetricMeanAbsolutePercentageError
            >>> metric = SymmetricMeanAbsolutePercentageError()
            >>> 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 SymmetricMeanAbsolutePercentageError
            >>> metric = SymmetricMeanAbsolutePercentageError()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )_plot)r#   r.   r/   s      r%   plotz)SymmetricMeanAbsolutePercentageError.plotY   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   r   r2   __classcell__)r$   s   @r%   r   r      s    8 #t""d"#t#!e!!e!MKK 
KF F t e e
 _c(#E&(6*:":;<(#IQRZI[(#	(#r&   r   N)collections.abcr   typingr   r   r   torchr   r   1torchmetrics.functional.regression.symmetric_maper	   r
   torchmetrics.metricr   torchmetrics.utilities.importsr   torchmetrics.utilities.plotr   r   __doctest_skip__r   r   r&   r%   <module>rC      s=    % ' '   ' @ @CDb#6 b#r&   