From df699281290cb6d396864eaa8dde40cdf8e8a12f Mon Sep 17 00:00:00 2001 From: JibrilExe Date: Sat, 16 May 2026 09:30:31 +0200 Subject: [PATCH 1/4] fix; removed broken urls --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index a4f4ea0..9625f7e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation -## Design & architecture ([`/design`](./design/)) +## Design & architecture (`/design`) - [Actor/critic architecture](./design/actor-critic.md): Description of the actor-critic pipeline. - [Communication](./design/communication.md): Message propagation, Nerve-Net style. @@ -9,7 +9,7 @@ - [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/)) +## API reference (`/api`) - [Environment](./api/environment.md): MuJoCo environment interaction, state retrieval, and configuration. - [Simulate](./api/simulate.md): Simulation rendering. From c95e55cdd8219904f2074235661567bbff59c853 Mon Sep 17 00:00:00 2001 From: JibrilExe Date: Sat, 16 May 2026 09:39:35 +0200 Subject: [PATCH 2/4] feat: added missing api links --- docs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/README.md b/docs/README.md index f0d0be9..521cb28 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,3 +19,5 @@ If you are interested in the "how do I use it?" - [Tracking & Monitoring](./api/tracking.md): Setting up WandB and TensorBoard to monitor runs. - [Simulation](./api/simulation.md): Visualizing and evaluating models. - [Environment](./api/environment.md): MuJoCo environment interaction and configuration. +- [Analysis](./api/analysis.md): Comparing checkpoints and generating plots. +- [Evaluation](./api/evaluation.md): Evaluating checkpoints and comparing fault tolerance. \ No newline at end of file From 588a8887f6aae502614819d8a035d2d8aacb9d46 Mon Sep 17 00:00:00 2001 From: JibrilExe Date: Sat, 16 May 2026 09:49:06 +0200 Subject: [PATCH 3/4] feat: added model comparison to quick start --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index e9cabc6..45bdf63 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,9 @@ For detailed instructions on how to use the project, please refer to the **[API 3. **Simulate a trained model:** See [Simulation & Evaluation](docs/api/simulation.md). +4. **Compare fault tolerance of models:** + See [Checkpoint & Model Evaluation](docs/api/evaluation.md) + ## HPC See **[docs/HPC.md](docs/HPC.md)** for the full guide, including environment setup, cluster selection, interactive debugging, and job submission. From d50d71f830ba77bb7203367ad679bd0d09e6ffe1 Mon Sep 17 00:00:00 2001 From: JibrilExe Date: Sat, 16 May 2026 09:50:07 +0200 Subject: [PATCH 4/4] fix: defect -> fault --- docs/api/evaluation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/evaluation.md b/docs/api/evaluation.md index e5f91d6..45b880e 100644 --- a/docs/api/evaluation.md +++ b/docs/api/evaluation.md @@ -15,7 +15,7 @@ python scripts/train.py evaluation.evaluate_checkpoints=true evaluation.eval_max Results are saved to `runs//metrics/checkpoint_evaluation.csv` and synced to Weights & Biases if enabled. -## Cross-Model & Defect Tolerance Analysis +## Cross-Model & Fault Tolerance Analysis To measure how well different controllers handle damage (amputations), use `scripts/compare_models.py`. This script performs a grid search over models x morphologies.