measurements

Measured gains and accuracy costs of setting values, read from a data file.

The records live in measurements.json next to this module, one per setting value, target and library version, so new measurements (for example ones helia-profiler generates) are data changes, not code changes. The report quotes a record only for the target and CPU it was measured on and never extrapolates, not even to another target with the same CPU.

Copyright 2025 Ambiq. All Rights Reserved.

Machine-readable model

• load_measurementsfunctionLoad the packaged measurement records.
• measurements_forfunctionRecords of a setting measured on target and cpu.

function

load_measurements

Python

Load the packaged measurement records.

helia_aot/optimization/measurements.py:32

load_measurements() -> tuple[MeasurementRecord, ...]

Load the packaged measurement records.

Provisional: importable, but outside the compatibility promise; a minor release can change or remove it.

Returns

Returns of load_measurements

Type	Description
tuple[MeasurementRecord, ...]	tuple[MeasurementRecord, ...]: Every record in the data file.

Raises

Errors raised by load_measurements

Type	Description
ValueError	When the file's format version is not supported.

function

measurements_for

Python

Records of a setting measured on target and cpu.

helia_aot/optimization/measurements.py:54

measurements_for(setting: str, target: str, cpu: str) -> list[MeasurementRecord]

Records of a setting measured on target and cpu.

Provisional: importable, but outside the compatibility promise; a minor release can change or remove it.

Parameters

Parameters of measurements_for

Name	Type	Default	Description
setting	str	Required	The setting name.
target	str	Required	The canonical target name.
cpu	str	Required	The target's CPU, as in ``platform.cpu``.

Returns

Returns of measurements_for

Type	Description
list[MeasurementRecord]	list[MeasurementRecord]: Matching records, possibly empty.