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).