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 core it was measured on and never extrapolates, not even to another target with the same core.

Machine-readable model

MeasurementRecordclassOne measured result of a setting value.
load_measurementsfunctionLoad the packaged measurement records.
measurements_forfunctionRecords of a setting measured on target and core.

MeasurementRecord()

One measured result of a setting value.

model_config = ConfigDict(extra='forbid', frozen=True)

setting: str = Field(..., description='Setting name, e.g. accumulation or constant_placement')

value: str = Field(..., description='The setting value measured')

target: str = Field(..., description='Registered target the measurement ran on')

core: str = Field(..., description="CPU core, as in the platform's cpu")

cmsis_nn: str = Field(..., description='ns-cmsis-nn version')

helia_aot: str = Field(..., description='heliaAOT version')

subject: str = Field(..., description='What was measured')

gain: str = Field(..., description='The measured speed change')

accuracy: str = Field(..., description="The measured accuracy cost, or 'exact'")

conditions: str = Field(..., description='Board, clock and method')

source: str = Field(..., description='Where the measurement is recorded')

generated_by: str = Field(..., description='Tool or process that produced the record')

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

Load the packaged measurement records.

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.

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

Records of a setting measured on target and core.

Parameters

Parameters of measurements_for
Name	Type	Default	Description
`setting`	`str`	Required	The setting name.
`target`	`str`	Required	The canonical target name.
`core`	`str`	Required	The target's CPU core.

Returns

Returns of measurements_for
Type	Description
`list[MeasurementRecord]`	list[MeasurementRecord]: Matching records, possibly empty.