Skip to content
heliaAOT
API Reference
HELIA HUB

ModuleArgs

Machine-readable model

  • ModuleArgsclassModule configuration for the conversion process.
class

Module configuration for the conversion process.

helia_aot/cli/defines.py:120

ModuleArgs()

Module configuration for the conversion process.

attribute

path

Python

helia_aot/cli/defines.py:141

path: Path = Field(..., description="Output path for the generated module. Use a directory for an unpacked module, a '.zip' suffix for a generic zip archive, or a '.pack' suffix for an Open-CMSIS-Pack archive (requires module.type=cmsis_pack).", default_factory=lambda : ...)

Output path for the generated module. Use a directory for an unpacked module, a .zip suffix for a generic zip archive, or a .pack suffix for an Open-CMSIS-Pack archive (requires module.type=cmsis_pack). Defaults to "output.zip".

attribute

type

Python

helia_aot/cli/defines.py:151

type: ModuleType = Field(default=ModuleType.CMAKE, description='Module type: cmake, zephyr, nsx or cmsis_pack', json_schema_extra=stability(experimental_values=[ModuleType.CMSIS_PACK]))

Type of the module (cmake, zephyr, nsx or cmsis_pack). Defaults to cmake. The removed neuralspot type is rejected with a migration hint in a configuration file or the Python API; --module.type neuralspot on the command line is an invalid choice like any other unknown value.

attribute

name

Python

helia_aot/cli/defines.py:156

name: ValidModuleNameType = Field(default='helia_aot_nn', description='Module name')

Name of the module. Defaults to “helia_aot_nn”.

attribute

prefix

Python

helia_aot/cli/defines.py:157

prefix: ValidCVarNameType = Field(default='aot', description='Prefix added to sources for unique namespace')

Prefix added to sources for unique namespace. Defaults to “aot”.

attribute

schedule

Python

helia_aot/cli/defines.py:158

schedule: ScheduleMode = Field(default=ScheduleMode.TABLE, description="Operator dispatch shape in the generated model: 'table' (default) keeps the runtime function-pointer table and per-node callback seam; 'static' emits straight-line direct calls (no table, no loop, no indirect dispatch).")

Operator dispatch shape emitted into <prefix>_model.c. table (default) keeps the runtime function-pointer table and per-node callback seam; static emits straight-line direct calls. Defaults to table.