a
    dJ                     @   s~   d dl mZmZmZm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sjdgZG dd	 d	eZd
S )    )AnyOptionalSequenceUnion)Tensortensor)_mean_squared_log_error_compute_mean_squared_log_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEMeanSquaredLogError.plotc                       s   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
< 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 )MeanSquaredLogErrora  Compute `mean squared logarithmic error`_ (MSLE).

    .. math:: \text{MSLE} = \frac{1}{N}\sum_i^N (\log_e(1 + y_i) - \log_e(1 + \hat{y_i}))^2

    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_squared_log_error`` (:class:`~torch.Tensor`): A tensor with the mean squared log error

    Args:
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example:
        >>> from torch import tensor
        >>> from torchmetrics.regression import MeanSquaredLogError
        >>> target = tensor([2.5, 5, 4, 8])
        >>> preds = tensor([3, 5, 2.5, 7])
        >>> mean_squared_log_error = MeanSquaredLogError()
        >>> mean_squared_log_error(preds, target)
        tensor(0.0397)

    .. note::
        Half precision is only support on GPU for this metric

    Tis_differentiableFhigher_is_betterfull_state_update        plot_lower_boundsum_squared_log_errortotalN)kwargsreturnc                    s>   t  jf i | | jdtddd | jdtddd d S )Nr   r   sum)defaultZdist_reduce_fxr   r   )super__init__Z	add_stater   )selfr   	__class__ h/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/regression/log_mse.pyr   C   s    zMeanSquaredLogError.__init__)predstargetr   c                 C   s.   t ||\}}|  j|7  _|  j|7  _dS )z*Update state with predictions and targets.N)r	   r   r   )r   r"   r#   r   Zn_obsr    r    r!   updateL   s    zMeanSquaredLogError.update)r   c                 C   s   t | j| jS )z2Compute mean squared logarithmic error over state.)r   r   r   )r   r    r    r!   computeS   s    zMeanSquaredLogError.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 MeanSquaredLogError
            >>> metric = MeanSquaredLogError()
            >>> 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 MeanSquaredLogError
            >>> metric = MeanSquaredLogError()
            >>> 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!   plotW   s    (r   )NN)__name__
__module____qualname____doc__r   bool__annotations__r   r   r   floatr   r   r   r$   r%   r   r   r   r   r   r(   __classcell__r    r    r   r!   r      s"   
	 r   N)typingr   r   r   r   Ztorchr   r   Z*torchmetrics.functional.regression.log_mser   r	   Ztorchmetrics.metricr
   Ztorchmetrics.utilities.importsr   Ztorchmetrics.utilities.plotr   r   Z__doctest_skip__r   r    r    r    r!   <module>   s   