Skip to content

docs: add 'Before you start' checklist for node operators #556

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
LottR079 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add 'Before you start' checklist for node operators #556

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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# RL Swarm

RL Swarm is a peer-to-peer system for reinforcement learning. It allows you to train models collaboratively with others in the swarm, leveraging their collective intelligence. It is open source and permissionless, meaning you can run it on a consumer laptop at home or on a powerful GPU in the cloud. You can also connect your model to the Gensyn Testnet to receive an on-chain identity that tracks your progress over time.
## Before you start

Make sure you have:

* A machine with Docker and Docker Compose installed.
* At least 16GB of RAM and an SSD with enough free space for checkpoints and logs.
* A stable internet connection (RL Swarm will continuously download/upload model updates).

If you are running on a remote server, we recommend using a terminal multiplexer (such as `tmux` or `screen`) to keep your RL Swarm node running in the background.

> **Update -> CodeZero Swarm Environment**
> RL Swarm now powers **CodeZero**, the newest active environment on the Gensyn Testnet.
Expand Down