{
  "$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": "OptimizationArgs",
      "path": "helia_aot.cli.defines.OptimizationArgs",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Model-wide optimization settings: the goal, the approximation gate and the knobs.\n\nEvery knob defaults to ``auto``, which a static table resolves from\n``goal`` and ``allow_approximate``; ``operators[].optimization`` overrides\na knob per operator type or id. The resolved choice of every operator is\nwritten to ``<prefix>_plan.json``. Knob fields mirror the knob registry,\n``helia_aot.optimization.KNOBS``.",
          "examples": [],
          "id": "helia_aot.cli.defines.OptimizationArgs",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "What ``auto`` favors. ``balanced`` keeps\ntoday's defaults.",
              "examples": [],
              "id": "helia_aot.cli.defines.OptimizationArgs.goal",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "goal",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "goal: OptimizationGoal = Field(default=OptimizationGoal.BALANCED, description=\"What auto knob values favor: latency, balanced (today's defaults), size or accuracy\")",
              "source": {
                "line": 379,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L379"
              },
              "summary": ""
            },
            {
              "description": "Allow ``auto`` to choose knob values that\nchange numerics relative to the knob's default. An explicit knob\nvalue is used as given.",
              "examples": [],
              "id": "helia_aot.cli.defines.OptimizationArgs.allow_approximate",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "allow_approximate",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "allow_approximate: bool = Field(default=False, description=\"Allow auto knob values that change numerics relative to the knob's default (e.g. fast accumulation)\")",
              "source": {
                "line": 383,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L383"
              },
              "summary": ""
            },
            {
              "description": "FP16 accumulation for kernels that offer\na choice: ``precise``, ``fast`` or ``auto``.",
              "examples": [],
              "id": "helia_aot.cli.defines.OptimizationArgs.accumulation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "accumulation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "accumulation: Accumulation = Field(default=Accumulation.AUTO, description=\"FP16 accumulation: precise (standard layout, the library's default accumulation), fast (packed FP16 weights, one FP16 chain per output) or auto\")",
              "source": {
                "line": 387,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L387"
              },
              "summary": ""
            },
            {
              "description": "Int8 convolution and depthwise entry:\n``specialized``, ``generic`` or ``auto``.",
              "examples": [],
              "id": "helia_aot.cli.defines.OptimizationArgs.kernel",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernel",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernel: KernelChoice = Field(default=KernelChoice.AUTO, description='Int8 convolution and depthwise entry: specialized (shape-specialized ns-cmsis-nn direct entries where they apply), generic (the general entries, fewer kernels linked) or auto; both are exact')",
              "source": {
                "line": 394,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L394"
              },
              "summary": ""
            },
            {
              "description": "Reserved for the optimizer's\nconstraints (for example ``accuracy_drop`` in points or\n``tcm_bytes``); setting it is an error.",
              "examples": [],
              "id": "helia_aot.cli.defines.OptimizationArgs.budget",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "budget",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "budget: dict[str, float] | None = Field(None, description='Reserved: constraints for the optimizer, e.g. accuracy_drop or tcm_bytes', json_schema_extra={'cli': False})",
              "source": {
                "line": 402,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L402"
              },
              "summary": ""
            },
            {
              "description": "Reserved: a resolved plan to reproduce; setting it\nis an error.",
              "examples": [],
              "id": "helia_aot.cli.defines.OptimizationArgs.plan",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "plan",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "plan: Path | None = Field(None, description='Reserved: path to a resolved optimization plan to reproduce', json_schema_extra={'cli': False})",
              "source": {
                "line": 407,
                "path": "helia_aot/cli/defines.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L407"
              },
              "summary": ""
            }
          ],
          "name": "OptimizationArgs",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "OptimizationArgs()",
          "source": {
            "line": 353,
            "path": "helia_aot/cli/defines.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/cli/defines.py#L353"
          },
          "summary": "Model-wide optimization settings: the goal, the approximation gate and the knobs."
        }
      ]
    }
  ],
  "name": "helia_aot"
}