{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "cf2246a7ad439fa38d57462118e7840e5497a685",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "Measured gains and accuracy costs of setting values, read from a data file.\n\nThe records live in ``measurements.json`` next to this module, one per setting\nvalue, target and library version, so new measurements (for example ones\nhelia-profiler generates) are data changes, not code changes. The report quotes\na record only for the target and core it was measured on and never\nextrapolates, not even to another target with the same core.\n\nCopyright 2025 Ambiq. All Rights Reserved.",
      "name": "measurements",
      "path": "helia_aot.optimization.measurements",
      "submodules": [],
      "summary": "Measured gains and accuracy costs of setting values, read from a data file.",
      "symbols": [
        {
          "description": "One measured result of a setting value.",
          "examples": [],
          "id": "helia_aot.optimization.measurements.MeasurementRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(extra='forbid', frozen=True)",
              "source": {
                "line": 26,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L26"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.setting",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "setting",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "setting: str = Field(..., description='Setting name, e.g. accumulation or constant_placement')",
              "source": {
                "line": 28,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L28"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.value",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "value",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "value: str = Field(..., description='The setting value measured')",
              "source": {
                "line": 29,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L29"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.target",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "target",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "target: str = Field(..., description='Registered target the measurement ran on')",
              "source": {
                "line": 30,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L30"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.core",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "core",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "core: str = Field(..., description=\"CPU core, as in the platform's cpu\")",
              "source": {
                "line": 31,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L31"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.cmsis_nn",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "cmsis_nn",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "cmsis_nn: str = Field(..., description='ns-cmsis-nn version')",
              "source": {
                "line": 32,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L32"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.helia_aot",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "helia_aot",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "helia_aot: str = Field(..., description='heliaAOT version')",
              "source": {
                "line": 33,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L33"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.subject",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "subject",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "subject: str = Field(..., description='What was measured')",
              "source": {
                "line": 34,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L34"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.gain",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gain",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gain: str = Field(..., description='The measured speed change')",
              "source": {
                "line": 35,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L35"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.accuracy",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "accuracy",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "accuracy: str = Field(..., description=\"The measured accuracy cost, or 'exact'\")",
              "source": {
                "line": 36,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L36"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.conditions",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "conditions",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "conditions: str = Field(..., description='Board, clock and method')",
              "source": {
                "line": 37,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L37"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "source: str = Field(..., description='Where the measurement is recorded')",
              "source": {
                "line": 38,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L38"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.measurements.MeasurementRecord.generated_by",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "generated_by",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "generated_by: str = Field(..., description='Tool or process that produced the record')",
              "source": {
                "line": 39,
                "path": "helia_aot/optimization/measurements.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L39"
              },
              "summary": ""
            }
          ],
          "name": "MeasurementRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MeasurementRecord()",
          "source": {
            "line": 23,
            "path": "helia_aot/optimization/measurements.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L23"
          },
          "summary": "One measured result of a setting value."
        },
        {
          "description": "Load the packaged measurement records.",
          "examples": [],
          "id": "helia_aot.optimization.measurements.load_measurements",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "load_measurements",
          "params": [],
          "raises": [
            {
              "description": "When the file's format version is not supported.",
              "type": "ValueError"
            }
          ],
          "returns": [
            {
              "description": "tuple[MeasurementRecord, ...]: Every record in the data file.",
              "type": "tuple[MeasurementRecord, ...]"
            }
          ],
          "signature": "load_measurements() -> tuple[MeasurementRecord, ...]",
          "source": {
            "line": 49,
            "path": "helia_aot/optimization/measurements.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L49"
          },
          "summary": "Load the packaged measurement records."
        },
        {
          "description": "Records of a setting measured on ``target`` and ``core``.",
          "examples": [],
          "id": "helia_aot.optimization.measurements.measurements_for",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "measurements_for",
          "params": [
            {
              "description": "The setting name.",
              "name": "setting",
              "type": "str"
            },
            {
              "description": "The canonical target name.",
              "name": "target",
              "type": "str"
            },
            {
              "description": "The target's CPU core.",
              "name": "core",
              "type": "str"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "list[MeasurementRecord]: Matching records, possibly empty.",
              "type": "list[MeasurementRecord]"
            }
          ],
          "signature": "measurements_for(setting: str, target: str, core: str) -> list[MeasurementRecord]",
          "source": {
            "line": 70,
            "path": "helia_aot/optimization/measurements.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/measurements.py#L70"
          },
          "summary": "Records of a setting measured on target and core."
        }
      ]
    }
  ],
  "name": "helia_aot"
}