docs: experiment reproduction
This commit is contained in:
parent
f26312583a
commit
9f99470557
3 changed files with 54 additions and 3 deletions
|
|
@ -4,6 +4,29 @@ Welcome to the Brittle Star project documentation. This codebase contains the im
|
|||
|
||||
For the core codebase, scripts, and contribution history, visit our [GitHub Repository](https://github.com/SELab-3-2026/SEL3-2026-Groep-4).
|
||||
|
||||
## Core Requirements & Guides
|
||||
|
||||
- **[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.
|
||||
- **[Reproducing Experiments](./api/training.md#reproducing-experiments)**: Best practices for reproducing past training runs using exact seeds, dependencies, and automatic metadata logging.
|
||||
- **[Repository Structure](#repository-structure)**: Overview of the directories and files within the codebase.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
```text
|
||||
.
|
||||
├── configs/ # Hydra configuration files (YAML)
|
||||
├── docs/ # Comprehensive documentation and API guides
|
||||
├── runs/ # Default output directory for Hydra and training artifacts
|
||||
├── scripts/ # High-level entrypoints for training, simulation, and evaluation
|
||||
├── src/
|
||||
│ ├── brittle_star_project/ # Core library and environment logic
|
||||
│ │ ├── evaluation/ # Checkpoint evaluation, rollout logic, and metrics persistence
|
||||
│ │ └── trainers/ # Training loop implementations (e.g., PPO)
|
||||
│ └── experiment_logger/ # Standalone logging package
|
||||
└── tests/ # Unit and integration tests
|
||||
```
|
||||
|
||||
## Design & architecture (`/design`)
|
||||
|
||||
If you are interested in the "why did you do it like this?"
|
||||
|
|
|
|||
Reference in a new issue