i@ddlmZddlmZmZmZddlZddlmZddlm Z m Z ddl m Z ddl mZddlmZmZesd gZGd d e Zy) )Sequence)AnyOptionalUnionN)Tensor)_log_cosh_error_compute_log_cosh_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEzLogCoshError.plotceZdZUdZdZdZdZdZee d<e e d<e e d<dde d e d d ffd Z d e de d d fdZd e fdZ ddeee ee fdeed efdZxZS) LogCoshErroraOCompute 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]) TFgplot_lower_boundsum_log_cosh_errortotal num_outputskwargsreturnNc t|di|t|ts|dkrt d|||_|j dtj|d|j dtjddy) NzDExpected argument `num_outputs` to be an int larger than 0, but got rsum)defaultdist_reduce_fxrr) super__init__ isinstanceint ValueErrorr add_statetorchzerostensor)selfrr __class__s u/Volumes/fast/ai/experiments/voice-extract-mac/.venv/lib/python3.12/site-packages/torchmetrics/regression/log_cosh.pyrzLogCoshError.__init__Msw "6"+s+ acdocpqr r& +U[[5M^cd w QNpredstargetct|||j\}}|xj|z c_|xj|z c_y)zUpdate state with predictions and targets. Raises: ValueError: If ``preds`` or ``target`` has multiple outputs when ``num_outputs=1`` N)r rrr)r%r)r*rnum_obss r'updatezLogCoshError.updateVs>'=UFDL\L\&]#G #55 g r(cBt|j|jS)z!Compute LogCosh error over state.)rrr)r%s r'computezLogCoshError.computebs&t'>'> KKr(valaxc&|j||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 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%r0r1s r'plotzLogCoshError.plotfsPzz#r""r()r)NN)__name__ __module__ __qualname____doc__is_differentiablehigher_is_betterfull_state_updaterfloat__annotations__rrrrr-r/rrrr r r4 __classcell__)r&s@r'rrs%N!e! MOCOsOtO F F t LL _c(#E&(6*:":;<(#IQRZI[(# (#r(r)collections.abcrtypingrrrr"r+torchmetrics.functional.regression.log_coshrr torchmetrics.metricr torchmetrics.utilities.importsr torchmetrics.utilities.plotr r __doctest_skip__rrr(r'rFs<%'' g&@@+,q#6q#r(