Skip to content

Predator Prey API Reference

The family dispatcher accepts open, alley_hunt, orchard, and random_forest, plus the upstream aliases predator_prey__open, predator_prey__alley_hunt, predator_prey__orchard, and predator_prey__random_forest.

Family dispatcher

Predator Prey substrate entrypoints.

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

Create a native PettingZoo ParallelEnv for a Predator Prey variant.

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

Create a PettingZoo AEC environment for a Predator Prey variant.

Predator Prey Alley Hunt substrate

Native PettingZoo implementation of Predator Prey: Alley Hunt.

PredatorPreyAlleyHuntConfig dataclass

Bases: PredatorPreyConfig

Configuration for the native Predator Prey Alley Hunt substrate.

PredatorPreyAlleyHuntParallelEnv

Bases: PredatorPreyParallelEnv

PettingZoo ParallelEnv for Predator Prey: Alley Hunt.

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

Create a native PettingZoo ParallelEnv for Predator Prey Alley Hunt.

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

Create a PettingZoo AEC environment for Predator Prey Alley Hunt.

Predator Prey Open substrate

Native PettingZoo implementation of Predator Prey: Open.

PredatorPreyOpenConfig dataclass

Bases: PredatorPreyConfig

Configuration for the native Predator Prey Open substrate.

PredatorPreyOpenParallelEnv

Bases: PredatorPreyParallelEnv

PettingZoo ParallelEnv for Predator Prey: Open.

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

Create a native PettingZoo ParallelEnv for Predator Prey Open.

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

Create a PettingZoo AEC environment for Predator Prey Open.

Predator Prey Orchard substrate

Native PettingZoo implementation of Predator Prey: Orchard.

PredatorPreyOrchardConfig dataclass

Bases: PredatorPreyConfig

Configuration for the native Predator Prey Orchard substrate.

PredatorPreyOrchardParallelEnv

Bases: PredatorPreyParallelEnv

PettingZoo ParallelEnv for Predator Prey: Orchard.

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

Create a native PettingZoo ParallelEnv for Predator Prey Orchard.

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

Create a PettingZoo AEC environment for Predator Prey Orchard.

Predator Prey Random Forest substrate

Native PettingZoo implementation of Predator Prey: Random Forest.

PredatorPreyRandomForestConfig dataclass

Bases: PredatorPreyConfig

Configuration for the native Predator Prey Random Forest substrate.

PredatorPreyRandomForestParallelEnv

Bases: PredatorPreyParallelEnv

PettingZoo ParallelEnv for Predator Prey: Random Forest.

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

Create a native PettingZoo ParallelEnv for Predator Prey Random Forest.

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

Create a PettingZoo AEC environment for Predator Prey Random Forest.