{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "The exception hierarchy every heliaPROFILER failure is raised through, rooted at HpxError.\n\nEvery name on this page is imported from `helia_profiler`.\n\n**API tier:** `stable`, `experimental`\n\nGenerated from the `src/helia_profiler` tree `fe269596788d6ab1604cf433559e96b5f48c1d13`.",
      "name": "errors",
      "path": "helia_profiler.errors",
      "submodules": [],
      "summary": "The exception hierarchy every heliaPROFILER failure is raised through, rooted at HpxError.",
      "symbols": [
        {
          "description": "Base exception for all heliaPROFILER errors.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.HpxError",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.HpxError.hint",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "hint",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "hint = hint",
              "source": {
                "line": 15,
                "path": "src/helia_profiler/errors.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L15"
              },
              "summary": ""
            }
          ],
          "name": "HpxError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "HpxError(message: str, *, hint: str | None = None) -> None",
          "source": {
            "line": 11,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L11"
          },
          "summary": "Base exception for all heliaPROFILER errors."
        },
        {
          "description": "Bad configuration — missing model path, invalid YAML, unknown board.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.ConfigError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "ConfigError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ConfigError()",
          "source": {
            "line": 33,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L33"
          },
          "summary": "Bad configuration — missing model path, invalid YAML, unknown board."
        },
        {
          "description": "Unsupported board/SoC combination or missing platform capability.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.PlatformError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "PlatformError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PlatformError()",
          "source": {
            "line": 37,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L37"
          },
          "summary": "Unsupported board/SoC combination or missing platform capability."
        },
        {
          "description": "Engine adapter failure — AOT compile error, missing static lib, etc.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.EngineError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "EngineError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "EngineError()",
          "source": {
            "line": 41,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L41"
          },
          "summary": "Engine adapter failure — AOT compile error, missing static lib, etc."
        },
        {
          "description": "Firmware generation failure — template rendering, file I/O.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.FirmwareError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "FirmwareError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "FirmwareError()",
          "source": {
            "line": 45,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L45"
          },
          "summary": "Firmware generation failure — template rendering, file I/O."
        },
        {
          "description": "NSX configure / build / flash / lock / sync failure.\n\nCarries the underlying tool's diagnostic output (cmake / ninja /\nSEGGER commander / git stderr, NSX exception message, etc.) in\n:attr:`details`.  When the source is a real subprocess, the original\nreturn code is also captured in :attr:`returncode`.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.BuildError",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildError.returncode",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "returncode",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "returncode = returncode",
              "source": {
                "line": 66,
                "path": "src/helia_profiler/errors.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L66"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildError.details",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "details",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "details = details",
              "source": {
                "line": 67,
                "path": "src/helia_profiler/errors.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L67"
              },
              "summary": ""
            }
          ],
          "name": "BuildError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "BuildError(message: str, *, hint: str | None = None, returncode: int | None = None, details: str | None = None) -> None",
          "source": {
            "line": 49,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L49"
          },
          "summary": "NSX configure / build / flash / lock / sync failure."
        },
        {
          "description": "Data capture failure — serial timeout, corrupt data, SWO framing.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.CaptureError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "CaptureError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "CaptureError()",
          "source": {
            "line": 71,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L71"
          },
          "summary": "Data capture failure — serial timeout, corrupt data, SWO framing."
        },
        {
          "description": "A capture-path refusal no retry or power cycle can change.\n\nSubclass of :class:`CaptureError` so existing ``except CaptureError``\nhandlers still catch it, but recovery paths that would otherwise cycle the\ntarget rail and retry (``stages.flash.deploy_firmware``) re-raise it\ninstead: these are configuration/artifact gaps — a missing image, an\nunknown load address — and cycling the rail only frames them as flaky\nhardware.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.DeterministicCaptureError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "DeterministicCaptureError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "DeterministicCaptureError()",
          "source": {
            "line": 75,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L75"
          },
          "summary": "A capture-path refusal no retry or power cycle can change."
        },
        {
          "description": "Transient network failure during sync/lock (git fetch, module download).\n\nSubclass of :class:`BuildError` so existing ``except BuildError`` handlers\nstill catch it, but callers that want to retry can specifically catch this.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.NetworkError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "NetworkError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "NetworkError()",
          "source": {
            "line": 87,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L87"
          },
          "summary": "Transient network failure during sync/lock (git fetch, module download)."
        },
        {
          "description": "Deterministic dependency lock/workspace failure (base class).\n\nCovers workspace fingerprinting, override, and provenance-collection\nfailures that are neither a version mismatch nor a lock-file problem.\nPrefer :class:`VersionError` or :class:`LockError` when a failure is\nspecifically about an incompatible version or a missing/corrupt lock.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.DependencyError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "DependencyError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "DependencyError()",
          "source": {
            "line": 95,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L95"
          },
          "summary": "Deterministic dependency lock/workspace failure (base class)."
        },
        {
          "description": "A tool, package, engine, or lock schema version is incompatible.\n\nRaised when an installed version fails a compatibility baseline check\n(schema version, minimum/maximum engine version, pinned package\nversion) so callers can distinguish \"wrong version\" from other\ndependency failures and surface an actionable upgrade/downgrade hint.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.VersionError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "VersionError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "VersionError()",
          "source": {
            "line": 105,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L105"
          },
          "summary": "A tool, package, engine, or lock schema version is incompatible."
        },
        {
          "description": "A dependency lock file or its recorded provenance is unusable.\n\nRaised for a missing, unreadable, structurally invalid, or\ndrifted ``nsx.lock`` / ``hpx-dependencies.json``, so field-diagnostics\ncollectors can skip just the lock-provenance section instead of\nfailing an entire report.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.LockError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "LockError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "LockError()",
          "source": {
            "line": 115,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L115"
          },
          "summary": "A dependency lock file or its recorded provenance is unusable."
        },
        {
          "description": "Power measurement failure — Joulescope not found, calibration error.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.PowerError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "PowerError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PowerError()",
          "source": {
            "line": 125,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L125"
          },
          "summary": "Power measurement failure — Joulescope not found, calibration error."
        },
        {
          "description": "Report generation failure — output path not writable, format error.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.ReportError",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "ReportError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ReportError()",
          "source": {
            "line": 129,
            "path": "src/helia_profiler/errors.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/errors.py#L129"
          },
          "summary": "Report generation failure — output path not writable, format error."
        }
      ]
    }
  ],
  "name": "helia_profiler"
}