{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "cf2246a7ad439fa38d57462118e7840e5497a685",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "",
      "name": "quantization",
      "path": "helia_aot.air.quantization",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Fixed-point form of a real-valued rescale factor.\n\nThe pair reproduces a real multiplier as\n``x * real ~ (x * multiplier) >> (31 - shift)``, where ``multiplier`` is a\nQ31 value (see ``quantize_multiplier``). Following the CMSIS-NN\nconvention, a positive ``shift`` is applied as a left shift before the Q31\nmultiply and a negative one as a right shift after it.",
          "examples": [],
          "id": "helia_aot.air.quantization.AirFixedPointScale",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Q31 mantissa of the rescale factor.",
              "examples": [],
              "id": "helia_aot.air.quantization.AirFixedPointScale.multiplier",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "multiplier",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "multiplier: int = Field(..., description='The fixed point multiplier')",
              "source": {
                "line": 22,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L22"
              },
              "summary": ""
            },
            {
              "description": "Power-of-two exponent, in ``[-31, 30]``.",
              "examples": [],
              "id": "helia_aot.air.quantization.AirFixedPointScale.shift",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "shift",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "shift: int = Field(..., description='The fixed point shift')",
              "source": {
                "line": 23,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L23"
              },
              "summary": ""
            },
            {
              "description": "`classmethod`\n\nCreate a fixed point scale from a real multiplier.",
              "examples": [],
              "id": "helia_aot.air.quantization.AirFixedPointScale.from_real_multiplier",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "from_real_multiplier",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "from_real_multiplier(real_multiplier: float)",
              "source": {
                "line": 25,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L25"
              },
              "summary": "Create a fixed point scale from a real multiplier."
            }
          ],
          "name": "AirFixedPointScale",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "AirFixedPointScale()",
          "source": {
            "line": 7,
            "path": "helia_aot/air/quantization.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L7"
          },
          "summary": "Fixed-point form of a real-valued rescale factor."
        },
        {
          "description": "Base class for quantization details.",
          "examples": [],
          "id": "helia_aot.air.quantization.AirQuantizationDetails",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "AirQuantizationDetails",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "AirQuantizationDetails()",
          "source": {
            "line": 32,
            "path": "helia_aot/air/quantization.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L32"
          },
          "summary": "Base class for quantization details."
        },
        {
          "description": "Blockwise quantization details.",
          "examples": [],
          "id": "helia_aot.air.quantization.AirBlockwiseQuantization",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirBlockwiseQuantization.scales",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scales",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scales: int = Field(0, description='Number of scales')",
              "source": {
                "line": 43,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L43"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirBlockwiseQuantization.zero_points",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "zero_points",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "zero_points: int = Field(0, description='Number of zero points')",
              "source": {
                "line": 44,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L44"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirBlockwiseQuantization.block_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "block_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "block_size: int = Field(0, description='Size of the blocks')",
              "source": {
                "line": 45,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L45"
              },
              "summary": ""
            }
          ],
          "name": "AirBlockwiseQuantization",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "AirBlockwiseQuantization()",
          "source": {
            "line": 39,
            "path": "helia_aot/air/quantization.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L39"
          },
          "summary": "Blockwise quantization details."
        },
        {
          "description": "Parameters for quantization of a tensor.",
          "examples": [],
          "id": "helia_aot.air.quantization.AirQuantizationParameters",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.min",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "min",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "min: list[float] | None = Field(None, description='Minimum values for quantization')",
              "source": {
                "line": 52,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L52"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.max",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "max",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "max: list[float] | None = Field(None, description='Maximum values for quantization')",
              "source": {
                "line": 53,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L53"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.scale",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scale",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scale: list[float] | None = Field(None, description='Scale factors for quantization')",
              "source": {
                "line": 54,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L54"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.zero_point",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "zero_point",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "zero_point: list[int] | None = Field(None, description='Zero points for quantization')",
              "source": {
                "line": 55,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L55"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.details_type",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "details_type",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "details_type: int = Field(0, description='Type of quantization details')",
              "source": {
                "line": 56,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L56"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.details",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "details",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "details: AirQuantizationDetails | None = Field(None, description='Quantization details')",
              "source": {
                "line": 57,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L57"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.quantization_dimension",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "quantization_dimension",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "quantization_dimension: int = Field(0, description='Quantization dimension')",
              "source": {
                "line": 58,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L58"
              },
              "summary": ""
            },
            {
              "description": "Per-tensor or per-channel scales; raises if the tensor is not quantized.",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.scales",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scales",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scales: list[float]",
              "source": {
                "line": 65,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L65"
              },
              "summary": "Per-tensor or per-channel scales; raises if the tensor is not quantized."
            },
            {
              "description": "Per-tensor or per-channel zero points; raises if the tensor is not quantized.",
              "examples": [],
              "id": "helia_aot.air.quantization.AirQuantizationParameters.zero_points",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "zero_points",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "zero_points: list[int]",
              "source": {
                "line": 72,
                "path": "helia_aot/air/quantization.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L72"
              },
              "summary": "Per-tensor or per-channel zero points; raises if the tensor is not quantized."
            }
          ],
          "name": "AirQuantizationParameters",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "AirQuantizationParameters()",
          "source": {
            "line": 48,
            "path": "helia_aot/air/quantization.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/air/quantization.py#L48"
          },
          "summary": "Parameters for quantization of a tensor."
        }
      ]
    }
  ],
  "name": "helia_aot"
}