{
  "$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": "Percent RMS Difference metrics.",
      "name": "prd",
      "path": "helia_edge.metrics.prd",
      "submodules": [],
      "summary": "Percent RMS Difference metrics.",
      "symbols": [
        {
          "description": "Percent RMS difference metric with optional energy normalization.\n\n:::note[PRD is computed as]\n100 * sqrt(sum((y_true - y_pred)^2) / denom)\n\n:::\n\nwhere denom is either:\n- sum(y_true^2) when ``normalized=True``\n- N (number of elements) when ``normalized=False``",
          "examples": [],
          "id": "helia_edge.metrics.prd.PRD",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.prd.PRD.normalized",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "normalized",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "normalized = normalized",
              "source": {
                "line": 22,
                "path": "helia_edge/metrics/prd.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L22"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.prd.PRD.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": 26,
                "path": "helia_edge/metrics/prd.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L26"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.prd.PRD.result",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "result",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "result()",
              "source": {
                "line": 53,
                "path": "helia_edge/metrics/prd.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L53"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.prd.PRD.reset_state",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "reset_state",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "reset_state()",
              "source": {
                "line": 59,
                "path": "helia_edge/metrics/prd.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L59"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.prd.PRD.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 63,
                "path": "helia_edge/metrics/prd.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L63"
              },
              "summary": ""
            }
          ],
          "name": "PRD",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PRD(normalized: bool = True, name: str = 'prd', **kwargs={})",
          "source": {
            "line": 8,
            "path": "helia_edge/metrics/prd.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L8"
          },
          "summary": "Percent RMS difference metric with optional energy normalization."
        },
        {
          "description": "Compatibility wrapper for normalized PRD.\n\n\n\nBase class: [PRD](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD).\n\nInherited from [PRD](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD): [get_config()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.get_config), [reset_state()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.reset_state), [result()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.result), [update_state()](/helia-edge/reference/api/helia_edge/metrics/prd/#helia_edge.metrics.prd.PRD.update_state).",
          "examples": [],
          "id": "helia_edge.metrics.prd.TruePRD",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "TruePRD",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TruePRD(name: str = 'true_prd', **kwargs={})",
          "source": {
            "line": 67,
            "path": "helia_edge/metrics/prd.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/prd.py#L67"
          },
          "summary": "Compatibility wrapper for normalized PRD."
        }
      ]
    }
  ],
  "name": "helia_edge"
}