tdpeuter/2026SEL3-project-Brittle_Star_Controller_Modularity
tdpeuter/2026SEL3-project-Brittle_Star_Controller_Modularity
Archived
1
Fork 0
Code Issues Releases Activity

docs: cleanup and extra references

Browse source
This commit is contained in:
Tibo De Peuter 2026-05-20 15:00:50 +02:00
parent 511c3ebd95
commit f569f4c008
5 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -9,6 +9,7 @@ For the core codebase, scripts, and contribution history, visit our [GitHub Repo
- **[Installation Instructions](./DEVELOPMENT.md)**: Steps to set up your development environment locally or in a devcontainer using `uv`, including GPU configuration. For High-Performance Computing (HPC) setup details, see the **[HPC Guide](./HPC.md)**.
- **[How to Run Experiments](./api/training.md)**: A complete guide on running training jobs, setting custom hyperparameters, and overriding config options using Hydra.
- **[Results & Reproduction](./api/reproduction.md)**: Guide on how to access our public WandB training runs table and reproduce our training and evaluation phases (determining the best checkpoint vs. comparing architectures).
- **[Contribution Guidelines](./CONTRIBUTING.md)**: Standards, rules, and best practices for developing and adding code to the repository.
- **[Repository Structure](#repository-structure)**: Overview of the directories and files within the codebase.
## Repository Structure