
    i                         d dl mZ d dlmZmZmZ d dl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UnionN)Tensortensor)_mean_absolute_error_compute_mean_absolute_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEzMeanAbsoluteError.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de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 )MeanAbsoluteErrora
  `Compute Mean Absolute Error`_ (MAE).

    .. math:: \text{MAE} = \frac{1}{N}\sum_i^N | y_i - \hat{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_absolute_error`` (:class:`~torch.Tensor`): A tensor with the mean absolute error over the state

    Args:
        num_outputs: Number of outputs in multioutput setting
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example:
        >>> from torch import tensor
        >>> from torchmetrics.regression import MeanAbsoluteError
        >>> target = tensor([3.0, -0.5, 2.0, 7.0])
        >>> preds = tensor([2.5, 0.0, 2.0, 8.0])
        >>> mean_absolute_error = MeanAbsoluteError()
        >>> mean_absolute_error(preds, target)
        tensor(0.5000)

    Example::
        Multioutput mse computation:

        >>> from torch import tensor
        >>> from torchmetrics.regression import MeanAbsoluteError
        >>> target = tensor([[0.0, 0.0, 0.0], [0.0, 0.0, 0.0]])
        >>> preds = tensor([[1.0, 2.0, 3.0], [1.0, 2.0, 3.0]])
        >>> mean_absolute_error = MeanAbsoluteError(num_outputs=3)
        >>> mean_absolute_error(preds, target)
        tensor([1., 2., 3.])

    Tis_differentiableFhigher_is_betterfull_state_updateg        plot_lower_boundsum_abs_errortotalnum_outputskwargsreturnNc                     t        |   di | t        |t              r|dkD  st	        d|       || _        | j                  dt        j                  |      d       | j                  dt        d      d       y )Nr   z6Expected num_outputs to be a positive integer but got r   sum)defaultdist_reduce_fxr    )
super__init__
isinstanceint
ValueErrorr   	add_statetorchzerosr   )selfr   r   	__class__s      p/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/regression/mae.pyr    zMeanAbsoluteError.__init__O   st    
 	"6";,qUVaUbcdd&K0HY^_wq	%H    predstargetc                     t        ||| j                        \  }}| xj                  |z  c_        | xj                  |z  c_        y)z*Update state with predictions and targets.)r   N)r
   r   r   r   )r'   r+   r,   r   num_obss        r)   updatezMeanAbsoluteError.update]   s;    !<UFX\XhXh!iwm+

g
r*   c                 B    t        | j                  | j                        S )z'Compute mean absolute error over state.)r	   r   r   )r'   s    r)   computezMeanAbsoluteError.computed   s    +D,>,>

KKr*   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 MeanAbsoluteError
            >>> metric = MeanAbsoluteError()
            >>> 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 MeanAbsoluteError
            >>> metric = MeanAbsoluteError()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )_plot)r'   r2   r3   s      r)   plotzMeanAbsoluteError.ploth   s    P zz#r""r*   )   )NN)__name__
__module____qualname____doc__r   bool__annotations__r   r   r   floatr   r"   r   r    r/   r1   r   r   r   r   r   r6   __classcell__)r(   s   @r)   r   r      s    'R #t""d"#t#!e!M II I 
	IF F t L L
 _c(#E&(6*:":;<(#IQRZI[(#	(#r*   r   )collections.abcr   typingr   r   r   r%   r   r   &torchmetrics.functional.regression.maer	   r
   torchmetrics.metricr   torchmetrics.utilities.importsr   torchmetrics.utilities.plotr   r   __doctest_skip__r   r   r*   r)   <module>rG      s<    % ' '    l & @ @01s# s#r*   