{
  "$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": "MemoryConstraint",
      "path": "helia_aot.memory.defines.MemoryConstraint",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "User-defined memory constraint",
          "examples": [],
          "id": "helia_aot.memory.defines.MemoryConstraint",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Memory type (e.g., DTCM, ITCM)",
              "examples": [],
              "id": "helia_aot.memory.defines.MemoryConstraint.name",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "name",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "name: MemoryType = Field(..., description='Memory type (e.g., DTCM, ITCM)')",
              "source": {
                "line": 342,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L342"
              },
              "summary": ""
            },
            {
              "description": "Maximum size in bytes, or None for no limit",
              "examples": [],
              "id": "helia_aot.memory.defines.MemoryConstraint.max_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "max_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "max_size: int | None = Field(default=None, description='Maximum size in bytes, or None for no limit')",
              "source": {
                "line": 343,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L343"
              },
              "summary": ""
            },
            {
              "description": "Optional per-arena alignment floor\nin bytes. When set, the planner uses\n``max(arena_alignment, platform.min_alignment)`` for both\nthe arena base symbol and the per-slot offset of every\ntensor packed into it. When ``None`` (the default), only\nthe implementation floor (16 bytes) is applied to the\narena **base** symbol; per-slot alignment continues to use\n``max(platform.min_alignment, dtype_alignment_floor,\ntensor.alignment_hint)`` so dtype-natural and\nkernel-driven alignment are still honored. Bump\n``arena_alignment`` above the default for memories that\nback DMA-driven hydration paths needing stronger\nalignment than the platform's MVE/Helium floor (e.g.\ncacheline-sized PSRAM transfers).",
              "examples": [],
              "id": "helia_aot.memory.defines.MemoryConstraint.arena_alignment",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "arena_alignment",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "arena_alignment: int | None = Field(default=None, description='Optional per-arena alignment floor in bytes. When set, applied to both the arena base symbol and every slot. When None, only the 16-byte implementation floor applies to the base; per-slot alignment is driven by platform / dtype / tensor hints.')",
              "source": {
                "line": 344,
                "path": "helia_aot/memory/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L344"
              },
              "summary": ""
            }
          ],
          "name": "MemoryConstraint",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MemoryConstraint()",
          "source": {
            "line": 319,
            "path": "helia_aot/memory/defines.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/memory/defines.py#L319"
          },
          "summary": "User-defined memory constraint"
        }
      ]
    }
  ],
  "name": "helia_aot"
}