o .wi@sddlmZddlmZmZmZddlmZmZddl m Z m Z ddl m Z ddlmZddlmZmZes9dgZGd d d e Zd S) )Sequence)AnyOptionalUnion)Tensortensor)1_symmetric_mean_absolute_percentage_error_compute0_symmetric_mean_absolute_percentage_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPE)SymmetricMeanAbsolutePercentageError.plotcseZdZUdZdZeed<dZeed<dZeed<dZ e ed<d Z e ed <e ed <e ed <d e ddffdd Zde de ddfddZde fddZ ddeee ee fdeedefddZZS)$SymmetricMeanAbsolutePercentageErroraGCompute 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) Tis_differentiableFhigher_is_betterfull_state_updateplot_lower_boundg@plot_upper_boundsum_abs_per_errortotalkwargsreturnNc s>tjdi||jdtddd|jdtddddS)Nrrsum)defaultdist_reduce_fxr)super__init__ add_stater)selfr __class__rc/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/regression/symmetric_mape.pyrEsz-SymmetricMeanAbsolutePercentageError.__init__predstargetcCs.t||\}}|j|7_|j|7_dS)z*Update state with predictions and targets.N)r rr)r!r%r&rnum_obsrrr$updateNsz+SymmetricMeanAbsolutePercentageError.updatecCst|j|jS)z2Compute mean absolute percentage error over state.)rrr)r!rrr$computeUsz,SymmetricMeanAbsolutePercentageError.computevalaxcCs |||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+rrr$plotYs (r)NN)__name__ __module__ __qualname____doc__rbool__annotations__rrrfloatrrrrr(r)rrrr r r- __classcell__rrr"r$rs0       rN)collections.abcrtypingrrrtorchrr1torchmetrics.functional.regression.symmetric_maperr torchmetrics.metricr torchmetrics.utilities.importsr torchmetrics.utilities.plotr r __doctest_skip__rrrrr$s