{
  "$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": "Fp16Overflow",
      "path": "helia_aot.optimization.schema.Fp16Overflow",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "The input magnitude below which a packed FP16 convolution fed from a model input cannot overflow a lane block.",
          "examples": [],
          "id": "helia_aot.optimization.schema.Fp16Overflow",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.operator_id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "operator_id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "operator_id: str = Field(..., description='Plan operator id of the convolution')",
              "source": {
                "line": 878,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L878"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.entry",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "entry",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "entry: str = Field(..., description='The ns-cmsis-nn entry; its packed FP16 lane sums 32 taps from the bias')",
              "source": {
                "line": 879,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L879"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.input",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input: str = Field(..., description='The model input tensor the layer reads')",
              "source": {
                "line": 880,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L880"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.path",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "path",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "path: list[str] = Field(..., description='Operator types between the model input and the layer, in order')",
              "source": {
                "line": 881,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L881"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.threshold",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "threshold",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "threshold: float = Field(..., ge=0, description=\"Input magnitude below which no float16 lane block can reach 65504, allowing for float16 rounding: (65504 / (1 + g) - |bias|) / sum|w| over the first 32 taps and 65504 / (1 + g) / sum|w| over each later block, where g = n*u / (1 - n*u) bounds n round-to-nearest operations (the block's taps, plus one for the bias in block 0) at u = 2^-11; the minimum over output channels and blocks. The layer's float16 output can still overflow when its exact value exceeds the float16 range\")",
              "source": {
                "line": 882,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L882"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.channel",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "channel",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "channel: int = Field(..., ge=0, description='Output channel attaining the threshold')",
              "source": {
                "line": 893,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L893"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.block",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "block",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "block: int = Field(..., ge=0, description='Block of 32 taps attaining it; block 0 starts from the bias')",
              "source": {
                "line": 894,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L894"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.weight_sum",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "weight_sum",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "weight_sum: float = Field(..., ge=0, description='sum|w| over that block')",
              "source": {
                "line": 895,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L895"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.optimization.schema.Fp16Overflow.bias",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "bias",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "bias: float = Field(..., ge=0, description='|bias| of that channel when the block is 0, else 0')",
              "source": {
                "line": 896,
                "path": "helia_aot/optimization/schema.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L896"
              },
              "summary": ""
            }
          ],
          "name": "Fp16Overflow",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "Fp16Overflow()",
          "source": {
            "line": 875,
            "path": "helia_aot/optimization/schema.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/aee921f9f6ddb72ad858bd66859e225a41d53074/helia_aot/optimization/schema.py#L875"
          },
          "summary": "The input magnitude below which a packed FP16 convolution fed from a model input cannot overflow a lane block."
        }
      ]
    }
  ],
  "name": "helia_aot"
}