Skip to content

Factory Commons API Reference

Family dispatcher

Factory Commons substrate family entrypoints.

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

Create a native PettingZoo ParallelEnv for a Factory Commons variant.

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

Create a PettingZoo AEC environment for a Factory Commons variant.

Either-Or

Native PettingZoo implementation of Factory Commons: Either-Or.

FactoryCommonsEitherOrConfig dataclass

Configuration for the native Factory Commons Either-Or substrate.

FactoryCommonsEitherOrParallelEnv

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

PettingZoo ParallelEnv for Factory Commons Either-Or.

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

Create the native Factory Commons Either-Or parallel environment.

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

Create the native Factory Commons Either-Or AEC environment.