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. diff --git a/docs/README.md b/docs/README.md index 3c76684..521cb28 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation -## Design & architecture ([`/design`](./design/)) +## Design & architecture (`/design`) If you are interested in the "why did you do it like this?" @@ -11,7 +11,7 @@ If you are interested in the "why did you do it like this?" - [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`) If you are interested in the "how do I use it?" @@ -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 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.