Skip to content

defines

Defines API

Classes:

  • ModuleType

    Enum representing the type of exported module.

Copyright 2025 Ambiq. All Rights Reserved.

Classes

AnyCaseStrEnum

Case-insensitive string enumeration.

This is useful for parsing user input in a flexible manner.

LowerCaseStrEnum

Lowercase string enumeration.

UpperCaseStrEnum

Uppercase string enumeration.

ModuleType

Exported module type

Attributes:

  • neuralspot (str) –

    NeuralSpot module

  • zephyr (str) –

    Zephyr RTOS module

  • cmake (str) –

    CMake module

  • nsx (str) –

    NSX module (neuralspotx build system)

  • cmsis_pack (str) –

    CMSIS-Pack distribution (Open-CMSIS-Pack .pdsc)

ScheduleMode

Operator dispatch shape emitted into <prefix>_model.c.

Selects how model_init / model_run invoke each operator. Both modes preserve the public ABI (signatures, status enum, lifecycle latch and constant hydration); only the internal dispatch differs.

Attributes:

  • table (str) –

    Runtime function-pointer table iterated by a for loop, with the per-node ctx->callback instrumentation seam preserved. The integration shape for RTOS scheduling / PMU sampling.

  • static (str) –

    A straight-line sequence of direct calls to each operator's _run (and _init) symbol. No function-pointer table, no loop, no indirect dispatch — the AOT-correct shape that is fully optimizer-visible. The per-node callback seam is omitted.