o .wi@sddlmZddlmZmZmZddlZddlmZddlm Z m Z ddl m Z ddl mZddlmZmZes;d gZGd d d e ZdS) )Sequence)AnyOptionalUnionN)Tensor)_tweedie_deviance_score_compute_tweedie_deviance_score_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPETweedieDevianceScore.plotcseZdZUdZdZeed<dZdZeed<dZ e ed<e ed <e ed < dd e d e d dffdd Z de de d dfddZd e fddZ ddeee ee fdeed efddZZS)TweedieDevianceScorea]Compute the `Tweedie Deviance Score`_. .. math:: deviance\_score(\hat{y},y) = \begin{cases} (\hat{y} - y)^2, & \text{for }p=0\\ 2 * (y * log(\frac{y}{\hat{y}}) + \hat{y} - y), & \text{for }p=1\\ 2 * (log(\frac{\hat{y}}{y}) + \frac{y}{\hat{y}} - 1), & \text{for }p=2\\ 2 * (\frac{(max(y,0))^{2 - p}}{(1 - p)(2 - p)} - \frac{y(\hat{y})^{1 - p}}{1 - p} + \frac{( \hat{y})^{2 - p}}{2 - p}), & \text{otherwise} \end{cases} where :math:`y` is a tensor of targets values, :math:`\hat{y}` is a tensor of predictions, and :math:`p` is the `power`. As input to ``forward`` and ``update`` the metric accepts the following input: - ``preds`` (:class:`~torch.Tensor`): Predicted float tensor with shape ``(N,...)`` - ``target`` (:class:`~torch.Tensor`): Ground truth float tensor with shape ``(N,...)`` As output of ``forward`` and ``compute`` the metric returns the following output: - ``deviance_score`` (:class:`~torch.Tensor`): A tensor with the deviance score Args: power: - power < 0 : Extreme stable distribution. (Requires: preds > 0.) - power = 0 : Normal distribution. (Requires: targets and preds can be any real numbers.) - power = 1 : Poisson distribution. (Requires: targets >= 0 and y_pred > 0.) - 1 < p < 2 : Compound Poisson distribution. (Requires: targets >= 0 and preds > 0.) - power = 2 : Gamma distribution. (Requires: targets > 0 and preds > 0.) - power = 3 : Inverse Gaussian distribution. (Requires: targets > 0 and preds > 0.) - otherwise : Positive stable distribution. (Requires: targets > 0 and preds > 0.) kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info. Example: >>> from torchmetrics.regression import TweedieDevianceScore >>> targets = torch.tensor([1.0, 2.0, 3.0, 4.0]) >>> preds = torch.tensor([4.0, 3.0, 2.0, 1.0]) >>> deviance_score = TweedieDevianceScore(power=2) >>> deviance_score(preds, targets) tensor(1.2083) Tis_differentiableNFfull_state_updateplot_lower_boundsum_deviance_scorenum_observationspowerkwargsreturnc sptjd i|d|krdkrnntd|d||_|jdtddd|jd tddddS) Nrz(Deviance Score is not defined for power=.rrsum)dist_reduce_fxr)super__init__ ValueErrorr add_statetorchtensor)selfrr __class__re/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/regression/tweedie_deviance.pyrXs zTweedieDevianceScore.__init__predstargetscCs2t|||j\}}|j|7_|j|7_dS)z2Update metric states with predictions and targets.N)rrrr)r#r'r(rrrrr&updatefszTweedieDevianceScore.updatecCst|j|jS)zCompute metric.)rrr)r#rrr&computemszTweedieDevianceScore.computevalaxcCs |||S)aPlot 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 TweedieDevianceScore >>> metric = TweedieDevianceScore() >>> 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 TweedieDevianceScore >>> metric = TweedieDevianceScore() >>> values = [] >>> for _ in range(10): ... values.append(metric(randn(10,), randn(10,))) >>> fig, ax = metric.plot(values) )_plot)r#r+r,rrr&plotqs (r )r)NN)__name__ __module__ __qualname____doc__rbool__annotations__higher_is_betterrrfloatrrrr)r*rrrr r r. __classcell__rrr$r&r s4  /  r)collections.abcrtypingrrrr!r3torchmetrics.functional.regression.tweedie_deviancerrtorchmetrics.metricr torchmetrics.utilities.importsr torchmetrics.utilities.plotr r __doctest_skip__rrrrr&s