1
Fork 0
This repository has been archived on 2026-08-15. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
2026SEL3-project-Brittle_St.../README.md
Tibo De Peuter 2d43f5e642
Apply suggestions from code review
Co-authored-by: RobinMeersman <77965843+RobinMeersman@users.noreply.github.com>
Co-authored-by: Tibo De Peuter <tibo.depeuter@telenet.be>
2026-04-09 15:02:02 +02:00

1.3 KiB

Brittle Star

Quick Start

Installation

To set up the UV module, you can run the following command:

uv sync --frozen

Configuration

  1. Copy the default configuration:

    cp configs/default_ppo.yaml configs/my_experiment.yaml
    
  2. Edit configs/my_experiment.yaml to set your WandB credentials:

    track: true  # Enable WandB logging
    wandb_entity: "your-wandb-username"  # Replace with your username/team
    wandb_project_name: "PPO-Modularity"
    
  3. (Optional) Login to WandB:

    uv run wandb login
    

Training

example command:

uv run python scripts/train.py

Or use a custom config file:

uv run python scripts/train.py --config configs/my_experiment.yaml

Override specific parameters:

uv run python scripts/train.py --learning-rate 0.001 --num-envs 32 --track

Logging

The training script uses a unified logging framework that:

  • Logs to WandB (when enabled)
  • Saves metrics to local disk (JSON files in runs/)
  • Displays progress in stdout

All experiment data is preserved locally, even if WandB is unavailable.

HPC

See docs/HPC.md for the full guide, including environment setup, cluster selection, interactive debugging, and job submission.