Ë
    ýÿæip  ã                   óŒ   — d dl mZ d dl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sdgZ G d	„ d
e«      Zy)é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensorÚtensor)Ú_mean_squared_log_error_computeÚ_mean_squared_log_error_update)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzMeanSquaredLogError.plotc                   óÎ   ‡ — 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
<   deddfˆ fd„Zdededdfd„Zdefd„Z	 ddeeeee   f      dee   defd„Zˆ x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)

    .. attention::
        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ÚtotalÚkwargsÚreturnNc                 ó˜   •— t        ‰| �  di |¤Ž | j                  dt        d«      d¬«       | j                  dt        d«      d¬«       y )Nr   r   Úsum)ÚdefaultÚdist_reduce_fxr   r   © )ÚsuperÚ__init__Ú	add_stater   )Úselfr   Ú	__class__s     €út/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/regression/log_mse.pyr    zMeanSquaredLogError.__init__E   sC   ø€ ô 	‰ÑÑ"˜6Ò"à�‰Ð.¼¸s»ÐTYˆÔZØ�‰�w¬¨q«	À%ˆÕHó    ÚpredsÚtargetc                 óv   — t        ||«      \  }}| xj                  |z  c_        | xj                  |z  c_        y)z*Update state with predictions and targets.N)r
   r   r   )r"   r&   r'   r   Únum_obss        r$   ÚupdatezMeanSquaredLogError.updateN   s4   € ä)GÈÈvÓ)VÑ&Ð˜wà×"Ò"Ð&;Ñ;Õ"Ø�
Š
�gÑŽ
r%   c                 óB   — t        | j                  | j                  «      S )z2Compute mean squared logarithmic error over state.)r	   r   r   )r"   s    r$   ÚcomputezMeanSquaredLogError.computeU   s   € ä.¨t×/IÑ/IÈ4Ï:É:ÓVÐVr%   ÚvalÚaxc                 ó&   — | j                  ||«      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)

        )Ú_plot)r"   r-   r.   s      r$   ÚplotzMeanSquaredLogError.plotY   s   € ðP �z‰z˜#˜rÓ"Ð"r%   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   r    r*   r,   r   r   r   r   r   r1   Ú__classcell__)r#   s   @r$   r   r      sÂ   ø… ñð@ #Ð�tÓ"Ø"Ð�dÓ"Ø#Ð�tÓ#Ø!Ð�eÓ!à!Ó!ØƒMðIàðIð 
õIð˜Fð ¨Fð °tó ðW˜ó Wð
 _cñ(#Ø˜E &¨(°6Ñ*:Ð":Ñ;Ñ<ð(#ØIQÐRZÑI[ð(#à	÷(#r%   r   N)Úcollections.abcr   Útypingr   r   r   Útorchr   r   Ú*torchmetrics.functional.regression.log_mser	   r
   Útorchmetrics.metricr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r   r%   r$   Ú<module>rB      s9   ðõ %ß 'Ñ 'ç  ç vÝ &Ý @ß @áØ2Ð3Ðôe#˜&õ e#r%   