{
  "$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": "The user-facing optimization settings, for the docs page and its drift test.\n\nCopyright 2025 Ambiq. All Rights Reserved.",
      "name": "settings",
      "path": "helia_aot.optimization.settings",
      "submodules": [],
      "summary": "The user-facing optimization settings, for the docs page and its drift test.",
      "symbols": [
        {
          "description": "",
          "examples": [],
          "id": "helia_aot.optimization.settings.SETTINGS",
          "kind": "constant",
          "language": "python",
          "members": [],
          "name": "SETTINGS",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SETTINGS: tuple[SettingSpec, ...] = (GOAL, ALLOW_APPROXIMATE, *, CONSTANT_PLACEMENT)",
          "source": {
            "line": 64,
            "path": "helia_aot/optimization/settings.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L64"
          },
          "summary": ""
        },
        {
          "description": "`dataclass`\n\nA user-facing optimization setting.",
          "examples": [],
          "id": "helia_aot.optimization.settings.SettingSpec",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Short name of the setting.",
              "examples": [],
              "id": "helia_aot.optimization.settings.SettingSpec.name",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "name",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "name: str",
              "source": {
                "line": 27,
                "path": "helia_aot/optimization/settings.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L27"
              },
              "summary": ""
            },
            {
              "description": "Configuration keys that set it.",
              "examples": [],
              "id": "helia_aot.optimization.settings.SettingSpec.keys",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "keys",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "keys: tuple[str, ...]",
              "source": {
                "line": 28,
                "path": "helia_aot/optimization/settings.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L28"
              },
              "summary": ""
            },
            {
              "description": "Its default value.",
              "examples": [],
              "id": "helia_aot.optimization.settings.SettingSpec.default",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "default",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "default: str",
              "source": {
                "line": 29,
                "path": "helia_aot/optimization/settings.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L29"
              },
              "summary": ""
            },
            {
              "description": "Accepted values.",
              "examples": [],
              "id": "helia_aot.optimization.settings.SettingSpec.values",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "values",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "values: tuple[str, ...]",
              "source": {
                "line": 30,
                "path": "helia_aot/optimization/settings.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L30"
              },
              "summary": ""
            },
            {
              "description": "What it changes.",
              "examples": [],
              "id": "helia_aot.optimization.settings.SettingSpec.summary",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "summary",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "summary: str",
              "source": {
                "line": 31,
                "path": "helia_aot/optimization/settings.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L31"
              },
              "summary": ""
            }
          ],
          "name": "SettingSpec",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SettingSpec(name: str, keys: tuple[str, ...], default: str, values: tuple[str, ...], summary: str) -> None",
          "source": {
            "line": 15,
            "path": "helia_aot/optimization/settings.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/optimization/settings.py#L15"
          },
          "summary": "A user-facing optimization setting."
        }
      ]
    }
  ],
  "name": "helia_aot"
}
