{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "What a power capture produces: the measured result, the observations behind it, and the on-device summary the firmware reports.\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": "power",
      "path": "helia_profiler.power",
      "submodules": [],
      "summary": "What a power capture produces: the measured result, the observations behind it, and the on-device summary the firmware reports.",
      "symbols": [
        {
          "description": "Power measurement mode.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.PowerMode",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerMode.EXTERNAL",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "EXTERNAL",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "EXTERNAL = 'external'",
              "source": {
                "line": 15,
                "path": "src/helia_profiler/power/base.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L15"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerMode.INTERNAL",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "INTERNAL",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "INTERNAL = 'internal'",
              "source": {
                "line": 16,
                "path": "src/helia_profiler/power/base.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L16"
              },
              "summary": ""
            }
          ],
          "name": "PowerMode",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PowerMode()",
          "source": {
            "line": 12,
            "path": "src/helia_profiler/power/base.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L12"
          },
          "summary": "Power measurement mode."
        },
        {
          "description": "`dataclass`\n\nComplete result of a power capture.\n\n``metadata`` is the typed :class:`~helia_profiler.power.metadata.PowerMetadata`\n(#154); the flat dict view is ``metadata.to_metadata_dict()``.\nThe result is frozen but its metadata is deliberately mutable: pipeline\nstages enrich it after capture, like ``RunMetadata``.\n\n**API tier:** `stable`",
          "examples": [],
          "id": "helia_profiler.PowerResult",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerResult.summary",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "summary",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "summary: PowerSummary",
              "source": {
                "line": 83,
                "path": "src/helia_profiler/power/base.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L83"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerResult.samples",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "samples: list[PowerSample] = field(default_factory=list)",
              "source": {
                "line": 84,
                "path": "src/helia_profiler/power/base.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L84"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerResult.gated_windows",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gated_windows",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gated_windows: list[GatedPowerWindow] = field(default_factory=list)",
              "source": {
                "line": 85,
                "path": "src/helia_profiler/power/base.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L85"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerResult.metadata",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "metadata",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "metadata: PowerMetadata = field(default_factory=PowerMetadata)",
              "source": {
                "line": 86,
                "path": "src/helia_profiler/power/base.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L86"
              },
              "summary": ""
            }
          ],
          "name": "PowerResult",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PowerResult(\n    summary: PowerSummary,\n    samples: list[PowerSample] = list(),\n    gated_windows: list[GatedPowerWindow] = list(),\n    metadata: PowerMetadata = PowerMetadata(),\n) -> None",
          "source": {
            "line": 73,
            "path": "src/helia_profiler/power/base.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/power/base.py#L73"
          },
          "summary": "Complete result of a power capture."
        },
        {
          "description": "`dataclass`\n\nHost instrument observation, independent of firmware terminal status.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.PowerObservation",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerObservation.mode",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "mode",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "mode: ObservationMode",
              "source": {
                "line": 83,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L83"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerObservation.result",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "result",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "result: PowerResult",
              "source": {
                "line": 84,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L84"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerObservation.gate_rise_observed",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gate_rise_observed",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gate_rise_observed: bool",
              "source": {
                "line": 85,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L85"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerObservation.gate_fall_observed",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gate_fall_observed",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gate_fall_observed: bool",
              "source": {
                "line": 86,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L86"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerObservation.deadline_s",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "deadline_s",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "deadline_s: float",
              "source": {
                "line": 87,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L87"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerObservation.integrity",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "integrity",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "integrity: PowerIntegrity",
              "source": {
                "line": 88,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L88"
              },
              "summary": ""
            }
          ],
          "name": "PowerObservation",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PowerObservation(\n    mode: ObservationMode,\n    result: PowerResult,\n    gate_rise_observed: bool,\n    gate_fall_observed: bool,\n    deadline_s: float,\n    integrity: PowerIntegrity,\n) -> None",
          "source": {
            "line": 79,
            "path": "src/helia_profiler/results/artifacts.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L79"
          },
          "summary": "Host instrument observation, independent of firmware terminal status."
        },
        {
          "description": "`dataclass`\n\nVersioned firmware status emitted only after the power gate is low.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.PowerTerminalRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "version: int",
              "source": {
                "line": 95,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L95"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.status",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "status",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "status: Literal['ok', 'error']",
              "source": {
                "line": 96,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L96"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.requested_count",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "requested_count",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "requested_count: int",
              "source": {
                "line": 97,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L97"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.completed_count",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "completed_count",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "completed_count: int",
              "source": {
                "line": 98,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L98"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.elapsed_us",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "elapsed_us",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "elapsed_us: int | None",
              "source": {
                "line": 99,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L99"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.final_phase",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "final_phase",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "final_phase: str",
              "source": {
                "line": 100,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L100"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.error_code",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "error_code",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "error_code: int",
              "source": {
                "line": 101,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L101"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.gate_asserted",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gate_asserted",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gate_asserted: bool",
              "source": {
                "line": 102,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L102"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.gate_lowered",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gate_lowered",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gate_lowered: bool",
              "source": {
                "line": 103,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L103"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.PowerTerminalRecord.gate_elapsed_us",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "gate_elapsed_us",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "gate_elapsed_us: int | None = None",
              "source": {
                "line": 107,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L107"
              },
              "summary": ""
            }
          ],
          "name": "PowerTerminalRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "PowerTerminalRecord(\n    version: int,\n    status: Literal['ok', 'error'],\n    requested_count: int,\n    completed_count: int,\n    elapsed_us: int | None,\n    final_phase: str,\n    error_code: int,\n    gate_asserted: bool,\n    gate_lowered: bool,\n    gate_elapsed_us: int | None = None,\n) -> None",
          "source": {
            "line": 91,
            "path": "src/helia_profiler/results/artifacts.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L91"
          },
          "summary": "Versioned firmware status emitted only after the power gate is low."
        },
        {
          "description": "`dataclass`\n\nInteger-unit aggregate reported by a firmware-side power monitor.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.OnDevicePowerSummary",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "source: str",
              "source": {
                "line": 138,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L138"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.scope",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scope",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scope: Literal['fixed_n_inference']",
              "source": {
                "line": 139,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L139"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.energy_nj",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "energy_nj",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "energy_nj: int",
              "source": {
                "line": 140,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L140"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.duration_us",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "duration_us",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "duration_us: int",
              "source": {
                "line": 141,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L141"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.inference_count",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "inference_count",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "inference_count: int",
              "source": {
                "line": 142,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L142"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.overflow",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "overflow",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "overflow: bool",
              "source": {
                "line": 143,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L143"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.charge_nc",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "charge_nc",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "charge_nc: int | None = None",
              "source": {
                "line": 144,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L144"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.bus_voltage_uv",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "bus_voltage_uv",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "bus_voltage_uv: int | None = None",
              "source": {
                "line": 145,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L145"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.OnDevicePowerSummary.calibration_id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "calibration_id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "calibration_id: str | None = None",
              "source": {
                "line": 146,
                "path": "src/helia_profiler/results/artifacts.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L146"
              },
              "summary": ""
            }
          ],
          "name": "OnDevicePowerSummary",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "OnDevicePowerSummary(\n    source: str,\n    scope: Literal['fixed_n_inference'],\n    energy_nj: int,\n    duration_us: int,\n    inference_count: int,\n    overflow: bool,\n    charge_nc: int | None = None,\n    bus_voltage_uv: int | None = None,\n    calibration_id: str | None = None,\n) -> None",
          "source": {
            "line": 134,
            "path": "src/helia_profiler/results/artifacts.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/results/artifacts.py#L134"
          },
          "summary": "Integer-unit aggregate reported by a firmware-side power monitor."
        }
      ]
    }
  ],
  "name": "helia_profiler"
}