Skip to content

docs: document common environment pitfalls #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JonesRoy3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document common environment pitfalls #549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ Existing nodes running the previous "reasoning-gym" Swarm can continue operating

Then restart your swarm.

### Common environment pitfalls

A few common issues when setting up RL Swarm:

- **Multiple Python versions** – make sure you are using the same Python version that you used to install dependencies (check with `python --version` or `python3 --version`).
- **Insufficient RAM** – if your machine has less memory than recommended, the process may be killed by the OS; try closing other applications or using a smaller model configuration if available.
- **Missing GPU drivers** – on GPU setups, ensure that your CUDA drivers and toolkit versions match the requirements in the documentation.

Checking these points early can save time when diagnosing installation or runtime errors.

## Instructions

### Run the Swarm
Expand Down