docs: Repository structure
This commit is contained in:
parent
56afc7ec5d
commit
7eaf0da4cf
4 changed files with 74 additions and 4 deletions
15
README.md
15
README.md
|
|
@ -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)**.
|
||||
|
|
|
|||
Reference in a new issue