tdpeuter/2026SEL3-project-Brittle_Star_Controller_Modularity
tdpeuter/2026SEL3-project-Brittle_Star_Controller_Modularity
Archived
1
Fork 0
Code Issues Releases Activity

Deployed f569f4c with MkDocs version: 1.6.1

Browse source
This commit is contained in:
github-actions[bot] 2026-05-20 13:05:42 +00:00
parent f1a349ed55
commit 3cd3e9ea81
56 changed files with 9292 additions and 11367 deletions
Download patch file Download diff file Expand all files Collapse all files

682
api/simulation/index.html
View file

@ -12,7 +12,7 @@
<link rel="prev" href="../evaluation/">
<link rel="next" href="../tracking/">
<link rel="next" href="../analysis/">
@ -23,7 +23,7 @@
<title>Simulation & Evaluation - Brittle Star Project</title>
<title>Interactive Simulation & Visualization - Brittle Star Project</title>
@ -66,7 +66,7 @@
<div data-md-component="skip">
<a href="#simulation-evaluation" class="md-skip">
<a href="#interactive-simulation-visualization" class="md-skip">
Skip to content
</a>
@ -102,7 +102,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Simulation &amp; Evaluation
Interactive Simulation & Visualization
</span>
</div>
@ -205,7 +205,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -224,15 +224,62 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Design & Architecture
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Design & Architecture
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<a href="../../design/actor-critic/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
Actor-Critic Architecture
@ -244,22 +291,23 @@
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<a href="../../design/communication/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
Communication Scheme
@ -271,22 +319,23 @@
</li>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<a href="../../design/controllers/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
Modularity & Topology
@ -298,6 +347,98 @@
</li>
<li class="md-nav__item">
<a href="../../design/input_action_spaces/" class="md-nav__link">
<span class="md-ellipsis">
Input & Action Spaces
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../design/learning_algorithm/" class="md-nav__link">
<span class="md-ellipsis">
Reinforcement Learning Algorithm
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../design/reward_function/" class="md-nav__link">
<span class="md-ellipsis">
Reward Function & Observation Space
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -316,17 +457,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Api
API Reference
@ -337,12 +478,12 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Api
API Reference
</label>
@ -355,14 +496,14 @@
<li class="md-nav__item">
<a href="../analysis/" class="md-nav__link">
<a href="../environment/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
Brittle Star Environment
@ -383,14 +524,42 @@
<li class="md-nav__item">
<a href="../environment/" class="md-nav__link">
<a href="../training/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
@ -418,7 +587,7 @@
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
Checkpoint & Model Evaluation
@ -455,7 +624,7 @@
<span class="md-ellipsis">
Simulation &amp; Evaluation
Interactive Simulation & Visualization
@ -473,7 +642,7 @@
<span class="md-ellipsis">
Simulation &amp; Evaluation
Interactive Simulation & Visualization
@ -558,14 +727,14 @@
<li class="md-nav__item">
<a href="../tracking/" class="md-nav__link">
<a href="../analysis/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
Analysis & Plotting Tools
@ -586,14 +755,14 @@
<li class="md-nav__item">
<a href="../training/" class="md-nav__link">
<a href="../reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
Results & Reproduction
@ -620,62 +789,15 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Design
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Design
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../design/actor-critic/" class="md-nav__link">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
Actor-Critic Architecture
HPC Guide
@ -687,23 +809,22 @@
</li>
<li class="md-nav__item">
<a href="../../design/communication/" class="md-nav__link">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Communication scheme (Message Passing)
Contribution Guidelines
@ -715,23 +836,22 @@
</li>
<li class="md-nav__item">
<a href="../../design/controllers/" class="md-nav__link">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Levels of modularity and topology
Development Guide
@ -743,372 +863,6 @@
</li>
<li class="md-nav__item">
<a href="../../design/input_action_spaces/" class="md-nav__link">
<span class="md-ellipsis">
Input (state) and output (action) spaces
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../design/learning_algorithm/" class="md-nav__link">
<span class="md-ellipsis">
Reinforcement Learning Algorithm
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../design/reward_function/" class="md-nav__link">
<span class="md-ellipsis">
Reward function and observation space
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Scripts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Scripts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
<label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
<span class="md-ellipsis">
Analysis
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7_1">
<span class="md-nav__icon md-icon"></span>
Analysis
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../scripts/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Src
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Src
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1" >
<label class="md-nav__link" for="__nav_8_1" id="__nav_8_1_label" tabindex="0">
<span class="md-ellipsis">
Experiment logger
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8_1">
<span class="md-nav__icon md-icon"></span>
Experiment logger
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../src/experiment_logger/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
@ -1197,8 +951,8 @@
<h1 id="simulation-evaluation">Simulation &amp; Evaluation</h1>
<p>The simulation pipeline allows you to visualize trained models and evaluate their performance under various conditions.</p>
<h1 id="interactive-simulation-visualization">Interactive Simulation &amp; Visualization</h1>
<p>The simulation pipeline allows you to visualize trained models and observe their behavior under various conditions.</p>
<h2 id="overview">Overview</h2>
<p>The simulation pipeline is metadata-driven. Training-specific configurations (morphology, arena, environment, etc.) are automatically loaded from the <code>_metadata.yaml</code> file associated with the model checkpoint.</p>
<h2 id="basic-simulation">Basic Simulation</h2>
@ -1220,7 +974,7 @@
</code></pre></div>
<p>Videos and evaluation metadata are stored in timestamped folders alongside the model:
<code>runs/your_run/final_model_evaluations/eval_&lt;timestamp&gt;/simulation.mp4</code></p>
<p>For batch evaluation and cross-model comparison, see the <strong><a href="../evaluation/">Evaluation Guide</a></strong>.</p>
<p>For batch evaluation, checkpoint analysis, and cross-model architecture comparisons, see the <strong><a href="../evaluation/">Checkpoint &amp; Model Evaluation Guide</a></strong>.</p>