{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "f341fb11f7f5d77a4974ba8273c4cd55d67c21f0",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "# SNR Metrics API\n\nSignal-to-Noise Ratio (SNR) metric where y_true: signal, y_pred: signal + noise\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `Snr` | Computes the Signal-to-Noise Ratio (SNR) in dB. |",
      "name": "snr",
      "path": "helia_edge.metrics.snr",
      "submodules": [],
      "summary": "SNR Metrics API",
      "symbols": [
        {
          "description": "Signal-to-Noise Ratio (SNR) metric where\n    y_true: signal\n    y_pred: signal + noise\n\nExample:\n\n```python\n# Create 4-second sine wave w/ freq=4, amplitude=1, Fs=1000Hz\nt = np.linspace(0, 4, 4 * 1000, endpoint=False)\nx = np.sin(2 * np.pi * 4 * t)\n# Add random noise with amplitude 0.1\nnoise = np.random.normal(0, 0.1, len(t))\ny = x + noise\nimport helia_edge as helia\n\nsnr = helia.metrics.Snr()\nsnr.update_state(x, y)\nprint(snr.result())\n```",
          "examples": [],
          "id": "helia_edge.metrics.snr.Snr",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.snr.Snr.num",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "num",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "num = self.add_variable(shape=(), initializer='zeros', name='num')",
              "source": {
                "line": 42,
                "path": "helia_edge/metrics/snr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L42"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.snr.Snr.den",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "den",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "den = self.add_variable(shape=(), initializer='zeros', name='den')",
              "source": {
                "line": 43,
                "path": "helia_edge/metrics/snr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L43"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.snr.Snr.update_state",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "update_state",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "update_state(y_true, y_pred, sample_weight=None)",
              "source": {
                "line": 45,
                "path": "helia_edge/metrics/snr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L45"
              },
              "summary": ""
            },
            {
              "description": "Computes the SNR in dB.",
              "examples": [],
              "id": "helia_edge.metrics.snr.Snr.result",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "result",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "result()",
              "source": {
                "line": 65,
                "path": "helia_edge/metrics/snr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L65"
              },
              "summary": "Computes the SNR in dB."
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.snr.Snr.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 72,
                "path": "helia_edge/metrics/snr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L72"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.snr.Snr.reset_state",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "reset_state",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "reset_state()",
              "source": {
                "line": 75,
                "path": "helia_edge/metrics/snr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L75"
              },
              "summary": ""
            }
          ],
          "name": "Snr",
          "params": [
            {
              "default": "'snr'",
              "description": "Name of the metric. Defaults to 'snr'.",
              "name": "name",
              "type": "str"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "Snr(name='snr', **kwargs={})",
          "source": {
            "line": 15,
            "path": "helia_edge/metrics/snr.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/snr.py#L15"
          },
          "summary": ""
        }
      ]
    }
  ],
  "name": "helia_edge"
}