{
  "$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": "TensorBinding",
      "path": "helia_aot.memory.defines.TensorBinding",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Planner's emit intent for a single tensor's storage.\n\nProvisional: importable, but outside the compatibility promise; a minor release can change or remove it.\n\nEvery tensor in a :class:`MemoryPlan` is bound to an arena slot at\n``(role, memory, offset)``. There are no per-tensor C symbols\nanymore — scratch, persistent, and constant tensors are all\ndescriptors against arena buffers exposed via\n``arena_buffers[region]``.\n\nConstant arenas come in two shapes, distinguished purely by\nwhether ``source_memory`` matches ``memory``:\n\n- **Cold** (``source_memory == memory``): the arena buffer itself\n  is a ``static const`` blob in cold storage. Kernels read it\n  directly; no hydration is required.\n- **Staged** (``source_memory != memory``): the arena buffer is a\n  writable runtime copy in ``memory``; a separate read-only\n  source blob lives in ``source_memory`` and the caller (or the\n  weak ``<prefix>_hydrate_constants`` helper) copies it in\n  before the first ``model_run``.\n\nScratch and persistent bindings always have\n``source_memory == memory`` (they are writable arenas with no\ncold-storage source).",
          "examples": [],
          "id": "helia_aot.memory.defines.TensorBinding",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Logical role of the storage region.",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorBinding.role",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "role",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "role: ArenaRole = Field(..., description='Logical role of the storage region.')",
              "source": {
                "line": 136,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L136"
              },
              "summary": ""
            },
            {
              "description": "Runtime (kernel-visible) memory of the\narena slot.",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorBinding.memory",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "memory",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "memory: MemoryType = Field(..., description='Runtime memory of the arena slot.')",
              "source": {
                "line": 137,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L137"
              },
              "summary": ""
            },
            {
              "description": "Cold-storage memory the slot is\nsourced from. Equals ``memory`` for scratch, persistent,\nand cold constants; differs from ``memory`` for staged\nconstants.",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorBinding.source_memory",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "source_memory",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "source_memory: MemoryType = Field(..., description='Cold-storage memory the slot is sourced from.')",
              "source": {
                "line": 138,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L138"
              },
              "summary": ""
            },
            {
              "description": "Byte offset within the arena.",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorBinding.offset",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "offset",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "offset: int = Field(default=0, description='Byte offset within the arena.')",
              "source": {
                "line": 139,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L139"
              },
              "summary": ""
            }
          ],
          "name": "TensorBinding",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TensorBinding()",
          "source": {
            "line": 99,
            "path": "helia_aot/memory/defines.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L99"
          },
          "summary": "Planner's emit intent for a single tensor's storage."
        }
      ]
    }
  ],
  "name": "helia_aot"
}