{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "Build once, run later: a frozen plan's compiled firmware, bound to its plan and saved so any host can verify, relocate and capture from it, each run saved as a verifiable result that loads back on any host, how model state carries across a run's invocations, and the build and capture records a compiled build and a run result carry. The hpx freeze, hpx build, hpx validate build and hpx run commands drive the same flow from the command line.\n\nEvery name on this page is imported from `helia_profiler`.\n\n**API tier:** `experimental`\n\nGenerated from the `src/helia_profiler` tree `f38e378c801d34438affb680257217e0b58d2cd1`.",
      "name": "compiled_build",
      "path": "helia_profiler.compiled_build",
      "submodules": [],
      "summary": "Build once, run later: a frozen plan's compiled firmware, bound to its plan and saved so any host can verify, relocate and capture from it, each run saved as a…",
      "symbols": [
        {
          "description": "State handling across invocations.\n\n``CARRY`` initializes one instance and keeps its internal state through\nwarmups and timed invocations, restoring only the fixed inputs each time.\n``SINGLE`` runs one measured invocation per initialized instance, so no\nstate carries between invocations. Where an instance ends is the engine's\n:class:`InstanceBoundary`: for a ``boot`` engine ``SINGLE`` is one timed\ninvocation and no warmups per boot; for an ``invocation`` engine, such as\nExecuTorch, every invocation is its own instance, so several measurements\nare several instances, never one carried state. The fixture firmware\nrefuses a timed span of zero ticks of its 32.768 kHz timer, so a\n``SINGLE`` invocation shorter than about 30.5 µs can fail as\n``TIMING_BOUND``.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.Lifecycle",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.Lifecycle.CARRY",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "CARRY",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "CARRY = 'carry'",
              "source": {
                "line": 33,
                "path": "src/helia_profiler/lifecycle.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/lifecycle.py#L33"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.Lifecycle.SINGLE",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "SINGLE",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "SINGLE = 'single'",
              "source": {
                "line": 34,
                "path": "src/helia_profiler/lifecycle.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/lifecycle.py#L34"
              },
              "summary": ""
            }
          ],
          "name": "Lifecycle",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "Lifecycle()",
          "source": {
            "line": 17,
            "path": "src/helia_profiler/lifecycle.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/lifecycle.py#L17"
          },
          "summary": "State handling across invocations."
        },
        {
          "description": "Return the root directory for hpx's persistent caches.\n\nResolved at call time so environment overrides apply per-invocation;\ncallers must not cache the result at import time.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.hpx_cache_root",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "hpx_cache_root",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "hpx_cache_root() -> Path",
          "source": {
            "line": 26,
            "path": "src/helia_profiler/hostenv/cache_dirs.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/hostenv/cache_dirs.py#L26"
          },
          "summary": "Return the root directory for hpx's persistent caches."
        },
        {
          "description": "`dataclass`\n\nA frozen plan and the firmware compiled from it, verifiable on any host.\n\n``binding``, an ``hpx.binding`` semantic hash, ties the build to the plan\nand lifecycle it was compiled from; :func:`build` computes it and\n:meth:`verify` recomputes it.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.CompiledBuild",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.plan",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "plan",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "plan: FrozenRun",
              "source": {
                "line": 69,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L69"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.build",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "build",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "build: FixtureBuild",
              "source": {
                "line": 70,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L70"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.lifecycle",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "lifecycle",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "lifecycle: Lifecycle",
              "source": {
                "line": 71,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L71"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.binding",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "binding",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "binding: str",
              "source": {
                "line": 72,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L72"
              },
              "summary": ""
            },
            {
              "description": "The build's identity, with its plan's ``intent_hash``; ``observation_hash`` is ``None`` until it runs.",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.identity",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "identity",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "identity: RunIdentity",
              "source": {
                "line": 75,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L75"
              },
              "summary": "The build's identity, with its plan's intenthash; observationhash is None until it runs."
            },
            {
              "description": "Re-check the build against its pinned files and its plan; raise on any mismatch.\n\nThe build's files must match their hashes, the plan its intent hash,\nand the binding the plan, lifecycle and build. The facts the build\nrecords must be the ones the plan states: engine, board, model,\ntoolchain and its version, arena and weights placement, arena size,\nclock profile and the lifecycle's invocation counts.\n\nThe runtime version and commit and the kernel commit are compared\nwherever both the plan and the build state one; a build or plan\nthat states none of a fact is not compared on it. heliaRT and\nheliaAOT compare with the plan's pins. LiteRT compares with this HPX's\nprepared LiteRT record, because the plan pins the modules an ordinary\nprofile builds from source, which a fixture build does not link.",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.verify",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "verify",
              "params": [],
              "raises": [
                {
                  "description": "Naming the first fact that does not match.",
                  "type": "ConfigError"
                }
              ],
              "returns": [],
              "signature": "verify() -> None",
              "source": {
                "line": 83,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L83"
              },
              "summary": "Re-check the build against its pinned files and its plan; raise on any mismatch."
            },
            {
              "description": "Write the build as JSON with paths relative to *roots* and return its path.",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.save",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "save",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "save(path: str | Path, *, roots: Mapping[str, Path]) -> Path",
              "source": {
                "line": 197,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L197"
              },
              "summary": "Write the build as JSON with paths relative to roots and return its path."
            },
            {
              "description": "`classmethod`\n\nRead and verify a build written by :meth:`save`, resolving paths under *roots*.",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.load",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "load",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "load(path: str | Path, *, roots: Mapping[str, Path]) -> CompiledBuild",
              "source": {
                "line": 222,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L222"
              },
              "summary": "Read and verify a build written by :meth:save, resolving paths under roots."
            },
            {
              "description": "Flash the recorded image, capture one run and compare outputs when *expect* is given.\n\nA failed capture comes back with ``capture.state == \"failure\"`` and no\nverification; errors raised while capturing propagate.\n\n*power* selects the instrument: a :class:`FixtureRailPowerRequest`\nmeasures the MCU rail of a build compiled with the same\n``power_sync`` wiring, and a :class:`FixtureBoardPowerRequest`\npowers the board through a configured supply for a timing capture\nof a build without power wiring. Either needs *power_guard*, the\nstation's authority over that instrument and rail; *guard* keeps\nits authority over the board and probe. Every refusal comes before\nthe device is touched.",
              "examples": [],
              "id": "helia_profiler.CompiledBuild.run",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "run",
              "params": [],
              "raises": [
                {
                  "description": "The build does not verify, *expect* cannot be\ncompared, or *power* does not fit the build or the run API's\nrail-energy route.",
                  "type": "ConfigError"
                },
                {
                  "description": "The device reports counts other than the build's.",
                  "type": "CaptureError"
                }
              ],
              "returns": [],
              "signature": "run(\n    *,\n    guard: FixtureCaptureGuard,\n    jlink_serial: str,\n    evidence_dir: Path,\n    settle_seconds: float,\n    expect: Expect | None = None,\n    expected_duration_s: float | None = None,\n    power: FixtureRailPowerRequest | FixtureBoardPowerRequest | None = None,\n    power_guard: FixturePowerGuard | None = None,\n) -> RunResult",
              "source": {
                "line": 264,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L264"
              },
              "summary": "Flash the recorded image, capture one run and compare outputs when expect is given."
            }
          ],
          "name": "CompiledBuild",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "CompiledBuild(plan: FrozenRun, build: FixtureBuild, lifecycle: Lifecycle, binding: str) -> None",
          "source": {
            "line": 60,
            "path": "src/helia_profiler/runs/compiled.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L60"
          },
          "summary": "A frozen plan and the firmware compiled from it, verifiable on any host."
        },
        {
          "description": "A saved run result that does not load; ``code`` names the check it failed.\n\nThe codes are the verified result reader's: ``invalid_json`` (not strict\nJSON), ``unsupported_schema`` (another schema or version),\n``invalid_path`` (unusable roots, or a result not where it records\nitself), ``artifact_changed`` (a pinned file missing or changed),\n``runtime_missing`` (the build's prepared runtime is not in the cache),\n``identity_mismatch`` (the identity or output comparison does not\nrecompute) and ``invalid_evidence`` (anything else: an unreadable or\nmalformed result, a build that does not verify, a power request the build\ncannot take).\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RunResultError",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultError.code",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "code",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "code = code",
              "source": {
                "line": 77,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L77"
              },
              "summary": ""
            }
          ],
          "name": "RunResultError",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RunResultError(code: str, message: str, *, hint: str | None = None) -> None",
          "source": {
            "line": 62,
            "path": "src/helia_profiler/runs/record.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L62"
          },
          "summary": "A saved run result that does not load; code names the check it failed."
        },
        {
          "description": "`dataclass`\n\nA saved run result, loaded and verified.\n\n``path``, ``size_bytes`` and ``sha256`` identify the saved document,\n``document`` is its JSON, which the portable view cites by JSON pointer,\n``hpx_version`` is the heliaPROFILER that wrote it, and ``result`` is the\nrun it records.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RunResultRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultRecord.path",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "path",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "path: Path",
              "source": {
                "line": 91,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L91"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultRecord.size_bytes",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "size_bytes",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "size_bytes: int",
              "source": {
                "line": 92,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L92"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultRecord.sha256",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "sha256",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "sha256: str",
              "source": {
                "line": 93,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L93"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultRecord.hpx_version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "hpx_version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "hpx_version: str",
              "source": {
                "line": 94,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L94"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultRecord.result",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "result",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "result: RunResult",
              "source": {
                "line": 95,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L95"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResultRecord.document",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "document",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "document: Mapping[str, Any]",
              "source": {
                "line": 96,
                "path": "src/helia_profiler/runs/record.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L96"
              },
              "summary": ""
            }
          ],
          "name": "RunResultRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RunResultRecord(\n    path: Path,\n    size_bytes: int,\n    sha256: str,\n    hpx_version: str,\n    result: RunResult,\n    document: Mapping[str, Any],\n) -> None",
          "source": {
            "line": 81,
            "path": "src/helia_profiler/runs/record.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L81"
          },
          "summary": "A saved run result, loaded and verified."
        },
        {
          "description": "Read and verify a run result saved by :meth:`RunResult.save`, resolving paths under *roots*.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.load_run",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "load_run",
          "params": [],
          "raises": [
            {
              "description": "A ``ConfigError`` naming the first check that fails:\nthe schema or version, the compiled build, a pinned file, the\nidentity or the output comparison.",
              "type": "RunResultError"
            }
          ],
          "returns": [],
          "signature": "load_run(path: str | Path, *, roots: Mapping[str, Path]) -> RunResultRecord",
          "source": {
            "line": 99,
            "path": "src/helia_profiler/runs/record.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/record.py#L99"
          },
          "summary": "Read and verify a run result saved by :meth:RunResult.save, resolving paths under roots."
        },
        {
          "description": "`dataclass`\n\nOne capture from a :class:`CompiledBuild`.\n\n``power`` is the power request the run was captured with, or ``None``.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RunResult",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResult.compiled",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "compiled",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "compiled: CompiledBuild",
              "source": {
                "line": 418,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L418"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResult.capture",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "capture",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "capture: FixtureCaptureResult",
              "source": {
                "line": 419,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L419"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResult.identity",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "identity",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "identity: RunIdentity",
              "source": {
                "line": 420,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L420"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResult.verification",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "verification",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "verification: Verification | None",
              "source": {
                "line": 421,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L421"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunResult.power",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "power",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "power: FixtureRailPowerRequest | FixtureBoardPowerRequest | None = None",
              "source": {
                "line": 422,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L422"
              },
              "summary": ""
            },
            {
              "description": "True only for a ``success`` capture.",
              "examples": [],
              "id": "helia_profiler.RunResult.succeeded",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "succeeded",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "succeeded: bool",
              "source": {
                "line": 425,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L425"
              },
              "summary": "True only for a success capture."
            },
            {
              "description": "The capture's gross MCU-rail energy, or ``None`` when it measured none.\n\nIt holds the measured iterations, duration, mean power and current,\nenergy and energy per iteration, the rail and instrument serial, the\nhash-pinned raw instrument trace, and the protocol-2 READY, GO,\ngate and DONE samples in ``completion``. A failed capture measures\nnone.",
              "examples": [],
              "id": "helia_profiler.RunResult.energy",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "energy",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "energy: FixtureRailEnergy | None",
              "source": {
                "line": 430,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L430"
              },
              "summary": "The capture's gross MCU-rail energy, or None when it measured none."
            },
            {
              "description": "Write the run as a ``hpx.run-result`` with paths relative to *roots* and return its path.\n\n*build* is the file the run's compiled build was saved to; the result\npins it by sha256 and size. The capture's files are pinned as they\nare; the reference outputs of a verification are written beside the\nresult under unique names and pinned too. Every path must sit under\none of *roots*. :func:`load_run` reads it back.",
              "examples": [],
              "id": "helia_profiler.RunResult.save",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "save",
              "params": [],
              "raises": [
                {
                  "description": "*build* is not this run's compiled build, a file is\nmissing or changed, a path is under no root, or the identity\nor verification does not recompute from the build and capture.",
                  "type": "ConfigError"
                }
              ],
              "returns": [],
              "signature": "save(path: str | Path, *, roots: Mapping[str, Path], build: str | Path) -> Path",
              "source": {
                "line": 441,
                "path": "src/helia_profiler/runs/compiled.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L441"
              },
              "summary": "Write the run as a hpx.run-result with paths relative to roots and return its path."
            }
          ],
          "name": "RunResult",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RunResult(\n    compiled: CompiledBuild,\n    capture: FixtureCaptureResult,\n    identity: RunIdentity,\n    verification: Verification | None,\n    power: FixtureRailPowerRequest | FixtureBoardPowerRequest | None = None,\n) -> None",
          "source": {
            "line": 411,
            "path": "src/helia_profiler/runs/compiled.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L411"
          },
          "summary": "One capture from a :class:CompiledBuild."
        },
        {
          "description": "Compile *plan* for *fixture*'s pinned inputs and return the compiled build.\n\n*lifecycle* must be one the plan's engine implements; it sets the timed\niterations and warmups the firmware runs. A *method* with ``power_sync``\ncompiles the protocol-2 power firmware, which a run measures with a\nmatching :class:`~helia_profiler.FixtureRailPowerRequest`; it is admitted\nfor a heliaAOT or LiteRT plan on the ``apollo510_evb`` under\n``Lifecycle.CARRY``, and refused otherwise. A plan frozen with power\nenabled needs such a method. *host* supplies host-local\nsettings, such as ``{\"work_dir\": ...}``, as :meth:`FrozenRun.config` does.\nheliaRT and LiteRT link a prepared runtime: without *runtime*, the one the\nplan names is taken from the HPX cache (``hpx runtimes prepare``), never\ndownloaded or built. The result is verified before it is returned.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "build",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "build(\n    plan: FrozenRun,\n    fixture: TypedFixture,\n    *,\n    method: FixtureMethod,\n    lifecycle: Lifecycle = Lifecycle.CARRY,\n    runtime: PreparedUpstreamRuntime | None = None,\n    model: str | Path | None = None,\n    host: Mapping[str, object] | None = None,\n    observe_aot_arenas: bool = False,\n    observe_ram: bool = False,\n) -> CompiledBuild",
          "source": {
            "line": 460,
            "path": "src/helia_profiler/runs/compiled.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L460"
          },
          "summary": "Compile plan for fixture's pinned inputs and return the compiled build."
        },
        {
          "description": "Read and verify a compiled build written by :meth:`CompiledBuild.save`.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.load_build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "load_build",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "load_build(path: str | Path, *, roots: Mapping[str, Path]) -> CompiledBuild",
          "source": {
            "line": 666,
            "path": "src/helia_profiler/runs/compiled.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L666"
          },
          "summary": "Read and verify a compiled build written by :meth:CompiledBuild.save."
        },
        {
          "description": "Flash *compiled*'s image, capture one run and compare outputs; see :meth:`CompiledBuild.run`.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.run_build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "run_build",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "run_build(\n    compiled: CompiledBuild,\n    *,\n    guard: FixtureCaptureGuard,\n    jlink_serial: str,\n    evidence_dir: Path,\n    settle_seconds: float,\n    expect: Expect | None = None,\n    expected_duration_s: float | None = None,\n    power: FixtureRailPowerRequest | FixtureBoardPowerRequest | None = None,\n    power_guard: FixturePowerGuard | None = None,\n) -> RunResult",
          "source": {
            "line": 671,
            "path": "src/helia_profiler/runs/compiled.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runs/compiled.py#L671"
          },
          "summary": "Flash compiled's image, capture one run and compare outputs; see :meth:CompiledBuild.run."
        }
      ]
    }
  ],
  "name": "helia_profiler"
}