{
  "$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": "TensorAllocation",
      "path": "helia_aot.memory.defines.TensorAllocation",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Metadata for a tensor allocation.\n\nProvisional: importable, but outside the compatibility promise; a minor release can change or remove it.",
          "examples": [],
          "id": "helia_aot.memory.defines.TensorAllocation",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Unique identifier for the tensor",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorAllocation.tensor_id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "tensor_id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "tensor_id: TensorId = Field(..., description='Unique identifier for the tensor')",
              "source": {
                "line": 202,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L202"
              },
              "summary": ""
            },
            {
              "description": "Memory type for the allocation (runtime\n/ kernel-visible memory of the arena slot)",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorAllocation.memory",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "memory",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "memory: MemoryType = Field(..., description='Memory type for the allocation')",
              "source": {
                "line": 203,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L203"
              },
              "summary": ""
            },
            {
              "description": "Offset within the arena",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorAllocation.offset",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "offset",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "offset: int = Field(default=0, description='Offset within the memory arena')",
              "source": {
                "line": 204,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L204"
              },
              "summary": ""
            },
            {
              "description": "Size of the allocation in bytes",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorAllocation.size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "size: int = Field(default=0, description='Size of the allocation in bytes')",
              "source": {
                "line": 205,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L205"
              },
              "summary": ""
            },
            {
              "description": "Planner's binding describing\n``(role, memory, offset, source_memory)`` for the slot.\nDefaults to ``None`` for callers that construct\n:class:`TensorAllocation` directly; the bundled\n:class:`GreedyMemoryPlanner` always populates it. Emit\ntemplates dispatch on ``binding.role`` and on the\n``binding.source_memory == binding.memory`` predicate\n(cold vs staged constant).",
              "examples": [],
              "id": "helia_aot.memory.defines.TensorAllocation.binding",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "binding",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "binding: TensorBinding | None = Field(default=None, description=\"Planner-assigned binding describing how this tensor's storage is materialized.\")",
              "source": {
                "line": 206,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L206"
              },
              "summary": ""
            }
          ],
          "name": "TensorAllocation",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TensorAllocation()",
          "source": {
            "line": 182,
            "path": "helia_aot/memory/defines.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L182"
          },
          "summary": "Metadata for a tensor allocation."
        }
      ]
    }
  ],
  "name": "helia_aot"
}