o
    yi                     @   sP   d dl mZ d dlZd dlmZ d dlmZmZ d dlmZ G dd deZ	dS )    )AnyN)Tensor)0_weighted_mean_absolute_percentage_error_compute/_weighted_mean_absolute_percentage_error_update)Metricc                       s   e Zd ZU dZ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  ZS )#WeightedMeanAbsolutePercentageErrora  Computes 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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   g        sum)defaultdist_reduce_fxr    )super__init__	add_statetorchtensor)selfr   	__class__r   Q/home/ubuntu/.local/lib/python3.10/site-packages/torchmetrics/regression/wmape.pyr   >   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   updateC   s   z*WeightedMeanAbsolutePercentageError.updatec                 C   s   t | j| jS )z<Computes weighted mean absolute percentage error over state.)r   r   r   )r   r   r   r   computeJ   s   z+WeightedMeanAbsolutePercentageError.compute)__name__
__module____qualname____doc__r   bool__annotations__r	   r
   r   r   r   r   r   __classcell__r   r   r   r   r      s   
 r   )
typingr   r   r   (torchmetrics.functional.regression.wmaper   r   torchmetrics.metricr   r   r   r   r   r   <module>   s   