Skip to content

docs: add overview of key log files #548

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 overview of key log files #548

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
Expand Up @@ -248,6 +248,15 @@ Therefore, you should do these actions in the following scenarios

- **Signed up with `email address`, generated `swarm.pem`, BUT lost `swarm.pem`** OR **You want to run multiple nodes at once**: run from scratch with the same email address and generate a new `swarm.pem`.
- **Signed up with `email address`, generated `swarm.pem`, kept `swarm.pem`** -> you can re-run a single node using this pair if you've still got them both.
### Log file overview

RL Swarm writes several log files to help you understand what is happening:

- `logs/swarm.log` – high-level lifecycle events for your node and training loop.
- `logs/prg_record.txt` – information about prediction markets and reward generation.
- `logs/swarm_launcher.log` – details from the launcher script and environment checks.

If something goes wrong, these files are usually the best first place to look before asking for help.

## Troubleshooting

Expand Down