§
    ’©ºj@  ã                   ó˜   — d dl mZ d dl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sd	gZ G d
„ de¦  «        ZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnionN)ÚTensor)Ú_log_cosh_error_computeÚ_log_cosh_error_update)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzLogCoshError.plotc                   óÎ   ‡ — e Zd ZU dZdZdZdZdZee	d<   e
e	d<   e
e	d<   dd	e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 )ÚLogCoshErroraO  Compute the `LogCosh Error`_.

    .. math:: \text{LogCoshError} = \log\left(\frac{\exp(\hat{y} - y) + \exp(\hat{y - y})}{2}\right)

    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`): Estimated labels with shape ``(batch_size,)``
      or ``(batch_size, num_outputs)``
    - ``target`` (:class:`~torch.Tensor`): Ground truth labels with shape ``(batch_size,)``
      or ``(batch_size, num_outputs)``

    As output of ``forward`` and ``compute`` the metric returns the following output:

    - ``log_cosh_error`` (:class:`~torch.Tensor`): A tensor with the log cosh error

    Args:
        num_outputs: Number of outputs in multioutput setting
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example (single output regression)::
        >>> from torchmetrics.regression import LogCoshError
        >>> preds = torch.tensor([3.0, 5.0, 2.5, 7.0])
        >>> target = torch.tensor([2.5, 5.0, 4.0, 8.0])
        >>> log_cosh_error = LogCoshError()
        >>> log_cosh_error(preds, target)
        tensor(0.3523)

    Example (multi output regression)::
        >>> from torchmetrics.regression import LogCoshError
        >>> preds = torch.tensor([[3.0, 5.0, 1.2], [-2.1, 2.5, 7.0]])
        >>> target = torch.tensor([[2.5, 5.0, 1.3], [0.3, 4.0, 8.0]])
        >>> log_cosh_error = LogCoshError(num_outputs=3)
        >>> log_cosh_error(preds, target)
        tensor([0.9176, 0.4277, 0.2194])

    TFg        Úplot_lower_boundÚsum_log_cosh_errorÚtotalé   Únum_outputsÚkwargsÚreturnNc                 óJ  •—  t          ¦   «         j        di |¤Ž t          |t          ¦  «        s|dk     rt	          d|› �¦  «        ‚|| _        |                      dt          j        |¦  «        d¬¦  «         |                      dt          j	        d¦  «        d¬¦  «         d S )	Nr   zDExpected argument `num_outputs` to be an int larger than 0, but got r   Úsum)ÚdefaultÚdist_reduce_fxr   r   © )
ÚsuperÚ__init__Ú
isinstanceÚintÚ
ValueErrorr   Ú	add_stateÚtorchÚzerosÚtensor)Úselfr   r   Ú	__class__s      €úp/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/regression/log_cosh.pyr   zLogCoshError.__init__M   s¥   ø€ Ø�‰ŒÔÐ"Ð"˜6Ð"Ð"Ð"å˜+¥sÑ+Ô+ð 	s°¸a²°ÝÐqÐdoÐqÐqÑrÔrÐrØ&ˆÔØ�ŠÐ+µU´[ÀÑ5MÔ5MÐ^cˆÑdÔdÐdØ�Š�w­¬°Q©¬ÈˆÑNÔNÐNÐNÐNó    ÚpredsÚtargetc                 óx   — t          ||| j        ¦  «        \  }}| xj        |z  c_        | xj        |z  c_        dS )z´Update state with predictions and targets.

        Raises:
            ValueError:
                If ``preds`` or ``target`` has multiple outputs when ``num_outputs=1``

        N)r	   r   r   r   )r%   r)   r*   r   Únum_obss        r'   ÚupdatezLogCoshError.updateV   sG   € õ '=¸UÀFÈDÔL\Ñ&]Ô&]Ñ#Ð˜GØÐÔÐ#5Ñ5ÐÔØˆ
Œ
�gÑˆ
Œ
ˆ
ˆ
r(   c                 ó6   — t          | j        | j        ¦  «        S )z!Compute LogCosh error over state.)r   r   r   )r%   s    r'   ÚcomputezLogCoshError.computeb   s   € å& tÔ'>ÀÄ
ÑKÔKÐKr(   ÚvalÚaxc                 ó.   — |                       ||¦  «        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 LogCoshError
            >>> metric = LogCoshError()
            >>> 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 LogCoshError
            >>> metric = LogCoshError()
            >>> values = []
            >>> for _ in range(10):
            ...     values.append(metric(randn(10,), randn(10,)))
            >>> fig, ax = metric.plot(values)

        )Ú_plot)r%   r0   r1   s      r'   ÚplotzLogCoshError.plotf   s   € ðP �zŠz˜#˜rÑ"Ô"Ð"r(   )r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__Úis_differentiableÚhigher_is_betterÚfull_state_updater   ÚfloatÚ__annotations__r   r   r   r   r-   r/   r   r   r   r   r   r4   Ú__classcell__)r&   s   @r'   r   r      sC  ø€ € € € € € ð%ð %ðN ÐØÐØÐØ!Ð�eÐ!Ð!Ñ!àÐÐÑØ€M€M�MðOð O Cð O°sð O¸tð Oð Oð Oð Oð Oð Oð
˜Fð 
¨Fð 
°tð 
ð 
ð 
ð 
ðL˜ð Lð Lð Lð Lð
 _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r(   r   )Úcollections.abcr   Útypingr   r   r   r"   r   Ú+torchmetrics.functional.regression.log_coshr   r	   Útorchmetrics.metricr
   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r   r(   r'   ú<module>rF      sõ   ðð %Ð $Ð $Ð $Ð $Ð $Ø 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'à €€€Ø Ð Ð Ð Ð Ð à gÐ gÐ gÐ gÐ gÐ gÐ gÐ gØ &Ð &Ð &Ð &Ð &Ð &Ø @Ð @Ð @Ð @Ð @Ð @Ø @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð -Ø+Ð,Ððq#ð q#ð q#ð q#ð q#�6ñ q#ô q#ð q#ð q#ð q#r(   