class_docstr: `Scale-invariant signal-to-distortion ratio`_ (SI-SDR).
  
  The SI-SDR value is in general considered an overall measure of how good a source sound.
  
  As input to `forward` and `update` the metric accepts the following input
  
  - ``preds`` (:class:`~torch.Tensor`): float tensor with shape ``(...,time)``
  - ``target`` (:class:`~torch.Tensor`): float tensor with shape ``(...,time)``
  
  As output of `forward` and `compute` the metric returns the following output
  
  - ``si_sdr`` (:class:`~torch.Tensor`): float scalar tensor with average SI-SDR value over samples
  
  Args:
      zero_mean: if to zero mean target and preds or not
      kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.
  
  Raises:
      TypeError:
          if target and preds have a different shape
  
  Example:
      >>> from torch import tensor
      >>> from torchmetrics.audio import ScaleInvariantSignalDistortionRatio
      >>> target = tensor([3.0, -0.5, 2.0, 7.0])
      >>> preds = tensor([2.5, 0.0, 2.0, 8.0])
      >>> si_sdr = ScaleInvariantSignalDistortionRatio()
      >>> si_sdr(preds, target)
      tensor(18.4030)
class_docstr_tok: ["`","Scale-invariant","signal-to-distortion","ratio","`","_","(","SI-SDR",")",".","The","SI-SDR","value","is","in","general","considered","an","overall","measure","of","how","good","a","source","sound",".","As","input","to","`","forward","`","and","`","update","`","the","metric","accepts","the","following","input","-","``","preds","``","(",":","class",":","`","~torch.Tensor","`",")",":","float","tensor","with","shape","``","(","...",",","time",")","``","-","``","target","``","(",":","class",":","`","~torch.Tensor","`",")",":","float","tensor","with","shape","``","(","...",",","time",")","``","As","output","of","`","forward","`","and","`","compute","`","the","metric","returns","the","following","output","-","``","si_sdr","``","(",":","class",":","`","~torch.Tensor","`",")",":","float","scalar","tensor","with","average","SI-SDR","value","over","samples","Args",":","zero_mean",":","if","to","zero","mean","target","and","preds","or","not","kwargs",":","Additional","keyword","arguments",",","see",":","ref",":","`","Metric","kwargs","`","for","more","info",".","Raises",":","TypeError",":","if","target","and","preds","have","a","different","shape","Example",":",">",">",">","from","torch","import","tensor",">",">",">","from","torchmetrics.audio","import","ScaleInvariantSignalDistortionRatio",">",">",">","target","=","tensor","(","[","3.0",",","-0.5",",","2.0",",","7.0","]",")",">",">",">","preds","=","tensor","(","[","2.5",",","0.0",",","2.0",",","8.0","]",")",">",">",">","si_sdr","=","ScaleInvariantSignalDistortionRatio","(",")",">",">",">","si_sdr","(","preds",",","target",")","tensor","(","18.4030",")"]
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
  
      >>> # Example plotting a single value
      >>> import torch
      >>> from torchmetrics.audio import ScaleInvariantSignalDistortionRatio
      >>> target = torch.randn(5)
      >>> preds = torch.randn(5)
      >>> metric = ScaleInvariantSignalDistortionRatio()
      >>> metric.update(preds, target)
      >>> fig_, ax_ = metric.plot()
  
  .. plot::
      :scale: 75
  
      >>> # Example plotting multiple values
      >>> import torch
      >>> from torchmetrics.audio import ScaleInvariantSignalDistortionRatio
      >>> target = torch.randn(5)
      >>> preds = torch.randn(5)
      >>> metric = ScaleInvariantSignalDistortionRatio()
      >>> values = [ ]
      >>> for _ in range(10):
      ...     values.append(metric(preds, target))
      >>> 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",">",">",">","#","Example","plotting","a","single","value",">",">",">","import","torch",">",">",">","from","torchmetrics.audio","import","ScaleInvariantSignalDistortionRatio",">",">",">","target","=","torch.randn","(","5",")",">",">",">","preds","=","torch.randn","(","5",")",">",">",">","metric","=","ScaleInvariantSignalDistortionRatio","(",")",">",">",">","metric.update","(","preds",",","target",")",">",">",">","fig_",",","ax_","=","metric.plot","(",")","..","plot",":",":",":","scale",":","75",">",">",">","#","Example","plotting","multiple","values",">",">",">","import","torch",">",">",">","from","torchmetrics.audio","import","ScaleInvariantSignalDistortionRatio",">",">",">","target","=","torch.randn","(","5",")",">",">",">","preds","=","torch.randn","(","5",")",">",">",">","metric","=","ScaleInvariantSignalDistortionRatio","(",")",">",">",">","values","=","[","]",">",">",">","for","_","in","range","(","10",")",":","...","values.append","(","metric","(","preds",",","target",")",")",">",">",">","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
  
          >>> # Example plotting a single value
          >>> import torch
          >>> from torchmetrics.audio import ScaleInvariantSignalDistortionRatio
          >>> target = torch.randn(5)
          >>> preds = torch.randn(5)
          >>> metric = ScaleInvariantSignalDistortionRatio()
          >>> metric.update(preds, target)
          >>> fig_, ax_ = metric.plot()
  
      .. plot::
          :scale: 75
  
          >>> # Example plotting multiple values
          >>> import torch
          >>> from torchmetrics.audio import ScaleInvariantSignalDistortionRatio
          >>> target = torch.randn(5)
          >>> preds = torch.randn(5)
          >>> metric = ScaleInvariantSignalDistortionRatio()
          >>> values = [ ]
          >>> for _ in range(10):
          ...     values.append(metric(preds, target))
          >>> fig_, ax_ = metric.plot(values)
  
      """
      return self._plot(val, ax)
  
imports: from typing import Any, Optional, Sequence, Union
  from torch import Tensor, tensor
  from torchmetrics.functional.audio.sdr import scale_invariant_signal_distortion_ratio, signal_distortion_ratio, source_aggregated_signal_distortion_ratio
  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 ScaleInvariantSignalDistortionRatio obj's underlying member method code with example usage: obj.plot(val, ax) and returns: self