Skip to content
heliaPROFILER
Reference
HELIA

metadata

The provenance of a power number: how it was observed, what the measurement boundary included, and whether the capture holds together.

Every name on this page is imported from helia_profiler.

API tier: experimental

Generated from the src/helia_profiler tree fe269596788d6ab1604cf433559e96b5f48c1d13.

Machine-readable model

  • MeasurementScopeclassWhat the published power numbers actually measured.
  • ObservationModeclassHow the observation was made -- the single vocabulary (#154).
  • PowerIntegrityclassWhether the observation is valid for efficiency metrics.
  • PowerMetadataclassEverything the capture layer tells the rest of HPX about one power run.
class

MeasurementScope

Python

What the published power numbers actually measured.

src/helia_profiler/power/metadata.py:38

MeasurementScope()

What the published power numbers actually measured.

API tier: experimental

class

PowerMetadata

Python

Everything the capture layer tells the rest of HPX about one power run.

src/helia_profiler/power/metadata.py:81

PowerMetadata(
    driver: str | None = None,
    device: str | None = None,
    io_voltage: float | None = None,
    gating_method: str | None = None,
    sync_input_index: int | None = None,
    stats_rate_hz: int | None = None,
    stats_scnt: int | None = None,
    window_count: int | None = None,
    gpi_poll_count: int | None = None,
    stat_packets: int | None = None,
    early_stopped: bool | None = None,
    capture_window_s: float | None = None,
    capture_safety_bound_s: float | None = None,
    short_gate_pulses_ignored: int | None = None,
    clean_infer_count: int | None = None,
    inference_count: int | None = None,
    source: str | None = None,
    measurement_scope: MeasurementScope | str | None = None,
    observation_mode: ObservationMode | None = None,
    integrity: PowerIntegrity | None = None,
    gate_rise_observed: bool | None = None,
    gate_fall_observed: bool | None = None,
    observation_deadline_s: float | None = None,
    power_firmware: str | None = None,
    power_plan: dict[str, Any] | None = None,
    sync: SyncHandshakeMetadata | None = None,
    sync_timing_s: GateTransitionTiming | None = None,
    gate_failure: GateFailure | None = None,
    gate_duration_integrity: GateDurationIntegrity | None = None,
    window_clock_ceiling: WindowClockCeiling | None = None,
    target_lifecycle: 'TargetLifecyclePlan | None' = None,
    short_gate_pulse_diagnostics: dict[str, Any] | None = None,
    whole_capture_summary: dict[str, Any] | None = None,
    fullrate_xcheck: dict[str, Any] | None = None,
    gating_diagnostics: dict[str, Any] | None = None,
    gated_vs_whole_current_ok: bool | None = None,
) -> None

dataclass

Everything the capture layer tells the rest of HPX about one power run.

Mutable by design — enriched progressively, like RunMetadata. The serialized view (:meth:to_metadata_dict) emits every non-None field under its historical key name, flattening the typed diagnostics through their to_metadata() methods.

API tier: experimental

method

to_metadata_dict

Python

Flat dict view, byte-compatible with the pre-#154 metadata bag.

src/helia_profiler/power/metadata.py:162

to_metadata_dict() -> dict[str, Any]

Flat dict view, byte-compatible with the pre-#154 metadata bag.

Emits every non-None field under its historical key; typed diagnostics flatten through their own to_metadata(). False is a recorded value and is emitted; None means “never set” and is omitted.

method

set_observation

Python

Enrich metadata with the observation classification at publication.

src/helia_profiler/power/metadata.py:181

set_observation(
    *,
    observation_mode: ObservationMode,
    integrity: PowerIntegrity | str,
    gate_rise_observed: bool,
    gate_fall_observed: bool,
    observation_deadline_s: float,
) -> None

Enrich metadata with the observation classification at publication.

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