Command-line interface¶
Atom-HiFi installs a single atom-hifi console script
(atom_hifi.cli.main()).
atom-hifi init [config.yaml] # write a commented starter config
atom-hifi run config.yaml # run the full L/R selection workflow
atom-hifi run merges the given config under the template defaults and calls
atom_hifi.runner.run(), which returns a summary dict (metrics + output
paths). The tutorial wrapper (hifi_workflow_tutorial.py) and the tests use the
same single orchestration path.
Entry points¶
- atom_hifi.cli.build_parser()[source]
- Return type:
Workflow stages¶
The runner executes, in order: library load → descriptor compute → optional
ε_noise calibration → optional active-learning loop or piecing → final L/R scan
→ optional NSGA-II c-factor optimisation → final fit and representative-set
selection. The Python API also supports expert-only ND grid scan and patient/OOD
controls that are intentionally absent from YAML. See
atom_hifi.runner.run() for the full control flow.