Skip to content

Boat Race API Reference

Family dispatcher

Boat Race substrate family entrypoints.

parallel_env(sub_substrate: str = 'eight_races', **kwargs: Any)

Create a native PettingZoo ParallelEnv for a Boat Race variant.

env(sub_substrate: str = 'eight_races', **kwargs: Any)

Create a PettingZoo AEC environment for a Boat Race variant.

Boat Race Eight Races substrate

Native PettingZoo implementation of Boat Race: Eight Races.

BoatRaceEightRacesConfig dataclass

Configuration for Boat Race: Eight Races.

BoatRaceEightRacesParallelEnv

Bases: ParallelEnv[Agent, dict[str, ndarray], int]

PettingZoo ParallelEnv for Boat Race: Eight Races.

parallel_env(render_mode: RenderMode = None, config: BoatRaceEightRacesConfig | None = None, **config_overrides: Any) -> BoatRaceEightRacesParallelEnv

Create the native Boat Race: Eight Races ParallelEnv.

env(render_mode: RenderMode = None, **kwargs: Any)

Create the native Boat Race: Eight Races AEC env.