{
  "$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": "The optimization plan and report files, as typed models with JSON schemas.\n\n``<prefix>_plan.json`` is normative: the resolved choice of every knob for\nevery operator, what was requested and by which rule, the choices that are not\nknobs yet, and the identity of the model and target the plan belongs to. It is\nwhat an optimizer rewrites and what heliaAOT will reproduce.\n\n``<prefix>_report.json`` is non-normative: MACs, alternatives and whether they\napply, measurements, constant placement facts and the hints the results print.\nIts content may change between releases, and a plan reader ignores it.\n\nVersioning: both files carry ``schema_version``. Adding an optional field, a\nknob, a knob value or an enum member keeps the version; renaming or removing a\nfield, or changing what a field means, bumps it.\n\nKnob names and each knob's values come from the registry, ``KNOBS``: the\nmodels reject any other, and the exported JSON schemas list them per knob. The\nexported schemas therefore belong to the heliaAOT release that produced a file\n(``generator.helia_aot``); a consumer validates against that release's schema\nand does not pin one across releases.\n\nSome members and fields are reserved and never written today: ``plan`` as a\nknob source, ``resolved_by`` and ``set_by`` (a choice taken from an input\nplan), ``auto_heuristic`` as ``resolved_by`` (``auto`` consulting the operator\nor target rather than the goal table), model-level ``optimization.knobs`` and\nper-tensor ``tensors``.\n\nCopyright 2025 Ambiq. All Rights Reserved.",
      "name": "schema",
      "path": "helia_aot.optimization.schema",
      "submodules": [],
      "summary": "The optimization plan and report files, as typed models with JSON schemas.",
      "symbols": [
        {
          "description": "The ``operators[]`` rule that set a knob.",
          "examples": [],
          "id": "helia_aot.optimization.schema.RuleRef",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.RuleRef.index",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "index",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "index: int = Field(..., description='Position of the rule in operators[]')",
              "source": {
                "line": 111,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L111"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.RuleRef.type",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "type",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "type: str = Field(..., description=\"The rule's type\")",
              "source": {
                "line": 112,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L112"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.RuleRef.id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "id: str | list[str] | None = Field(None, description=\"The rule's id\")",
              "source": {
                "line": 113,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L113"
              },
              "summary": ""
            }
          ],
          "name": "RuleRef",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RuleRef()",
          "source": {
            "line": 108,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L108"
          },
          "summary": "The operators[] rule that set a knob."
        },
        {
          "description": "Who asked for a knob's value; ``rule`` is set exactly when ``kind`` is ``operator``.",
          "examples": [],
          "id": "helia_aot.optimization.schema.KnobSource",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobSource.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(extra='forbid', json_schema_extra=_rule_exactly_for_operator)",
              "source": {
                "line": 125,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L125"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobSource.kind",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kind",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kind: Literal['operator', 'model', 'default', 'plan'] = Field(..., description='An operators[] rule, the model-wide optimization section, or neither; plan (an input plan) is reserved')",
              "source": {
                "line": 127,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L127"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobSource.rule",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "rule",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "rule: RuleRef | None = Field(None, description='The operators[] rule, when kind is operator')",
              "source": {
                "line": 133,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L133"
              },
              "summary": ""
            }
          ],
          "name": "KnobSource",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "KnobSource()",
          "source": {
            "line": 122,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L122"
          },
          "summary": "Who asked for a knob's value; rule is set exactly when kind is operator."
        },
        {
          "description": "The resolved value of one knob for one operator.\n\n``resolved_by`` agrees with ``requested``: ``explicit`` means a value was\nasked for and used as given (``value`` equals ``requested``); ``auto_table``\nand ``auto_heuristic`` mean ``requested`` is ``auto``.",
          "examples": [],
          "id": "helia_aot.optimization.schema.KnobChoice",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobChoice.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(extra='forbid', json_schema_extra=_provenance_is_consistent)",
              "source": {
                "line": 163,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L163"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobChoice.value",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "value",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "value: str = Field(..., description='The value used')",
              "source": {
                "line": 165,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L165"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobChoice.requested",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "requested",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "requested: str = Field(..., description='The value asked for, possibly auto')",
              "source": {
                "line": 166,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L166"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobChoice.resolved_by",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "resolved_by",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "resolved_by: Literal['explicit', 'auto_table', 'auto_heuristic', 'plan'] = Field(..., description='explicit when a value was asked for; auto_table when auto chose it from the goal; auto_heuristic and plan are reserved')",
              "source": {
                "line": 167,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L167"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobChoice.source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "source: KnobSource",
              "source": {
                "line": 174,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L174"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.KnobChoice.approximate",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "approximate",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "approximate: bool = Field(..., description=\"Whether the value changes numerics relative to the knob's default where it applies\")",
              "source": {
                "line": 175,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L175"
              },
              "summary": ""
            }
          ],
          "name": "KnobChoice",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "KnobChoice()",
          "source": {
            "line": 155,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L155"
          },
          "summary": "The resolved value of one knob for one operator."
        },
        {
          "description": "One operator's choices.",
          "examples": [],
          "id": "helia_aot.optimization.schema.PlanOperator",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "id: str = Field(..., description=\"Stable id: '<subgraph>:<first output tensor name>', or a fallback; operators[].id matches it. For every id_source except node_id, split on the first colon only (tensor names can contain ':'); a node_id id is the opaque AIR node id\")",
              "source": {
                "line": 200,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L200"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.id_source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "id_source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "id_source: Literal['tensor_name', 'tensor_name+ordinal', 'index', 'node_id'] = Field(..., description='How the id was derived; node_id when the stable id would also match another operator, so the id is the AIR node id')",
              "source": {
                "line": 208,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L208"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.index",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "index",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "index: int = Field(..., description='Position in execution order')",
              "source": {
                "line": 215,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L215"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.node_id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "node_id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "node_id: str = Field(..., description='AIR node id, which operators[].id also matches')",
              "source": {
                "line": 216,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L216"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.op_type",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "op_type",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "op_type: str",
              "source": {
                "line": 217,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L217"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.knobs",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "knobs",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "knobs: dict[str, KnobChoice] = Field(default_factory=dict, description='Resolved choice per knob, for the knobs that exist for this operator', json_schema_extra=_per_knob(_choice_enums))",
              "source": {
                "line": 218,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L218"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.PlanOperator.fixed",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "fixed",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "fixed: dict[str, FixedChoice] = Field(default_factory=dict)",
              "source": {
                "line": 223,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L223"
              },
              "summary": ""
            }
          ],
          "name": "PlanOperator",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PlanOperator()",
          "source": {
            "line": 197,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L197"
          },
          "summary": "One operator's choices."
        },
        {
          "description": "The normative optimization plan, ``<prefix>_plan.json``.",
          "examples": [],
          "id": "helia_aot.optimization.schema.OptimizationPlan",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.schema_version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "schema_version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "schema_version: Literal[1] = Field(..., description='Plan schema version')",
              "source": {
                "line": 274,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L274"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.generator",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "generator",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "generator: Generator",
              "source": {
                "line": 275,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L275"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.model",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model: ModelIdentity",
              "source": {
                "line": 276,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L276"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.module_prefix",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "module_prefix",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "module_prefix: str",
              "source": {
                "line": 277,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L277"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.platform",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "platform",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "platform: PlatformIdentity",
              "source": {
                "line": 278,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L278"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.optimization",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "optimization",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "optimization: PlanOptimization",
              "source": {
                "line": 279,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L279"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.operators",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "operators",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "operators: list[PlanOperator]",
              "source": {
                "line": 280,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L280"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationPlan.tensors",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "tensors",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "tensors: list[dict[str, Any]] = Field(default_factory=list, max_length=0, description='Reserved for per-tensor choices such as placement; empty today')",
              "source": {
                "line": 281,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L281"
              },
              "summary": ""
            }
          ],
          "name": "OptimizationPlan",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "OptimizationPlan()",
          "source": {
            "line": 271,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L271"
          },
          "summary": "The normative optimization plan, <prefix>plan.json."
        },
        {
          "description": "Constants outside TCM against DTCM left free, within memory.constraints.",
          "examples": [],
          "id": "helia_aot.optimization.schema.ConstantPlacement",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.ConstantPlacement.constant_bytes_outside_tcm",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "constant_bytes_outside_tcm",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "constant_bytes_outside_tcm: dict[str, int]",
              "source": {
                "line": 337,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L337"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.ConstantPlacement.constant_bytes_in_tcm",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "constant_bytes_in_tcm",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "constant_bytes_in_tcm: int",
              "source": {
                "line": 338,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L338"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.ConstantPlacement.dtcm_budget_bytes",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dtcm_budget_bytes",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dtcm_budget_bytes: int",
              "source": {
                "line": 339,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L339"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.ConstantPlacement.dtcm_free_bytes",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dtcm_free_bytes",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dtcm_free_bytes: int",
              "source": {
                "line": 340,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L340"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.ConstantPlacement.id_specific_constant_rules",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "id_specific_constant_rules",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "id_specific_constant_rules: int",
              "source": {
                "line": 341,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L341"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.ConstantPlacement.cold_source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "cold_source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "cold_source: str | None",
              "source": {
                "line": 342,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L342"
              },
              "summary": ""
            }
          ],
          "name": "ConstantPlacement",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ConstantPlacement()",
          "source": {
            "line": 334,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L334"
          },
          "summary": "Constants outside TCM against DTCM left free, within memory.constraints."
        },
        {
          "description": "One optimization hint: a fact about an alternative that applies.",
          "examples": [],
          "id": "helia_aot.optimization.schema.Hint",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.setting",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "setting",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "setting: str",
              "source": {
                "line": 348,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L348"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.message",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "message",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "message: str",
              "source": {
                "line": 349,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L349"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.current",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "current",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "current: str",
              "source": {
                "line": 350,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L350"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.alternative",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "alternative",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "alternative: str",
              "source": {
                "line": 351,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L351"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.yaml",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "yaml",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "yaml: str",
              "source": {
                "line": 352,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L352"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.operators",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "operators",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "operators: list[str] = Field(default_factory=list)",
              "source": {
                "line": 353,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L353"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.mac_share",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "mac_share",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "mac_share: float | None = None",
              "source": {
                "line": 354,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L354"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Hint.facts",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "facts",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "facts: dict[str, Any] = Field(default_factory=dict)",
              "source": {
                "line": 355,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L355"
              },
              "summary": ""
            }
          ],
          "name": "Hint",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "Hint()",
          "source": {
            "line": 345,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L345"
          },
          "summary": "One optimization hint: a fact about an alternative that applies."
        },
        {
          "description": "The non-normative optimization report, ``<prefix>_report.json``.",
          "examples": [],
          "id": "helia_aot.optimization.schema.OptimizationReport",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.schema_version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "schema_version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "schema_version: Literal[1] = Field(..., description='Report schema version')",
              "source": {
                "line": 361,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L361"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.plan_file",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "plan_file",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "plan_file: str = Field(..., description='The plan this report explains')",
              "source": {
                "line": 362,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L362"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.total_macs",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "total_macs",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "total_macs: int = Field(..., description='MACs of convolution, depthwise and fully connected layers')",
              "source": {
                "line": 363,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L363"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.operators",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "operators",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "operators: list[ReportOperator]",
              "source": {
                "line": 364,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L364"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.measurements",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "measurements",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "measurements: dict[str, list[MeasurementRecord]] = Field(..., description='Measurements for this target and core, keyed by setting; every setting has an entry', json_schema_extra=_per_setting)",
              "source": {
                "line": 365,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L365"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.constant_placement",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "constant_placement",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "constant_placement: ConstantPlacement | None",
              "source": {
                "line": 370,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L370"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.OptimizationReport.hints",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "hints",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "hints: list[Hint]",
              "source": {
                "line": 371,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L371"
              },
              "summary": ""
            }
          ],
          "name": "OptimizationReport",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "OptimizationReport()",
          "source": {
            "line": 358,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/schema.py#L358"
          },
          "summary": "The non-normative optimization report, <prefix>report.json."
        }
      ]
    }
  ],
  "name": "helia_aot"
}