{
  "$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": "# heliaAOT Errors API\n\nTyped error hierarchy for user-facing failures. A ``HeliaAotError`` carries an\noptional ``hint`` (one actionable next step) and optional ``details`` (e.g.\nsubprocess output); the CLI renders these as a clean ``Error:`` line with a dim\nhint instead of a traceback, and exits 1.\n\nCopyright 2025 Ambiq. All Rights Reserved.",
      "name": "errors",
      "path": "helia_aot.errors",
      "submodules": [],
      "summary": "heliaAOT Errors API",
      "symbols": [
        {
          "description": "Base class for user-facing heliaAOT failures.",
          "examples": [],
          "id": "helia_aot.errors.HeliaAotError",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.errors.HeliaAotError.hint",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "hint",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "hint = hint",
              "source": {
                "line": 26,
                "path": "helia_aot/errors.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L26"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_aot.errors.HeliaAotError.details",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "details",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "details = details",
              "source": {
                "line": 27,
                "path": "helia_aot/errors.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L27"
              },
              "summary": ""
            }
          ],
          "name": "HeliaAotError",
          "params": [
            {
              "description": "What went wrong, phrased for the user.",
              "name": "message",
              "type": "str"
            },
            {
              "default": "None",
              "description": "One actionable next step (rendered dim below the error).",
              "name": "hint",
              "type": "str | None"
            },
            {
              "default": "None",
              "description": "Supporting output (e.g. tool stderr), rendered dim.",
              "name": "details",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "HeliaAotError(message: str, *, hint: str | None = None, details: str | None = None)",
          "source": {
            "line": 15,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L15"
          },
          "summary": "Base class for user-facing heliaAOT failures."
        },
        {
          "description": "The input model could not be found or parsed.\n\nAlso a ``FileNotFoundError`` so callers catching the stdlib type keep\nworking.",
          "examples": [],
          "id": "helia_aot.errors.ModelLoadError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "ModelLoadError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ModelLoadError()",
          "source": {
            "line": 36,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L36"
          },
          "summary": "The input model could not be found or parsed."
        },
        {
          "description": "An output path already exists and ``--force`` was not given.\n\nAlso a ``FileExistsError`` so callers catching the stdlib type keep\nworking.",
          "examples": [],
          "id": "helia_aot.errors.OutputExistsError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "OutputExistsError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "OutputExistsError()",
          "source": {
            "line": 44,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L44"
          },
          "summary": "An output path already exists and --force was not given."
        },
        {
          "description": "A configuration value is invalid for the requested conversion.\n\nAlso a ``ValueError`` so callers catching the stdlib type keep working.",
          "examples": [],
          "id": "helia_aot.errors.ConfigValueError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "ConfigValueError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ConfigValueError()",
          "source": {
            "line": 52,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L52"
          },
          "summary": "A configuration value is invalid for the requested conversion."
        },
        {
          "description": "The input model uses a structure or dtype heliaAOT cannot lower.\n\nRaised when a graph is recognized but cannot be compiled, so the message\ncan name the recognized construct and the ``hint`` can state the supported\nform. Also a ``ValueError`` so callers catching the stdlib type keep\nworking.",
          "examples": [],
          "id": "helia_aot.errors.UnsupportedModelError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "UnsupportedModelError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "UnsupportedModelError()",
          "source": {
            "line": 59,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L59"
          },
          "summary": "The input model uses a structure or dtype heliaAOT cannot lower."
        },
        {
          "description": "A codegen template referenced context its handler did not supply.\n\nThe shared Jinja environment uses ``StrictUndefined``, so an undefined\nname, a missing attribute, or an out-of-range index raises during emit\ninstead of rendering as the empty string. That is always a heliaAOT defect\nrather than a user mistake, but it is reachable from a valid model, so the\nfailure is reported with the operator, template, and line that produced it\nand the original ``UndefinedError`` is kept as ``__cause__``. Also a\n``RuntimeError`` so callers catching the stdlib type keep working.",
          "examples": [],
          "id": "helia_aot.errors.TemplateRenderError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "TemplateRenderError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TemplateRenderError()",
          "source": {
            "line": 69,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L69"
          },
          "summary": "A codegen template referenced context its handler did not supply."
        },
        {
          "description": "A supplied golden-data archive is missing a required tensor key.\n\nAlso a ``KeyError`` so callers catching the stdlib type keep working.",
          "examples": [],
          "id": "helia_aot.errors.GoldenDataKeyError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "GoldenDataKeyError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "GoldenDataKeyError()",
          "source": {
            "line": 82,
            "path": "helia_aot/errors.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/errors.py#L82"
          },
          "summary": "A supplied golden-data archive is missing a required tensor key."
        }
      ]
    }
  ],
  "name": "helia_aot"
}