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",")"]
code: def __init__(
      self,
      zero_mean: bool = False,
      **kwargs: Any,
  ) -> None:
      super().__init__(**kwargs)
      self.zero_mean = zero_mean
  
      self.add_state(
          "sum_si_sdr", default=tensor(0.0), dist_reduce_fx="sum"
      )
      self.add_state("total", default=tensor(0), dist_reduce_fx="sum")
  
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 1 to create a new ScaleInvariantSignalDistortionRatio object from inherited base classes: Metric with example: obj = ScaleInvariantSignalDistortionRatio(zero_mean)