{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "aee921f9f6ddb72ad858bd66859e225a41d53074",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "",
      "name": "ArenaRole",
      "path": "helia_aot.memory.defines.ArenaRole",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Logical role of a memory arena.\n\nProvisional: importable, but outside the compatibility promise; a minor release can change or remove it.\n\nEvery tensor in a :class:`MemoryPlan` lives in an arena tagged\nwith one of these roles. Roles partition the planner output so\nscratch reuse, persistent zero-init, and constant residency can\nbe reasoned about independently.\n\nEach member also answers to its lowercase name (``ArenaRole.scratch``),\nan alias of the same member; the value is the spelling reports use.",
          "examples": [],
          "id": "helia_aot.memory.defines.ArenaRole",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "``scratch``. Writable activation/scratch arena\n(whole-program lifetime shared by ops, slots reused via liveness\nanalysis).",
              "examples": [],
              "id": "helia_aot.memory.defines.ArenaRole.SCRATCH",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "SCRATCH",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "SCRATCH = auto()",
              "source": {
                "line": 90,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L90"
              },
              "summary": ""
            },
            {
              "description": "``persistent``. Whole-program-live writable storage\n(resource variables and similar).",
              "examples": [],
              "id": "helia_aot.memory.defines.ArenaRole.PERSISTENT",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "PERSISTENT",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "PERSISTENT = auto()",
              "source": {
                "line": 91,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L91"
              },
              "summary": ""
            },
            {
              "description": "``constant``. Read-only weight storage. Can be cold (the\narena buffer is the cold-storage blob and kernels read it in\nplace) or staged (the arena buffer is a writable runtime copy\nhydrated from a separate source blob).",
              "examples": [],
              "id": "helia_aot.memory.defines.ArenaRole.CONSTANT",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "CONSTANT",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "CONSTANT = auto()",
              "source": {
                "line": 92,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L92"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.memory.defines.ArenaRole.scratch",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scratch",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scratch = SCRATCH",
              "source": {
                "line": 94,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L94"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.memory.defines.ArenaRole.persistent",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "persistent",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "persistent = PERSISTENT",
              "source": {
                "line": 95,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L95"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.memory.defines.ArenaRole.constant",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "constant",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "constant = CONSTANT",
              "source": {
                "line": 96,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L96"
              },
              "summary": ""
            }
          ],
          "name": "ArenaRole",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ArenaRole()",
          "source": {
            "line": 67,
            "path": "helia_aot/memory/defines.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L67"
          },
          "summary": "Logical role of a memory arena."
        }
      ]
    }
  ],
  "name": "helia_aot"
}