Skip to content
heliaPROFILER
Reference
HELIA

runtime_records

The runtime versions this heliaPROFILER records, and whether each is qualified for a precision on a board and clock.

Every name on this page is imported from helia_profiler.

API tier: experimental

Generated from the src/helia_profiler tree fe269596788d6ab1604cf433559e96b5f48c1d13.

Machine-readable model

  • RuntimeQualificationclassWhat heliaPROFILER says about one runtime version, precision and target.
  • RuntimeSourceclassThe repository and commit a runtime version is built from.
  • QualifiedTargetclassA board class and clock the runtime is qualified on, and why.
  • RuntimeRecordclassOne runtime version: its source, supported precisions and qualified targets.
  • QualificationclassThe answer for one runtime version, precision and target, with the record it came from.
  • runtimesfunctionEvery runtime record shipped with this heliaPROFILER, by name then version.
  • qualificationfunctionWhether name at version is qualified for precision on board at clock.
class

RuntimeQualification

Python

What heliaPROFILER says about one runtime version, precision and target.

src/helia_profiler/runtime_records.py:35

RuntimeQualification()

What heliaPROFILER says about one runtime version, precision and target.

API tier: experimental

class

QualifiedTarget

Python

A board class and clock the runtime is qualified on, and why.

src/helia_profiler/runtime_records.py:51

QualifiedTarget(board: str, clock: str, precisions: tuple[str, ...], basis: str, trace: str) -> None

dataclass

A board class and clock the runtime is qualified on, and why.

API tier: experimental

class

RuntimeRecord

Python

One runtime version: its source, supported precisions and qualified targets.

src/helia_profiler/runtime_records.py:62

RuntimeRecord(
    name: str,
    version: str,
    default: bool,
    source: RuntimeSource,
    precisions: Mapping[str, str | None],
    qualified: tuple[QualifiedTarget, ...],
    kernels: RuntimeSource | None = None,
    archive_sha256: str | None = None,
) -> None

dataclass

One runtime version: its source, supported precisions and qualified targets.

API tier: experimental

class

Qualification

Python

The answer for one runtime version, precision and target, with the record it came from.

src/helia_profiler/runtime_records.py:78

Qualification(state: RuntimeQualification, reason: str | None, record: RuntimeRecord | None) -> None

dataclass

The answer for one runtime version, precision and target, with the record it came from.

API tier: experimental

function

runtimes

Python

Every runtime record shipped with this heliaPROFILER, by name then version.

src/helia_profiler/runtime_records.py:87

runtimes() -> tuple[RuntimeRecord, ...]

cached

Every runtime record shipped with this heliaPROFILER, by name then version.

API tier: experimental

function

qualification

Python

Whether name at version is qualified for precision on board at clock.

src/helia_profiler/runtime_records.py:133

qualification(name: str, version: str | None = None, *, board: str, clock: str, precision: str) -> Qualification

Whether name at version is qualified for precision on board at clock.

board and clock must be a built-in board and one of its CPU clock profiles (records qualify built-in boards only, so a target.custom_boards name is refused too), and precision one of :data:PRECISIONS; anything else raises ValueError, the precision first.

A version without a record, or a precision its record does not declare, is unsupported here, even when an engine’s own version check would build it: this heliaPROFILER makes no claim about it.

API tier: experimental

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