From b9c0358b295d88101622a3ceba820cd695883750 Mon Sep 17 00:00:00 2001 From: Tibo De Peuter Date: Wed, 8 Apr 2026 12:08:54 +0200 Subject: [PATCH] docs: add docs README landing/starting point --- README.md | 11 +++++++++-- docs/README.md | 14 ++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 085f3d5..a858341 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..8c8d659 --- /dev/null +++ b/docs/README.md @@ -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.