Installation

Just install from PyPI:

pip install sample-factory

SF is known to work on Linux and macOS. There is no Windows support at this time.

Install from sources

git clone git@github.com:alex-petrenko/sample-factory.git
cd sample-factory
pip install -e .

# or install with optional dependencies
pip install -e .[dev,mujoco,atari,vizdoom]

Environment support

To run Sample Factory with one of the available environment integrations, please refer to the corresponding documentation sections:

• Mujoco
• Atari
• ViZDoom
• DeepMind Lab
• Megaverse
• Envpool
• Isaac Gym
• Quad-Swarm-RL

Sample Factory allows users to easily add custom environments and models, refer to Customizing Sample Factory for more information.