factoriax.engine.envs

factoriax.engine.envs#

The environments, the wrappers, and the scenario registry.

  • base.py holds FactoriaxEnv, the core gymnax-compatible environment.

  • wrappers.py holds AutoResetWrapper, ActionMaskWrapper, and LogWrapper.

  • registry.py holds the scenario list and the make() factory.

  • easy_rocket.py and rocket.py hold two scenario definitions.

Modules

base

The environment object a training loop talks to, and the hooks that shape it.

common

The shared six-patch geometry and state predicates of the 16x16 scenarios.

easy_rocket

The Easy Rocket scenario: a small recipe book for eight machines and a rocket.

miner_curriculum

MinerBootstrap-v1: a sparse task that pays only on completion.

mining

The Mining scenario: an 8x8 benchmark for mining by hand.

registry

The scenario registry, which stands behind factoriax.make("<id>").

rocket

The Rocket scenario: an achievement reward with the rocket as the last step.

science_tiers

ScienceTiers-v1: a throughput reward over a science economy of three tiers.

wrappers

The wrappers that compose over a Factoriax environment.