{
  "$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": "",
      "name": "MemoryArgs",
      "path": "helia_aot.cli.defines.MemoryArgs",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Memory configuration for the conversion process.",
          "examples": [],
          "id": "helia_aot.cli.defines.MemoryArgs",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Memory planner strategy. Defaults to\n``greedy``; ``greedy_by_size`` and ``hill_climb`` are experimental\nand opt-in.",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.planner",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "planner",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "planner: MemoryPlannerType = Field(default=MemoryPlannerType.greedy, description='Memory planner strategy (greedy_by_size and hill_climb are experimental)')",
              "source": {
                "line": 173,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L173"
              },
              "summary": ""
            },
            {
              "description": "Tunables forwarded to the selected\nplanner, validated against that planner's option schema. Unknown\nkeys are rejected with a did-you-mean hint. ``hill_climb`` accepts\n``iterations``, ``seed``, and ``max_stall_iterations``; ``greedy``\nand ``greedy_by_size`` accept none. On the CLI this is a JSON\nobject: ``--memory.planner-options '{\"iterations\": 2000}'``.",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.planner_options",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "planner_options",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "planner_options: dict[str, Any] = Field(default_factory=dict, description=\"Planner tunables as JSON, validated against the selected planner's option schema (hill_climb: iterations, seed, max_stall_iterations)\")",
              "source": {
                "line": 177,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L177"
              },
              "summary": ""
            },
            {
              "description": "Memory constraints (ordered by preference). Defaults to None.",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.constraints",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "constraints",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "constraints: list[MemoryConstraint] | None = Field(None, description='Memory constraints (ordered by preference)')",
              "source": {
                "line": 184,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L184"
              },
              "summary": ""
            },
            {
              "description": "Per-tensor attribute rulesets.",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.tensors",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "tensors",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "tensors: list[AttributeRuleset] = Field(..., description='Tensor attributes', default_factory=list)",
              "source": {
                "line": 185,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L185"
              },
              "summary": ""
            },
            {
              "description": "If true, generated module declares its own arena buffers.",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.allocate_arenas",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "allocate_arenas",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "allocate_arenas: bool = Field(True, description='If true, the module will use internal, statically allocated arenas. If false, the caller must bind every region via <prefix>_bind_arena() / <prefix>_bind_arenas() before model_init.')",
              "source": {
                "line": 186,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L186"
              },
              "summary": ""
            },
            {
              "description": "**Deprecated** — retained for\nbackwards compatibility but no longer changes generated\nruntime behavior. ``<prefix>_model_init`` always invokes\n``<prefix>_hydrate_constants`` between\n``<prefix>_context_init`` and the operator init loop, so\nkernels that read constants in their ``_init`` hook always\nobserve hydrated arenas. Override the weak\n``<prefix>_hydrate_constants`` symbol for DMA / async\npre-stage / model-swap behavior; ``model_init`` calls the\noverride at the same fixed point.",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.auto_hydrate_constants",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "auto_hydrate_constants",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "auto_hydrate_constants: bool = Field(True, description='Deprecated — retained for backwards compatibility but no longer changes generated runtime behavior. model_init always invokes hydrate_constants between context_init and the operator init loop. Override the weak hydrate_constants symbol for custom hydration mechanisms (DMA / async pre-stage / model swap).')",
              "source": {
                "line": 194,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L194"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.cli.defines.MemoryArgs.dump_residency_json",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dump_residency_json",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dump_residency_json: bool = Field(False, description='If true, write a machine-readable residency report (``<prefix>_residency.json``) alongside the emitted module. Mirrors the verbose log summary as JSON for tooling that needs to introspect arena layout, staged-vs-cold residency, and per-tensor placement post-planning.')",
              "source": {
                "line": 204,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L204"
              },
              "summary": ""
            }
          ],
          "name": "MemoryArgs",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MemoryArgs()",
          "source": {
            "line": 145,
            "path": "helia_aot/cli/defines.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L145"
          },
          "summary": "Memory configuration for the conversion process."
        }
      ]
    }
  ],
  "name": "helia_aot"
}