1
Fork 0

docs: Repository structure

This commit is contained in:
Tibo De Peuter 2026-05-08 00:22:59 +02:00
parent 56afc7ec5d
commit 7eaf0da4cf
Signed by: tdpeuter
SSH key fingerprint: SHA256:u/h/LVoqKF1Iz02uOyxe6hcjmoZASCGV2HM0TG9ZMoU
4 changed files with 74 additions and 4 deletions

View file

@ -13,6 +13,21 @@ To set up the UV module, you can run the following command:
uv sync --frozen
```
## 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)
└── tests/ # Unit and integration tests
```
## Usage
For detailed instructions on how to use the project, please refer to the **[API Documentation](docs/README.md)**.