# helia_profiler

The entry points of the heliaPROFILER Python API: one call, one session, and the progress stream they report through.

Every name on this page is imported from `helia_profiler`.

**API tier:** `stable`

Generated from the `src/helia_profiler` tree `fe269596788d6ab1604cf433559e96b5f48c1d13`.

**Re-exports**

| Name | Source |
| --- | --- |
| [ProfileConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.ProfileConfig) | `helia_profiler.ProfileConfig` |
| [ModelConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.ModelConfig) | `helia_profiler.ModelConfig` |
| [EngineConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.EngineConfig) | `helia_profiler.EngineConfig` |
| [TargetConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.TargetConfig) | `helia_profiler.TargetConfig` |
| [ProfilingConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.ProfilingConfig) | `helia_profiler.ProfilingConfig` |
| [OutputConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.OutputConfig) | `helia_profiler.OutputConfig` |
| [BuildConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.BuildConfig) | `helia_profiler.BuildConfig` |
| [HeartbeatConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.HeartbeatConfig) | `helia_profiler.HeartbeatConfig` |
| [TimeoutsConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.TimeoutsConfig) | `helia_profiler.TimeoutsConfig` |
| [ClockSelection](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.ClockSelection) | `helia_profiler.ClockSelection` |
| [OutputFormat](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/#helia_profiler.OutputFormat) | `helia_profiler.OutputFormat` |
| [PowerConfig](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/config/power/#helia_profiler.PowerConfig) | `helia_profiler.PowerConfig` |
| [EngineType](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/vocab/#helia_profiler.EngineType) | `helia_profiler.EngineType` |
| [Toolchain](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/vocab/#helia_profiler.Toolchain) | `helia_profiler.Toolchain` |
| [Transport](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/vocab/#helia_profiler.Transport) | `helia_profiler.Transport` |
| [Placement](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/vocab/#helia_profiler.Placement) | `helia_profiler.Placement` |
| [ResetStrategy](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/vocab/#helia_profiler.ResetStrategy) | `helia_profiler.ResetStrategy` |
| [CompatibilityBaseline](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/deps/#helia_profiler.CompatibilityBaseline) | `helia_profiler.CompatibilityBaseline` |
| [CompatibilityResolution](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/deps/#helia_profiler.CompatibilityResolution) | `helia_profiler.CompatibilityResolution` |
| [QualificationState](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/deps/#helia_profiler.QualificationState) | `helia_profiler.QualificationState` |
| [load_compatibility_baseline](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/deps/#helia_profiler.load_compatibility_baseline) | `helia_profiler.load_compatibility_baseline` |
| [DependencyLockProvenance](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/deps/#helia_profiler.DependencyLockProvenance) | `helia_profiler.DependencyLockProvenance` |
| [read_dependency_lock_provenance](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/deps/#helia_profiler.read_dependency_lock_provenance) | `helia_profiler.read_dependency_lock_provenance` |
| [qualification](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.qualification) | `helia_profiler.qualification` |
| [Qualification](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.Qualification) | `helia_profiler.Qualification` |
| [RuntimeQualification](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.RuntimeQualification) | `helia_profiler.RuntimeQualification` |
| [runtimes](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.runtimes) | `helia_profiler.runtimes` |
| [RuntimeRecord](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.RuntimeRecord) | `helia_profiler.RuntimeRecord` |
| [RuntimeSource](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.RuntimeSource) | `helia_profiler.RuntimeSource` |
| [QualifiedTarget](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/runtime_records/#helia_profiler.QualifiedTarget) | `helia_profiler.QualifiedTarget` |
| [ProfileResult](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/#helia_profiler.ProfileResult) | `helia_profiler.ProfileResult` |
| [PmuResult](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/#helia_profiler.PmuResult) | `helia_profiler.PmuResult` |
| [PresetResult](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/#helia_profiler.PresetResult) | `helia_profiler.PresetResult` |
| [LayerResult](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/#helia_profiler.LayerResult) | `helia_profiler.LayerResult` |
| [FirmwareMeta](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/#helia_profiler.FirmwareMeta) | `helia_profiler.FirmwareMeta` |
| [RunMetadata](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/#helia_profiler.RunMetadata) | `helia_profiler.RunMetadata` |
| [ResultManifest](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/manifest/#helia_profiler.ResultManifest) | `helia_profiler.ResultManifest` |
| [ResultArtifact](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/manifest/#helia_profiler.ResultArtifact) | `helia_profiler.ResultArtifact` |
| [ResultIssue](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/manifest/#helia_profiler.ResultIssue) | `helia_profiler.ResultIssue` |
| [ResultValidity](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/manifest/#helia_profiler.ResultValidity) | `helia_profiler.ResultValidity` |
| [RunStatus](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/manifest/#helia_profiler.RunStatus) | `helia_profiler.RunStatus` |
| [load_result_manifest](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/results/manifest/#helia_profiler.load_result_manifest) | `helia_profiler.load_result_manifest` |
| [PowerMode](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/#helia_profiler.PowerMode) | `helia_profiler.PowerMode` |
| [PowerResult](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/#helia_profiler.PowerResult) | `helia_profiler.PowerResult` |
| [PowerObservation](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/#helia_profiler.PowerObservation) | `helia_profiler.PowerObservation` |
| [PowerTerminalRecord](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/#helia_profiler.PowerTerminalRecord) | `helia_profiler.PowerTerminalRecord` |
| [OnDevicePowerSummary](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/#helia_profiler.OnDevicePowerSummary) | `helia_profiler.OnDevicePowerSummary` |
| [PowerMetadata](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/metadata/#helia_profiler.PowerMetadata) | `helia_profiler.PowerMetadata` |
| [MeasurementScope](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/metadata/#helia_profiler.MeasurementScope) | `helia_profiler.MeasurementScope` |
| [ObservationMode](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/metadata/#helia_profiler.ObservationMode) | `helia_profiler.ObservationMode` |
| [PowerIntegrity](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/power/metadata/#helia_profiler.PowerIntegrity) | `helia_profiler.PowerIntegrity` |
| [CompareResult](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.CompareResult) | `helia_profiler.CompareResult` |
| [assess_comparability](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.assess_comparability) | `helia_profiler.assess_comparability` |
| [ComparabilityAssessment](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.ComparabilityAssessment) | `helia_profiler.ComparabilityAssessment` |
| [ComparabilityIssue](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.ComparabilityIssue) | `helia_profiler.ComparabilityIssue` |
| [ComparabilitySeverity](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.ComparabilitySeverity) | `helia_profiler.ComparabilitySeverity` |
| [ComparisonProfile](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.ComparisonProfile) | `helia_profiler.ComparisonProfile` |
| [evaluate_comparison_profile](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.evaluate_comparison_profile) | `helia_profiler.evaluate_comparison_profile` |
| [ComparisonVerdict](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.ComparisonVerdict) | `helia_profiler.ComparisonVerdict` |
| [MetricPolicy](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.MetricPolicy) | `helia_profiler.MetricPolicy` |
| [MetricDirection](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.MetricDirection) | `helia_profiler.MetricDirection` |
| [MetricVerdict](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.MetricVerdict) | `helia_profiler.MetricVerdict` |
| [MissingMetricPolicy](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.MissingMetricPolicy) | `helia_profiler.MissingMetricPolicy` |
| [VerdictStatus](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.VerdictStatus) | `helia_profiler.VerdictStatus` |
| [evaluate_run](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.evaluate_run) | `helia_profiler.evaluate_run` |
| [RunEvaluation](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/evaluation/#helia_profiler.RunEvaluation) | `helia_profiler.RunEvaluation` |
| [ModelAnalysis](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/modelcost/#helia_profiler.ModelAnalysis) | `helia_profiler.ModelAnalysis` |
| [SupportBundleOptions](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/diagnostics/#helia_profiler.SupportBundleOptions) | `helia_profiler.SupportBundleOptions` |
| [collect_support_bundle](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/diagnostics/#helia_profiler.collect_support_bundle) | `helia_profiler.collect_support_bundle` |
| [write_support_bundle](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/diagnostics/#helia_profiler.write_support_bundle) | `helia_profiler.write_support_bundle` |
| [verify_support_bundle](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/diagnostics/#helia_profiler.verify_support_bundle) | `helia_profiler.verify_support_bundle` |
| [SupportBundleManifest](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/diagnostics/#helia_profiler.SupportBundleManifest) | `helia_profiler.SupportBundleManifest` |
| [SupportBundleSection](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/diagnostics/#helia_profiler.SupportBundleSection) | `helia_profiler.SupportBundleSection` |
| [HpxError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.HpxError) | `helia_profiler.HpxError` |
| [ConfigError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.ConfigError) | `helia_profiler.ConfigError` |
| [PlatformError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.PlatformError) | `helia_profiler.PlatformError` |
| [EngineError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.EngineError) | `helia_profiler.EngineError` |
| [FirmwareError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.FirmwareError) | `helia_profiler.FirmwareError` |
| [BuildError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.BuildError) | `helia_profiler.BuildError` |
| [DependencyError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.DependencyError) | `helia_profiler.DependencyError` |
| [VersionError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.VersionError) | `helia_profiler.VersionError` |
| [LockError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.LockError) | `helia_profiler.LockError` |
| [NetworkError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.NetworkError) | `helia_profiler.NetworkError` |
| [CaptureError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.CaptureError) | `helia_profiler.CaptureError` |
| [DeterministicCaptureError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.DeterministicCaptureError) | `helia_profiler.DeterministicCaptureError` |
| [PowerError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.PowerError) | `helia_profiler.PowerError` |
| [ReportError](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler/errors/#helia_profiler.ReportError) | `helia_profiler.ReportError` |

[Machine-readable model](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler.json)

**API tier:** `stable`

Run a full profiling session.

This is the main programmatic entry point.  It builds the default pipeline,
executes all stages, and returns a typed :class:`ProfileResult`.

Raises :class:`HpxError` (or a subclass) on failure.

**API tier:** `stable`

`dataclass`

User-meaningful progress within a pipeline stage.

**API tier:** `stable`

`dataclass`

Immutable, branchable configuration for interactive HPX operations.

Sessions retain unresolved configuration overrides so YAML values and
board-derived defaults are resolved by the same validation path as the
CLI. Every ``with_*`` method returns an independent session.

**API tier:** `stable`

`classmethod`

Create a session from an immutable snapshot of an HPX YAML config.

`classmethod`

Create a session from unresolved configuration intent.

`classmethod`

Load a versioned unresolved-intent snapshot from JSON.

Return JSON-safe unresolved intent without expanding defaults.

Return the fully resolved and validated configuration snapshot.

Persist unresolved intent as a versioned JSON snapshot.

Return a session with advanced raw configuration overrides merged in.

Return a session with top-level run options.

Resolve and validate this session as a complete profile config.

Run a profile using this session's resolved configuration.

Analyze the configured model without building or flashing firmware.

Compare two completed profiles and optionally write diff artifacts.

Return structured host dependency checks.

Set *include_versions* to also compare installed tool and package
versions against the HPX compatibility baseline.

Pretty-print a typed interactive value and return it unchanged.

Return boards visible to this session's platform registry.

Return supported inference engine identifiers.

Return registered PMU counter group names.

Return registered PMU counters, optionally filtered by group.

Return connected J-Link probes.

Inspect the target core visible through each connected probe.

Resolve the J-Link serial matching a board target.

Return host serial ports relevant to HPX transports.

Reset the configured target through its J-Link probe.

---

Machine-readable: [`helia_profiler.json`](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler.json) · [`helia_profiler.md`](https://ambiqai.github.io/helia-profiler/reference/api/helia_profiler.md), complete and lossless.