RL-Factory

(β˜… 1,780)

Train your Agent model via our easy and efficient framework

  • .gitignore
  • install.sh
  • LICENSE
  • main_eval.sh
  • main_grpo.sh
  • main_grpo_megatron.sh
  • main_gspo_megatron.sh
  • main_ppo.sh
  • pyproject.toml
  • README.md
  • requirements.txt
  • requirements_sglang.txt
  • setup.py
  • swift_grpo.sh

# Installation Guide

1. Get the code
git clone https://github.com/Simple-Efficient/RL-Factory

Downloads the entire project code from GitHub to your computer.

cd RL-Factory

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip3 install accelerate bitsandbytes datasets deepspeed==0.16.4 einops flash-attn==2.7.0.post2 isort jsonlines loralib optimum packaging peft pynvml>=12.0.0 ray[default]==2.46.0 tensorboard torch==2.6.0 torchmetrics tqdm transformers==4.51.3 transformers_stream_generator wandb wheel

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install vllm==0.8.5 # Mainly for Qwen3 model support

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install "qwen-agent[code_interpreter]"

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install llama_index bs4 pymilvus infinity_client codetiming tensordict==0.6 omegaconf torchdata==0.10.0 hydra-core easydict dill python-multipart mcp==1.9.3

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f docker/Dockerfile.megatron -t rl-factory .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 rl-factory

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip3 install accelerate bitsandbytes datasets deepspeed==0.16.4 einops flash-attn==2.7.0.post2 isort jsonlines loralib optimum packaging peft pynvml>=12.0.0 ray[default]==2.46.0 tensorboard torch==2.6.0 torchmetrics tqdm transformers==4.51.3 transformers_stream_generator wandb wheel

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install vllm==0.8.5 # Mainly for Qwen3 model support

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install "qwen-agent[code_interpreter]"

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install llama_index bs4 pymilvus infinity_client codetiming tensordict==0.6 omegaconf torchdata==0.10.0 hydra-core easydict dill python-multipart mcp==1.9.3

Installs the package published on PyPI directly β€” no need to clone the source.

pip3 install -e . --no-deps

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation