1
Fork 0

docs: add docs README landing/starting point

This commit is contained in:
Tibo De Peuter 2026-04-08 12:08:54 +02:00
parent d628bf1e9c
commit b9c0358b29
Signed by: tdpeuter
SSH key fingerprint: SHA256:u/h/LVoqKF1Iz02uOyxe6hcjmoZASCGV2HM0TG9ZMoU
2 changed files with 23 additions and 2 deletions

View file

@ -1,8 +1,11 @@
# Brittle Star
> What is the impact of different levels of controller-modularity on the learning-speed, coordination and tolerance for
defects (e.g. amputations) in brittle-star-like robots trained with Reinforcement Learning?
## Usage
### UV
### Local setup
To set up the UV module, you can run the following command:
@ -16,6 +19,10 @@ example command:
uv run src/train.py --model_name my_model --epochs 50 --batch_size 32
```
## HPC
### HPC setup
See **[docs/HPC.md](docs/HPC.md)** for the full guide, including environment setup, cluster selection, interactive debugging, and job submission.
## Documentation
Please find all documentation and a starting point for more information in [corresponding README](./docs/README.md).

14
docs/README.md Normal file
View file

@ -0,0 +1,14 @@
# Documentation
## Design & architecture ([`/design`](./design/))
- [Controllers](./design/controllers.md): Macroscopig brain toplogy, centralized, arm-level, segment-level.
- [MLP architecture](./design/mlp_architecture.md): Module wiring, state/action spaces, and actor-critic pipeline.
- [Communication](./design/communication.md): Message propagation, Nerve-Net style.
- [Learning algorithm](./design/learning_algorithm.md): RL techniques, i.e. PPO.
- [Reward function](./design/learning_algorithm.md): Goals, fitness tracking, and reward structures.
## API reference ([`/api`](./api/))
- [Environment](./api/environment.md): MuJoCo environment interaction, state retrieval, and configuration.
- [Simulate](./api/simulate.md): Simulation rendering.