Skip to content
heliaPROFILER
Reference
HELIA

power

What a power capture produces: the measured result, the observations behind it, and the on-device summary the firmware reports.

Every name on this page is imported from helia_profiler.

API tier: stable, experimental

Generated from the src/helia_profiler tree fe269596788d6ab1604cf433559e96b5f48c1d13.

Machine-readable model

class

PowerResult

Python

Complete result of a power capture.

src/helia_profiler/power/base.py:73

PowerResult(
    summary: PowerSummary,
    samples: list[PowerSample] = list(),
    gated_windows: list[GatedPowerWindow] = list(),
    metadata: PowerMetadata = PowerMetadata(),
) -> None

dataclass

Complete result of a power capture.

metadata is the typed :class:~helia_profiler.power.metadata.PowerMetadata (#154); the flat dict view is metadata.to_metadata_dict(). The result is frozen but its metadata is deliberately mutable: pipeline stages enrich it after capture, like RunMetadata.

API tier: stable

class

PowerObservation

Python

Host instrument observation, independent of firmware terminal status.

src/helia_profiler/results/artifacts.py:79

PowerObservation(
    mode: ObservationMode,
    result: PowerResult,
    gate_rise_observed: bool,
    gate_fall_observed: bool,
    deadline_s: float,
    integrity: PowerIntegrity,
) -> None

dataclass

Host instrument observation, independent of firmware terminal status.

API tier: experimental

class

PowerTerminalRecord

Python

Versioned firmware status emitted only after the power gate is low.

src/helia_profiler/results/artifacts.py:91

PowerTerminalRecord(
    version: int,
    status: Literal['ok', 'error'],
    requested_count: int,
    completed_count: int,
    elapsed_us: int | None,
    final_phase: str,
    error_code: int,
    gate_asserted: bool,
    gate_lowered: bool,
    gate_elapsed_us: int | None = None,
) -> None

dataclass

Versioned firmware status emitted only after the power gate is low.

API tier: experimental

class

OnDevicePowerSummary

Python

Integer-unit aggregate reported by a firmware-side power monitor.

src/helia_profiler/results/artifacts.py:134

OnDevicePowerSummary(
    source: str,
    scope: Literal['fixed_n_inference'],
    energy_nj: int,
    duration_us: int,
    inference_count: int,
    overflow: bool,
    charge_nc: int | None = None,
    bus_voltage_uv: int | None = None,
    calibration_id: str | None = None,
) -> None

dataclass

Integer-unit aggregate reported by a firmware-side power monitor.

API tier: experimental

Machine-readable: power.json · power.md, complete and lossless.