{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "d31bf2226e58e4120eaf8e6da289b5ee91e2e06b",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "",
      "name": "MeasurementRecord",
      "path": "helia_aot.optimization.schema.MeasurementRecord",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "One measured result of a setting value.\n\nProvisional: importable, but outside the compatibility promise; a minor release can change or remove it.",
          "examples": [],
          "id": "helia_aot.optimization.schema.MeasurementRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True)",
              "source": {
                "line": 482,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L482"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.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": 484,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L484"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.value",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "value",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "value: str = Field(..., description='The setting value measured')",
              "source": {
                "line": 485,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L485"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.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": 486,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L486"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.cpu",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "cpu",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "cpu: str = Field(..., validation_alias=AliasChoices('cpu', 'core'), description=\"The target's CPU, as in platform.cpu; reports from heliaAOT 0.30 and earlier name it core\")",
              "source": {
                "line": 487,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L487"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.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": 492,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L492"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.helia_aot",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "helia_aot",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "helia_aot: str = Field(..., description='heliaAOT version')",
              "source": {
                "line": 493,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L493"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.subject",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "subject",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "subject: str = Field(..., description='What was measured')",
              "source": {
                "line": 494,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L494"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.gain",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gain",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gain: str = Field(..., description='The measured speed change')",
              "source": {
                "line": 495,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L495"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.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": 496,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L496"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.conditions",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "conditions",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "conditions: str = Field(..., description='Board, clock and method')",
              "source": {
                "line": 497,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L497"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.MeasurementRecord.source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "source: str = Field(..., description='Where the measurement is recorded')",
              "source": {
                "line": 498,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L498"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.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": 499,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L499"
              },
              "summary": ""
            }
          ],
          "name": "MeasurementRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MeasurementRecord()",
          "source": {
            "line": 479,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/d31bf2226e58e4120eaf8e6da289b5ee91e2e06b/helia_aot/optimization/schema.py#L479"
          },
          "summary": "One measured result of a setting value."
        }
      ]
    }
  ],
  "name": "helia_aot"
}