o .wi@sddlmZddlmZmZmZddlZddlmZmZddl m Z m Z ddl m Z ddlmZddlmZmZes=d gZGd d d e ZdS) )Sequence)AnyOptionalUnionN)Tensortensor)_mean_squared_error_compute_mean_squared_error_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEMeanSquaredError.plotc seZdZUdZdZdZdZdZee d<e e d<e e d<  dd e d e d e d d ffdd Zde de d d fddZd e fddZ ddeee ee fdeed efddZZS)MeanSquaredErrora`Compute `mean squared error`_ (MSE). .. math:: \text{MSE} = \frac{1}{N}\sum_i^N(y_i - \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_error`` (:class:`~torch.Tensor`): A tensor with the mean squared error Args: squared: If True returns MSE value, if False returns RMSE value. num_outputs: Number of outputs in multioutput setting kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info. Example:: Single output mse computation: >>> from torch import tensor >>> from torchmetrics.regression import MeanSquaredError >>> target = tensor([2.5, 5.0, 4.0, 8.0]) >>> preds = tensor([3.0, 5.0, 2.5, 7.0]) >>> mean_squared_error = MeanSquaredError() >>> mean_squared_error(preds, target) tensor(0.8750) Example:: Multioutput mse computation: >>> from torch import tensor >>> from torchmetrics.regression import MeanSquaredError >>> target = tensor([[0.0, 0.0, 0.0], [0.0, 0.0, 0.0]]) >>> preds = tensor([[1.0, 2.0, 3.0], [1.0, 2.0, 3.0]]) >>> mean_squared_error = MeanSquaredError(num_outputs=3) >>> mean_squared_error(preds, target) tensor([1., 4., 9.]) TFgplot_lower_boundsum_squared_errortotalsquared num_outputskwargsreturnNc stjdi|t|tstd|||_t|tr!|dks(td|||_|jdt |dd|jdt ddddS) Nz4Expected argument `squared` to be a boolean but got rz6Expected num_outputs to be a positive integer but got rsum)defaultdist_reduce_fxr) super__init__ isinstancebool ValueErrorrintr add_statetorchzerosr)selfrrr __class__rX/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/regression/mse.pyrRs zMeanSquaredError.__init__predstargetcCs4t|||jd\}}|j|7_|j|7_dS)z*Update state with predictions and targets.)rN)r rrr)r%r)r*rnum_obsrrr(updateeszMeanSquaredError.updatecCst|j|j|jdS)z&Compute mean squared error over state.)r)rrrr)r%rrr(computelszMeanSquaredError.computevalaxcCs |||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 MeanSquaredError >>> metric = MeanSquaredError() >>> 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 MeanSquaredError >>> metric = MeanSquaredError() >>> values = [] >>> for _ in range(10): ... values.append(metric(randn(10,), randn(10,))) >>> fig, ax = metric.plot(values) )_plot)r%r.r/rrr(plotps (r)Tr)NN)__name__ __module__ __qualname____doc__is_differentiablehigher_is_betterfull_state_updaterfloat__annotations__rrr!rrr,r-rrrr r r1 __classcell__rrr&r(rs: , r)collections.abcrtypingrrrr#rr&torchmetrics.functional.regression.mserr torchmetrics.metricr torchmetrics.utilities.importsr torchmetrics.utilities.plotr r __doctest_skip__rrrrr(s