GRID Docs | General Robotics

from grid_nexus_program import program

Signature

program(
    fn: Callable[..., Any] | None = None,
    *,
    validate_models: bool = True,
) -> ZenohProgram | Callable[[Callable[..., Any]], ZenohProgram]

Capture a restricted Python function into a staged IR. Robot and Cortex annotations identify handles that the compiler understands. They remain ordinary, explicit Python parameters and may appear anywhere in the signature. All other parameters become program inputs; annotations on those parameters are optional. A leading function docstring is preserved on the returned ZenohProgram and is not lowered as an executable statement.

default:"True"

If True (default), every cortex.run("name", ...) call is checked against the grid_cortex_client registry at compile time — unknown model names, unknown/misspelled keyword arguments, and missing required arguments all raise ProgramCaptureError. Set False for tests that use placeholder model names to exercise graph/codegen mechanics.