amaze.bin.main

Main executable for the AMaze library.

Provides and all-in-one entry point for simulation, evaluation and

visualization

Functions

main([sys_args])

Main function for the AMaze executable.

Classes

Options(maze, robot, controller, is_robot, ...)

Namespace containing all options for the AMaze main executable

class amaze.bin.main.Options(

maze: str | None = None,

robot: str | None = None,

controller: str | None = None,

is_robot: bool = False,

eval: ~pathlib.Path | None = None,

eval_inputs: ~pathlib.Path | None = None,

autostart: bool = True,

autoquit: bool = False,

restore_config: bool = True,

dt: float | None = None,

movie: ~pathlib.Path | None = None,

render: ~pathlib.Path | None = None,

trajectory: ~pathlib.Path | None = None,

width: int | None = None,

cell_width: int | None = None,

dark: bool = False,

colorblind: bool = False,

extensions: list[str] = <factory>,

verbose: int = 0,

)

Namespace containing all options for the AMaze main executable

maze: str | None = None

String description of the maze

See:

to_string() from_string()

robot: str | None = None

String description of the robot’s attributes

See:

to_string() from_string()

controller: str | None = None

Path to a pre-trained controller or name of built-in.

See:

builtin_controllers()

Note:

if a pre-trained controller is provided, the extension should be .zip

is_robot: bool = False

Activate “robot-mode” interface.

No global view of the maze, only local perceptions and the instantaneous and cumulative rewards

eval: Path | None = None

Path under which to store evaluation results

eval_inputs: Path | None = None

Path under which to store input evaluation results

autostart: bool = True

Whether to directly start moving the agent around

autoquit: bool = False

Whether to close the viewer once the simulation is done

restore_config: bool = True

Whether to load configuration (window position, maze, robot, …) from the persistent cache

dt: float | None = None

Specifies the duration of a timestep when using the viewer

movie: Path | None = None

Where to store the movie of the agent’s trajectory

render: Path | None = None

Where to render the maze

trajectory: Path | None = None

Where to render the agent’s trajectory

width: int | None = None

Width of images / videos

cell_width: int | None = None

Width of a maze cell, to ensure readable graphics

dark: bool = False

Whether to render a black on white maze (like the robots do)

colorblind: bool = False

Whether to use a colorblind-friendly palette

verbose: int = 0

Verbosity level of the program

amaze.bin.main.main(sys_args: Sequence[str] | str | None = None)

Main function for the AMaze executable. Allows delegate call.