class_docstr: 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.])
class_docstr_tok: ["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",".","]",")"]
docstr: 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 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)
docstr_tok: ["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","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",")"]
code: def plot(
      self,
      val: Optional[Union[Tensor, Sequence[Tensor]]] = None,
      ax: Optional[_AX_TYPE] = None,
  ) -> _PLOT_OUT_TYPE:
      """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 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)
  
      """
      return self._plot(val, ax)
  
file_path: torchmetrics/src/torchmetrics/regression/mse.py
imports: from typing import Any, Optional, Sequence, Union
  import torch
  from torch import Tensor, tensor
  from torchmetrics.functional.regression.mse import _mean_squared_error_compute, _mean_squared_error_update
  from torchmetrics.metric import Metric
  from torchmetrics.utilities.imports import _MATPLOTLIB_AVAILABLE
  from torchmetrics.utilities.plot import _AX_TYPE, _PLOT_OUT_TYPE
label_desc: Use image node_id 4 for calling the MeanSquaredError obj's underlying member method code with example usage: obj.plot(val, ax) and returns: self