Skip to content
heliaPROFILER
Reference
HELIA

hpx build

Build a frozen plan for fixed inputs into a run directory

function

hpx build

Python

Build a frozen plan for fixed inputs into a run directory

src/helia_profiler/cli/run_app.py:212

hpx build [OPTIONS] PLAN
hpx build arguments
ArgumentTypeDescription
planPathPlan written by hpx freeze Required.
hpx build options
OptionTypeDefaultDescription
--outPathRun directory to write Required.
--inputOptional[list[Path]]Raw bytes for one model input; repeat once per input, in model order (default: zero-filled inputs) Repeatable.
--lifecyclecarry | singlecarrycarry keeps the plan's iterations and warmups and carries model state; single times one invocation per boot
--timing-scopeinvoke_only | restore_and_invokeinvoke_onlyinvoke_only times each invocation; restore_and_invoke times the loop, input restoration included
--modelOptional[Path]The plan's model, when it is no longer at the path the plan records
--work-dirOptional[Path]Firmware build directory inside OUT (default: OUT/work); the saved build records its files relative to OUT
--verbose, -vint0Increase verbosity
hpx build examples
Writes OUT/build.json, the model and one input_<index>.bin per model input under OUT/inputs, and the firmware under OUT/work. OUT must be new or empty, so a failed build never touches an earlier one. heliaRT and LiteRT link the runtime that hpx runtimes prepare cached under the HPX cache. Prints the saved build's path, inputs and identity as JSON.
Example:
hpx build plan.json --out runs/kws --input kws_input.bin

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