Skip to content

defines

Classes

ModelArgs

Model configuration for the conversion process.

Attributes:

  • path (Path) –

    Path to the model file.

  • subgraph (int) –

    Subgraph index to process.

  • type (str | None) –

    Type of the model (e.g., tflite, litert)

  • name (str) –

    Name of the model.

  • description (str | None) –

    Optional description of the model.

  • version (str | None) –

    Version of the model.

ModuleArgs

Module configuration for the conversion process.

Attributes:

  • path (Path) –

    Base path for output module. Can also be a zip file. Defaults to "output.zip".

  • type (ModuleType) –

    Type of the module (e.g., neuralspot, zephyr). Defaults to neuralspot.

  • name (ValidModuleNameType) –

    Name of the module. Defaults to "helios_aot_nn".

  • prefix (ValidCVarNameType) –

    Prefix added to sources for unique namespace. Defaults to "aot".

TestArgs

Test configuration for the conversion process.

Attributes:

  • enabled (bool) –

    Include test case. Defaults to False.

  • tolerance (float | int) –

    Test tolerance. Defaults to 1.0.

MemoryArgs

Memory configuration for the conversion process.

Attributes:

  • planner (MemoryPlannerType) –

    Memory planner strategy. Defaults to greedy.

  • constraints (list[MemoryConstraint] | None) –

    Memory constraints (ordered by preference). Defaults to None.

PlatformArgs

Platform configuration for the conversion process.

Attributes:

  • name (str) –

    Target platform name. Defaults to "apollo510_evb".

DocumentationArgs

Documentation configuration for the generated module.

Attributes:

  • html (bool) –

    Generate html documentation site (experimental).

ConvertArgs

Configuration for the conversion process.

Attributes:

  • path (Path) –

    Path to yaml configuration.

  • model (ModelArgs) –

    Model configuration.

  • module (ModuleArgs) –

    Module configuration.

  • test (TestArgs) –

    Test configuration.

  • transforms (list[TransformSpec]) –

    Transforms configuration.

  • memory (MemoryArgs) –

    Memory configuration.

  • platform (PlatformArgs) –

    Target platform configuration.

  • verbose (int) –

    Verbosity level (0-3).

  • log_file (Path | None) –

    Optional log file path.