a
    d                     @   s   d dl mZmZmZmZ d dlZd dl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sndgZG d	d
 d
eZdS )    )AnyOptionalSequenceUnionN)Tensor)_tweedie_deviance_score_compute_tweedie_deviance_score_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPETweedieDevianceScore.plotc                       s   e Zd ZU dZdZeed< dZdZeed< dZ	e
ed< eed	< eed
< de
edd fddZeeddddZedddZdeeeee f  ee edddZ  ZS )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)

    Tis_differentiableNFfull_state_update        plot_lower_boundsum_deviance_scorenum_observations)powerkwargsreturnc                    sp   t  jf i | d|  k r&dk r:n ntd| d|| _| jdtddd | jd	tddd d S )
Nr      z(Deviance Score is not defined for power=.r   r   sum)Zdist_reduce_fxr   )super__init__
ValueErrorr   Z	add_statetorchZtensor)selfr   r   	__class__ q/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/regression/tweedie_deviance.pyr   V   s    zTweedieDevianceScore.__init__)predstargetsr   c                 C   s2   t ||| j\}}|  j|7  _|  j|7  _dS )z2Update metric states with predictions and targets.N)r   r   r   r   )r   r$   r%   r   r   r"   r"   r#   updated   s    zTweedieDevianceScore.update)r   c                 C   s   t | j| jS )zCompute metric.)r   r   r   )r   r"   r"   r#   computek   s    zTweedieDevianceScore.compute)valaxr   c                 C   s   |  ||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 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)

        )Z_plot)r   r(   r)   r"   r"   r#   ploto   s    (r   )r   )NN)__name__
__module____qualname____doc__r   bool__annotations__Zhigher_is_betterr   r   floatr   r   r   r&   r'   r   r   r   r   r   r*   __classcell__r"   r"   r    r#   r      s(   
.  r   )typingr   r   r   r   r   r   Z3torchmetrics.functional.regression.tweedie_deviancer   r   Ztorchmetrics.metricr	   Ztorchmetrics.utilities.importsr
   Ztorchmetrics.utilities.plotr   r   Z__doctest_skip__r   r"   r"   r"   r#   <module>   s   