reproduce

Reproduce an export from its record (helia-edge export reproduce) and create one from a spec file.

ReproductionclassWhat reproduce found.
file_sha256functionsha256 of a file's bytes.
load_npyfunctionA .npy array, memory-mapped, so that a header claiming more data than the file holds is refused rather than allocated.
load_specfunctionA ModelSpec from a YAML (.yaml/.yml) or JSON file.
family_mappingfunctionThe weight mapping name of the spec's family (its params module's MAPPINGS).
environment_differencesfunctionHow current differs from recorded, in the versions that can change exported bytes.
litert_unavailablefunctionWhy this process cannot export LiteRT, one line each; empty when it can.
reproducefunctionRebuild the model a record describes, export it again with the same settings and compare.
imported_sourcefunctionThe record of weights imported through mapping from a file with sha256.

Reproduction(
    status: Literal['same', 'different', 'environment', 'input'],
    differences: tuple[str, ...] = (),
    environment: tuple[str, ...] = (),
    skipped: tuple[str, ...] = (),
) -> None

dataclass

What reproduce found.

status: Literal['same', 'different', 'environment', 'input']

same (same artifact, I/O and golden), different, environment (the environment differs and the comparison was not made) or input (a file is missing or does not match the record).

differences: tuple[str, ...] = ()

What differs, or which input is missing or does not match, one line each.

environment: tuple[str, ...] = ()

How the environment differs from the record’s, or why it cannot export, one line each.

skipped: tuple[str, ...] = ()

What the record names but was not compared, one line each.

file_sha256(path: Path | str) -> str

sha256 of a file’s bytes.

load_npy(path: Path | str) -> np.ndarray

A .npy array, memory-mapped, so that a header claiming more data than the file holds is refused rather than allocated.

Raises

Errors raised by load_npy
Type	Description
`ValueError`	If the file cannot be read as a ``.npy`` array.

load_spec(path: Path | str)

A ModelSpec from a YAML (.yaml/.yml) or JSON file.

Raises

Errors raised by load_spec
Type	Description
`ValueError`	If the file is not valid YAML or JSON, or not a valid ``ModelSpec``.

family_mapping(spec, name: str)

The weight mapping name of the spec’s family (its params module’s MAPPINGS).

environment_differences(recorded: EnvironmentEntry, current: EnvironmentEntry) -> list[str]

How current differs from recorded, in the versions that can change exported bytes.

litert_unavailable() -> tuple[str, ...]

Why this process cannot export LiteRT, one line each; empty when it can.

reproduce(
    record_path: Path | str,
    weights: Path | str,
    calibration: Path | str | None = None,
    golden_inputs: Path | str | None = None,
    allow_env_mismatch: bool = False,
) -> Reproduction

Rebuild the model a record describes, export it again with the same settings and compare.

Parameters

Parameters of reproduce
Name	Type	Default	Description
`record_path`	`Path \| str`	Required	The ``record.json``.
`weights`	`Path \| str`	Required	The ``.weights.h5`` file, or for imported weights the source file the mapping imports.
`calibration`	`Path \| str \| None`	None	The calibration ``.npy``, when the record has calibration.
`golden_inputs`	`Path \| str \| None`	None	The golden's input ``.npy``, to regenerate and compare the golden.
`allow_env_mismatch`	`bool`	False	Compare even when the environment differs from the record's.

Returns

Returns of reproduce
Value	Type	Description
`Reproduction`	`Reproduction`	``same`` when the weights digest, the export settings, the artifact, the I/O, the golden
	`Reproduction`	(with ``golden_inputs``) and the ``model.tflite`` and ``golden.npz`` beside the record (when present)
	`Reproduction`	match. A failure of the export itself is raised.

imported_source(mapping, sha256: str) -> WeightImport

The record of weights imported through mapping from a file with sha256.