1
Fork 0

Deployed f569f4c with MkDocs version: 1.6.1

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

1246
404.html

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -9,10 +9,10 @@
<link rel="prev" href="../analysis/">
<link rel="prev" href="../../design/reward_function/">
<link rel="next" href="../evaluation/">
<link rel="next" href="../training/">
@ -23,7 +23,7 @@
<title>Brittle star environment - Brittle Star Project</title>
<title>Brittle Star Environment - Brittle Star Project</title>
@ -102,7 +102,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Brittle star environment
Brittle Star Environment
</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>
@ -352,34 +493,6 @@
<li class="md-nav__item">
<a href="../analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
@ -399,7 +512,7 @@
<span class="md-ellipsis">
Brittle star environment
Brittle Star Environment
@ -417,7 +530,7 @@
<span class="md-ellipsis">
Brittle star environment
Brittle Star Environment
@ -491,42 +604,14 @@
<li class="md-nav__item">
<a href="../evaluation/" class="md-nav__link">
<a href="../training/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
Training Models
@ -554,7 +639,7 @@
<span class="md-ellipsis">
Tracking &amp; Monitoring
Tracking & Monitoring
@ -575,14 +660,98 @@
<li class="md-nav__item">
<a href="../training/" class="md-nav__link">
<a href="../evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -609,62 +778,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
@ -676,23 +798,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
@ -704,23 +825,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
@ -732,372 +852,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>

View file

@ -9,7 +9,7 @@
<link rel="prev" href="../environment/">
<link rel="prev" href="../tracking/">
<link rel="next" href="../simulation/">
@ -102,7 +102,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
Checkpoint & Model Evaluation
</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
@ -427,7 +596,7 @@
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
Checkpoint & Model Evaluation
@ -445,7 +614,7 @@
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
Checkpoint & Model Evaluation
@ -560,7 +729,7 @@
<span class="md-ellipsis">
Simulation &amp; Evaluation
Interactive Simulation & Visualization
@ -581,14 +750,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
@ -609,14 +778,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
@ -643,62 +812,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
@ -710,23 +832,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
@ -738,23 +859,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
@ -766,372 +886,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>
@ -1312,6 +1066,8 @@
<span class="w"> </span>evaluation.eval_max_steps<span class="o">=</span><span class="m">2000</span>
</code></pre></div>
<p>This script scans the <code>checkpoints/</code> directory of the specified run and evaluates every <code>.flax</code> file it finds using the model's training morphology.</p>
<hr />
<p>For a step-by-step walkthrough on using these evaluation phases to reproduce our project results, see the <strong><a href="../reproduction/">Results &amp; Reproduction Guide</a></strong>.</p>

1220
api/reproduction/index.html Normal file

File diff suppressed because it is too large Load diff

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>

File diff suppressed because it is too large Load diff

View file

@ -9,10 +9,10 @@
<link rel="prev" href="../tracking/">
<link rel="prev" href="../environment/">
<link rel="next" href="../../design/actor-critic/">
<link rel="next" href="../tracking/">
@ -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>
@ -354,34 +495,6 @@
<li class="md-nav__item">
<a href="../analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../environment/" class="md-nav__link">
@ -390,91 +503,7 @@
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
Brittle Star Environment
@ -641,60 +670,6 @@
</ul>
</nav>
</li>
<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>
@ -702,14 +677,14 @@
<li class="md-nav__item">
<a href="../../design/actor-critic/" class="md-nav__link">
<a href="../tracking/" class="md-nav__link">
<span class="md-ellipsis">
Actor-Critic Architecture
Tracking & Monitoring
@ -730,14 +705,14 @@
<li class="md-nav__item">
<a href="../../design/communication/" class="md-nav__link">
<a href="../evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Communication scheme (Message Passing)
Checkpoint & Model Evaluation
@ -758,14 +733,14 @@
<li class="md-nav__item">
<a href="../../design/controllers/" class="md-nav__link">
<a href="../simulation/" class="md-nav__link">
<span class="md-ellipsis">
Levels of modularity and topology
Interactive Simulation & Visualization
@ -786,14 +761,14 @@
<li class="md-nav__item">
<a href="../../design/input_action_spaces/" class="md-nav__link">
<a href="../analysis/" class="md-nav__link">
<span class="md-ellipsis">
Input (state) and output (action) spaces
Analysis & Plotting Tools
@ -814,42 +789,14 @@
<li class="md-nav__item">
<a href="../../design/learning_algorithm/" class="md-nav__link">
<a href="../reproduction/" 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
Results & Reproduction
@ -876,109 +823,15 @@
<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">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
HPC Guide
@ -990,22 +843,6 @@
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@ -1013,109 +850,15 @@
<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">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
Contribution Guidelines
@ -1127,19 +870,30 @@
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</ul>
</nav>
</span>
</a>
</li>
@ -1269,6 +1023,7 @@
<p>This guide covers how to configure and run training experiments for the Brittle Star project using Hydra-based configurations.</p>
<h2 id="configuration">Configuration</h2>
<p>The project uses a modular configuration system powered by <a href="https://hydra.cc/">Hydra</a>. Instead of passing many command-line flags, you select and override configuration groups.</p>
<p>For a detailed guide on the structure, validation, and usage of our Hydra configuration files, see the <strong><a href="../../configs/">Brittle Star Configuration System Guide</a></strong>.</p>
<h3 id="creating-a-custom-experiment">Creating a Custom Experiment</h3>
<ol>
<li>
@ -1301,31 +1056,9 @@
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>scripts/train.py<span class="w"> </span>evaluation.evaluate_checkpoints<span class="o">=</span><span class="nb">true</span>
</code></pre></div>
<h2 id="reproducing-experiments">Reproducing Experiments</h2>
<p>To ensure scientific validity and allow other researchers to reproduce your training runs, follow these steps:</p>
<ol>
<li>
<p><strong>Lock Environment Dependencies</strong>:
Always use the exact environment lockfile when running experiments. Run:
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>sync<span class="w"> </span>--frozen
</code></pre></div>
This guarantees that the same package versions (including JAX, Flax, and MuJoCo) are used.</p>
</li>
<li>
<p><strong>Save and Locate Configuration Metadata</strong>:
Every time you start a training run, the configuration is fully resolved by Hydra and saved as a metadata YAML file:</p>
</li>
<li>For checkpointed steps: <code>runs/&lt;run_dir&gt;/checkpoints/&lt;prefix&gt;_step_&lt;step&gt;_metadata.yaml</code></li>
<li>For the final model: <code>runs/&lt;run_dir&gt;/final_model_metadata.yaml</code></li>
</ol>
<p>This metadata file contains every active hyperparameter (e.g., learning rate, morphology configuration, PPO parameters, etc.) for that specific run.</p>
<ol>
<li><strong>Re-Run with Pinning</strong>:
To reproduce a run, execute the training script with the configuration parameters specified in the metadata file, making sure to reuse the same seed:
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>scripts/train.py<span class="w"> </span><span class="nv">experiment</span><span class="o">=</span>my_experiment<span class="w"> </span>ppo.learning_rate<span class="o">=</span><span class="m">0</span>.001<span class="w"> </span>experiment.seed<span class="o">=</span><span class="m">42</span>
</code></pre></div></li>
</ol>
<p>For detailed steps on how to reproduce training runs, locate run configuration metadata, or reproduce our experiments using Weights &amp; Biases (WandB), see the <strong><a href="../reproduction/">Results &amp; Reproduction Guide</a></strong>.</p>
<hr />
<p>For more details on evaluation metrics and comparison tools, see <a href="../evaluation/">Evaluation</a>.</p>
<p>For more details on evaluation metrics and comparison tools, see <a href="../evaluation/">Checkpoint &amp; Model Evaluation</a>.</p>
<p>For more details on tracking your experiments, see <a href="../tracking/">Tracking &amp; Monitoring</a>.</p>

View file

@ -0,0 +1,22 @@
# Centralized Actor-Critic Architecture
# Baseline configuration with a single global sensor and motor.
# Default values are defined in CentralizedConfig dataclass.
# Use this configuration for standard PPO experiments.
name: "centralized"
sensor:
hidden_dims: [300, 300, 300]
activation: "tanh"
motor:
hidden_dims: []
activation: "tanh"
feature_extractor:
hidden_dims: [300, 300, 300]
activation: "tanh"
critic:
hidden_dims: []
activation: "tanh"

View file

@ -0,0 +1,32 @@
# Decentralized Actor Architecture (NerveNet-MLP variant)
# Multi-agent/distributed configuration using local sensors, propagators, and motors.
# Default values are defined in DecentralizedConfig dataclass.
# Use this configuration for decentralized execution experiments.
name: "decentralized"
sensor:
hidden_dims: [300, 300, 300]
activation: "tanh"
propagator:
hidden_dims: [300, 300, 300]
activation: "tanh"
motor:
hidden_dims: []
activation: "tanh"
feature_extractor:
hidden_dims: [300, 300, 300]
activation: "tanh"
critic:
hidden_dims: []
activation: "tanh"
# Synchronous message-passing rounds per control step
message_passing_steps: 4
# Connectivity topology (e.g., ring, fully_connected)
topology_type: "fully_connected"

View file

@ -0,0 +1,8 @@
# Default Arena Configuration
# Base aquarium environment settings.
size: [10.0, 5.0]
sand_ground_color: true
attach_target: true
wall_height: 1.5
wall_thickness: 0.1

View file

@ -0,0 +1,71 @@
# Custom Main Configuration
#
# Use with:
# uv run python scripts/train.py --config-name main_config_custom
#
# This keeps the project defaults intact while giving you a single custom
# training entrypoint you can edit freely.
defaults:
- brittle_star_config
- experiment: base
- logging: default
- evaluation: default
- ppo: default
- architecture: centralized
- morphology: 5_arms_full
- arena: default
- environment: directed_locomotion
- simulation: default
- _self_
morphology:
morph_mode: CENTRALIZED
experiment:
exp_name: "final-models/centralized/"
seed: 42
torch_deterministic: true
cuda: true
logging:
track: true
save_model: true
save_checkpoints: true
upload_final_model: true
upload_checkpoints: true
checkpoint_frequency: 20
wandb_project_name: "final-models"
evaluation:
evaluate_checkpoints: true
eval_max_steps: 2000
eval_seed: 0
ppo:
learning_rate: 0.0001
total_timesteps: 16384000
num_envs: 128
num_steps: 64
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 32
update_epochs: 4
norm_adv: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.001
vf_coef: 1.0
max_grad_norm: 0.5
target_kl: 0.02
environment:
simulation_time: 100000.0
target_distance: 3.0
hydra:
job:
chdir: true
run:
dir: ${experiment.base_run_dir}/${experiment.exp_name}/${now:%Y-%m-%d}/${now:%H-%M-%S}

View file

@ -0,0 +1,2 @@
simulation_time: 50000.0
target_distance: 3.0

View file

@ -0,0 +1,12 @@
# Directed Locomotion Environment
# Baseline task setting.
task: DIRECTED_LOCOMOTION
simulation_time: 100000.0
num_physics_steps_per_control_step: 10
time_scale: 2
camera_ids: [0, 1]
render_size: [480, 640]
joint_randomization_noise_scale: 0.0
target_distance: 3.0
light_perlin_noise_scale: 0

View file

@ -0,0 +1,12 @@
# Light Escape Environment
# Advanced task requiring movement away from light source.
task: LIGHT_ESCAPE
simulation_time: 100000.0
num_physics_steps_per_control_step: 10
time_scale: 2
camera_ids: [0, 1]
render_size: [480, 640]
joint_randomization_noise_scale: 0.0
target_distance: 3.0
light_perlin_noise_scale: 200 # Must be integer factor of 200

View file

@ -0,0 +1,8 @@
# Default Evaluation Configuration
# Settings used for checkpoint evaluation during training.
evaluate_checkpoints: false
# Max number of control steps during evaluation rollout.
eval_max_steps: 2000
# Seed for deterministic evaluation reset.
eval_seed: 0

View file

@ -0,0 +1,23 @@
# @package evaluation
# Configuration for the models used in the poster comparison.
# Standard evaluation settings
evaluate_checkpoints: false
eval_max_steps: 5000
eval_seed: 0
# Cross-model comparison settings
# We use 10 episodes to get a more robust average for the final poster results.
comparison_base_seed: 0
comparison_num_episodes: 2
comparison_output_csv: "runs/evaluation/comparison.csv"
# Paths to the .cleanrl_model files to be compared (relative to workspace root).
comparison_models:
- "runs/input-space-2-arms/2026-05-02/08-14-58/final_model.flax"
# Path to the morphologies to evaluate against.
comparison_morphologies:
- "configs/morphology/5_arms_full.yaml"
- "configs/morphology/3_arms.yaml"
- "configs/morphology/2_arms.yaml"

View file

@ -0,0 +1,7 @@
# Base Experiment Configuration
# Default values align with ExperimentConfig dataclass.
exp_name: "brittle_star_ppo"
seed: 1
torch_deterministic: true
cuda: true

View file

@ -0,0 +1,7 @@
# Testing Experiment Configuration
# Quick experiment for local development/testing.
exp_name: "dev_test_brittle_star"
seed: 42
torch_deterministic: true
cuda: true

View file

@ -0,0 +1,7 @@
# HPC Smoke Test Configuration
# Uses minimal settings but simulates HPC environment.
exp_name: "hpc_smoke_test"
seed: 123
torch_deterministic: true
cuda: true

View file

@ -0,0 +1,6 @@
# Testing chicken dinner 4 but further distance.
exp_name: "long2arm"
seed: 123
torch_deterministic: true
cuda: true

View file

@ -0,0 +1,74 @@
# Custom Main Configuration
#
# Use with:
# uv run python scripts/train.py --config-name main_config_custom
#
# This keeps the project defaults intact while giving you a single custom
# training entrypoint you can edit freely.
defaults:
- brittle_star_config
- experiment: base
- logging: default
- evaluation: default
- ppo: default
- architecture: decentralized
- morphology: 5_arms_full
- arena: default
- environment: directed_locomotion
- simulation: default
- _self_
architecture:
topology_type: "fully_connected"
morphology:
morph_mode: FULLY_CONNECTED
experiment:
exp_name: "final-models/fully-connected/"
seed: 42
torch_deterministic: true
cuda: true
logging:
track: true
save_model: true
save_checkpoints: true
upload_final_model: true
upload_checkpoints: true
checkpoint_frequency: 20
wandb_project_name: "final-models"
evaluation:
evaluate_checkpoints: true
eval_max_steps: 2000
eval_seed: 0
ppo:
learning_rate: 0.0001
total_timesteps: 16384000
num_envs: 128
num_steps: 64
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 32
update_epochs: 4
norm_adv: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.001
vf_coef: 1.0
max_grad_norm: 0.5
target_kl: 0.02
environment:
simulation_time: 100000.0
target_distance: 3.0
hydra:
job:
chdir: true
run:
dir: ${experiment.base_run_dir}/${experiment.exp_name}/${now:%Y-%m-%d}/${now:%H-%M-%S}

1013
configs/index.html Normal file

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,13 @@
# Default Logging Configuration
# Offline local-only setup (WandB disabled).
track: false
wandb_project_name: "PPO-Modularity"
wandb_entity: "SEL3-2026-Groep-4"
capture_video: false
save_model: true
save_checkpoints: true
checkpoint_frequency: 100
upload_final_model: false
upload_checkpoints: false
hf_entity: ""

9
configs/logging/hpc.yaml Normal file
View file

@ -0,0 +1,9 @@
track: true
wandb_project_name: "hpc-default"
wandb_entity: "SEL3-2026-Groep-4"
save_model: true
save_checkpoints: true
upload_final_model: true
upload_checkpoints: true
checkpoint_frequency: 100
hf_entity: ""

View file

@ -0,0 +1,13 @@
# WandB Enabled Logging Configuration
# For production/cloud experiments with weights synced.
track: true
wandb_project_name: "default-project"
wandb_entity: "SEL3-2026-Groep-4"
capture_video: false
save_model: true
save_checkpoints: true
checkpoint_frequency: 100
upload_final_model: true
upload_checkpoints: false
hf_entity: ""

23
configs/main_config.yaml Normal file
View file

@ -0,0 +1,23 @@
# Brittle Star Project - Main Configuration
# This file defines the default composition of the hierarchical configuration.
# Sub-configs are loaded from the relative directories.
defaults:
- brittle_star_config
- experiment: base
- logging: default
- evaluation: default
- ppo: default
- architecture: centralized
- morphology: 5_arms_full
- arena: default
- environment: directed_locomotion
- obs_bounds: default
- simulation: default
- _self_
hydra:
job:
chdir: True
run:
dir: ${experiment.base_run_dir}/${experiment.exp_name}/${now:%Y-%m-%d}/${now:%H-%M-%S}

View file

@ -0,0 +1,5 @@
# 2 Arms Morphology Configuration
segments_per_arm: [4, 0, 4, 0, 0]
use_p_control: true
use_torque_control: false

View file

@ -0,0 +1,6 @@
# 2 Arms Morphology Configuration
segments_per_arm: [4, 0, 4, 0, 0]
use_p_control: true
use_torque_control: false
morph_mode: FULLY_CONNECTED

View file

@ -0,0 +1,6 @@
# 3 Arms Morphology Configuration
# Symmetric amputation (arms 1 and 3 removed).
segments_per_arm: [4, 0, 4, 0, 4]
use_p_control: true
use_torque_control: false

View file

@ -0,0 +1,6 @@
# 5 Arms Full Morphology Configuration
# Baseline 5-arm brittle star.
segments_per_arm: [4, 4, 0, 4, 4]
use_p_control: true
use_torque_control: false

View file

@ -0,0 +1,6 @@
# 5 Arms Full Morphology Configuration
# Baseline 5-arm brittle star.
segments_per_arm: [4, 4, 4, 4, 4]
use_p_control: true
use_torque_control: false

View file

@ -0,0 +1,7 @@
# 5 Arms Full Morphology Configuration
# Baseline 5-arm brittle star.
segments_per_arm: [4, 4, 4, 4, 4]
use_p_control: true
use_torque_control: false
morph_mode: FULLY_CONNECTED

View file

@ -0,0 +1,6 @@
# Partial Amputation Configuration
# Random partial amputation for robustness testing.
segments_per_arm: [4, 2, 4, 4, 4]
use_p_control: true
use_torque_control: false

View file

@ -0,0 +1 @@
# Defaults provided by dataclass

View file

@ -0,0 +1,16 @@
anneal_lr: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.001
gae_lambda: 0.95
gamma: 0.99
learning_rate: 0.0001
max_grad_norm: 0.5
norm_adv: true
num_envs: 32
num_minibatches: 32
num_steps: 64
target_kl: 0.02
total_timesteps: 12288000
update_epochs: 4
vf_coef: 1.0

16
configs/ppo/debug.yaml Normal file
View file

@ -0,0 +1,16 @@
learning_rate: 0.0003
total_timesteps: 409600
num_envs: 32
num_steps: 32
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 32
update_epochs: 4
norm_adv: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.005
vf_coef: 1.0
max_grad_norm: 0.5
target_kl: null

19
configs/ppo/default.yaml Normal file
View file

@ -0,0 +1,19 @@
# Default PPO Configuration
# Standard hyperparams from original codebase.
learning_rate: 0.00025
total_timesteps: 10000000
num_envs: 100
num_steps: 128
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 4
update_epochs: 4
norm_adv: true
clip_coef: 0.1
clip_vloss: true
ent_coef: 0.01
vf_coef: 0.5
max_grad_norm: 0.5
target_kl: null

View file

@ -0,0 +1,16 @@
learning_rate: 0.0003
total_timesteps: 1228800
num_envs: 32
num_steps: 64
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 32
update_epochs: 4
norm_adv: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.005
vf_coef: 1.0
max_grad_norm: 0.5
target_kl: null

View file

@ -0,0 +1,19 @@
# Fast PPO Configuration
# Lower timestep count for quick iterations/testing.
learning_rate: 0.0005
total_timesteps: 1024
num_envs: 32
num_steps: 32
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 4
update_epochs: 4
norm_adv: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.01
vf_coef: 0.5
max_grad_norm: 0.5
target_kl: null

19
configs/ppo/stable.yaml Normal file
View file

@ -0,0 +1,19 @@
# Stable PPO Configuration
# Standard hyperparams with lower LR and larger batch.
learning_rate: 0.0001
total_timesteps: 10000000
num_envs: 100
num_steps: 256
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 8
update_epochs: 4
norm_adv: true
clip_coef: 0.1
clip_vloss: true
ent_coef: 0.01
vf_coef: 0.5
max_grad_norm: 0.5
target_kl: null

74
configs/ring-final.yaml Normal file
View file

@ -0,0 +1,74 @@
# Custom Main Configuration
#
# Use with:
# uv run python scripts/train.py --config-name main_config_custom
#
# This keeps the project defaults intact while giving you a single custom
# training entrypoint you can edit freely.
defaults:
- brittle_star_config
- experiment: base
- logging: default
- evaluation: default
- ppo: default
- architecture: decentralized
- morphology: 5_arms_full
- arena: default
- environment: directed_locomotion
- simulation: default
- _self_
architecture:
topology_type: "ring"
morphology:
morph_mode: RING
experiment:
exp_name: "final-models/ring/"
seed: 42
torch_deterministic: true
cuda: true
logging:
track: true
save_model: true
save_checkpoints: true
upload_final_model: true
upload_checkpoints: true
checkpoint_frequency: 20
wandb_project_name: "final-models"
evaluation:
evaluate_checkpoints: true
eval_max_steps: 2000
eval_seed: 0
ppo:
learning_rate: 0.0001
total_timesteps: 16384000
num_envs: 128
num_steps: 64
anneal_lr: true
gamma: 0.99
gae_lambda: 0.95
num_minibatches: 32
update_epochs: 4
norm_adv: true
clip_coef: 0.2
clip_vloss: true
ent_coef: 0.001
vf_coef: 1.0
max_grad_norm: 0.5
target_kl: 0.02
environment:
simulation_time: 100000.0
target_distance: 3.0
hydra:
job:
chdir: true
run:
dir: ${experiment.base_run_dir}/${experiment.exp_name}/${now:%Y-%m-%d}/${now:%H-%M-%S}

View file

@ -0,0 +1,26 @@
# Default Simulation Settings
# These values are used by scripts/simulate.py
# Path to the trained model (optional)
model_path: null
# Script behavior
headless: false
# In headless mode this is required; in viewer mode null means "infinite".
max_steps: null
# Optional: override morphology for amputation experiments.
# Points to a morphology config YAML file (e.g. configs/morphology/3_arms.yaml).
# If null, the training morphology from the model's metadata is used.
morphology_override: null
# Video recording (requires [evaluation] extra)
record_video: false
# When null, video is saved in a per-model evaluation folder alongside the model.
video_output_path: null
# Camera ID to use for video recording (1 is usually the close-up camera)
camera_id: 1
# Optional override for the metadata YAML file path.
# If null, the script looks for `<model_name>_metadata.yaml` alongside the model_path.
metadata_path: null

View file

@ -9,7 +9,7 @@
<link rel="prev" href="../../api/training/">
<link rel="prev" href="../..">
<link rel="next" href="../communication/">
@ -205,7 +205,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -222,309 +222,6 @@
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Api
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -538,17 +235,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Design
Design & Architecture
@ -559,12 +256,12 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Design
Design & Architecture
</label>
@ -670,7 +367,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -698,7 +395,7 @@
<span class="md-ellipsis">
Levels of modularity and topology
Modularity & Topology
@ -726,7 +423,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -782,7 +479,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -818,17 +515,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Scripts
API Reference
@ -839,59 +536,12 @@
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<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
API Reference
</label>
@ -904,14 +554,14 @@
<li class="md-nav__item">
<a href="../../scripts/analysis/" class="md-nav__link">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
Brittle Star Environment
@ -925,115 +575,6 @@
</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>
@ -1041,14 +582,154 @@
<li class="md-nav__item">
<a href="../../src/experiment_logger/" class="md-nav__link">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -1068,11 +749,84 @@
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>

View file

@ -23,7 +23,7 @@
<title>Communication scheme (Message Passing) - Brittle Star Project</title>
<title>Communication Scheme - Brittle Star Project</title>
@ -102,7 +102,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
</span>
</div>
@ -205,7 +205,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -222,309 +222,6 @@
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Api
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -538,17 +235,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Design
Design & Architecture
@ -559,12 +256,12 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Design
Design & Architecture
</label>
@ -621,7 +318,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -639,7 +336,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -709,7 +406,7 @@
<span class="md-ellipsis">
Levels of modularity and topology
Modularity & Topology
@ -737,7 +434,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -793,7 +490,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -829,17 +526,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Scripts
API Reference
@ -850,59 +547,12 @@
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<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
API Reference
</label>
@ -915,14 +565,14 @@
<li class="md-nav__item">
<a href="../../scripts/analysis/" class="md-nav__link">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
Brittle Star Environment
@ -936,115 +586,6 @@
</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>
@ -1052,14 +593,154 @@
<li class="md-nav__item">
<a href="../../src/experiment_logger/" class="md-nav__link">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -1079,11 +760,84 @@
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>

File diff suppressed because it is too large Load diff

View file

@ -23,7 +23,7 @@
<title>Input (state) and output (action) spaces - Brittle Star Project</title>
<title>Input & Action Spaces - Brittle Star Project</title>
@ -102,7 +102,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
</span>
</div>
@ -205,7 +205,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -222,309 +222,6 @@
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Api
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -538,17 +235,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Design
Design & Architecture
@ -559,12 +256,12 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Design
Design & Architecture
</label>
@ -612,7 +309,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -640,7 +337,7 @@
<span class="md-ellipsis">
Levels of modularity and topology
Modularity & Topology
@ -677,7 +374,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -695,7 +392,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -815,7 +512,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -851,17 +548,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Scripts
API Reference
@ -872,59 +569,12 @@
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<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
API Reference
</label>
@ -937,14 +587,14 @@
<li class="md-nav__item">
<a href="../../scripts/analysis/" class="md-nav__link">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
Brittle Star Environment
@ -958,115 +608,6 @@
</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>
@ -1074,14 +615,154 @@
<li class="md-nav__item">
<a href="../../src/experiment_logger/" class="md-nav__link">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -1101,11 +782,84 @@
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>

View file

@ -205,7 +205,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -222,309 +222,6 @@
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Api
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -538,17 +235,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Design
Design & Architecture
@ -559,12 +256,12 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Design
Design & Architecture
</label>
@ -612,7 +309,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -640,7 +337,7 @@
<span class="md-ellipsis">
Levels of modularity and topology
Modularity & Topology
@ -668,7 +365,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -793,7 +490,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -829,17 +526,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Scripts
API Reference
@ -850,59 +547,12 @@
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<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
API Reference
</label>
@ -915,14 +565,14 @@
<li class="md-nav__item">
<a href="../../scripts/analysis/" class="md-nav__link">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
Brittle Star Environment
@ -936,115 +586,6 @@
</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>
@ -1052,14 +593,154 @@
<li class="md-nav__item">
<a href="../../src/experiment_logger/" class="md-nav__link">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -1079,11 +760,84 @@
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>

View file

@ -12,7 +12,7 @@
<link rel="prev" href="../learning_algorithm/">
<link rel="next" href="../../scripts/analysis/">
<link rel="next" href="../../api/environment/">
@ -23,7 +23,7 @@
<title>Reward function and observation space - Brittle Star Project</title>
<title>Reward Function & Observation Space - Brittle Star Project</title>
@ -102,7 +102,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
</span>
</div>
@ -205,7 +205,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -222,309 +222,6 @@
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Api
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -538,17 +235,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Design
Design & Architecture
@ -559,12 +256,12 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Design
Design & Architecture
</label>
@ -612,7 +309,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -640,7 +337,7 @@
<span class="md-ellipsis">
Levels of modularity and topology
Modularity & Topology
@ -668,7 +365,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -733,7 +430,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -751,7 +448,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -840,17 +537,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Scripts
API Reference
@ -861,59 +558,12 @@
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<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
API Reference
</label>
@ -926,14 +576,182 @@
<li class="md-nav__item">
<a href="../../scripts/analysis/" class="md-nav__link">
<a href="../../api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
Brittle Star Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -953,14 +771,6 @@
</li>
</ul>
</nav>
</li>
@ -968,109 +778,15 @@
<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">
<a href="../../HPC/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
HPC Guide
@ -1082,19 +798,57 @@
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="../../CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="../../DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>

View file

@ -10,7 +10,7 @@
<link rel="next" href="CONTRIBUTING/">
<link rel="next" href="design/actor-critic/">
@ -100,7 +100,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Documentation
Home
</span>
</div>
@ -212,7 +212,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -230,7 +230,7 @@
<span class="md-ellipsis">
Documentation
Home
@ -313,87 +313,6 @@
<li class="md-nav__item">
<a href="CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
@ -403,17 +322,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Api
Design & Architecture
@ -424,234 +343,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="false">
<label class="md-nav__title" for="__nav_5">
<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>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis &amp; Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Brittle star environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint &amp; Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Simulation &amp; Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking &amp; Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/training/" class="md-nav__link">
<span class="md-ellipsis">
Training Models
</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_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
Design & Architecture
</label>
@ -699,7 +396,7 @@
<span class="md-ellipsis">
Communication scheme (Message Passing)
Communication Scheme
@ -727,7 +424,7 @@
<span class="md-ellipsis">
Levels of modularity and topology
Modularity & Topology
@ -755,7 +452,7 @@
<span class="md-ellipsis">
Input (state) and output (action) spaces
Input & Action Spaces
@ -811,7 +508,7 @@
<span class="md-ellipsis">
Reward function and observation space
Reward Function & Observation Space
@ -847,17 +544,17 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Scripts
API Reference
@ -868,59 +565,12 @@
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<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
API Reference
</label>
@ -933,14 +583,14 @@
<li class="md-nav__item">
<a href="scripts/analysis/" class="md-nav__link">
<a href="api/environment/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Analysis Tools
Brittle Star Environment
@ -954,115 +604,6 @@
</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>
@ -1070,14 +611,154 @@
<li class="md-nav__item">
<a href="src/experiment_logger/" class="md-nav__link">
<a href="api/training/" class="md-nav__link">
<span class="md-ellipsis">
Experiment Logger
Training Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/tracking/" class="md-nav__link">
<span class="md-ellipsis">
Tracking & Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/evaluation/" class="md-nav__link">
<span class="md-ellipsis">
Checkpoint & Model Evaluation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/simulation/" class="md-nav__link">
<span class="md-ellipsis">
Interactive Simulation & Visualization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Plotting Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api/reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Results & Reproduction
@ -1097,11 +778,84 @@
</li>
</ul>
</nav>
<li class="md-nav__item">
<a href="HPC/" class="md-nav__link">
<span class="md-ellipsis">
HPC Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="CONTRIBUTING/" class="md-nav__link">
<span class="md-ellipsis">
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="DEVELOPMENT/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
@ -1200,7 +954,8 @@
<ul>
<li><strong><a href="DEVELOPMENT/">Installation Instructions</a></strong>: Steps to set up your development environment locally or in a devcontainer using <code>uv</code>, including GPU configuration. For High-Performance Computing (HPC) setup details, see the <strong><a href="HPC/">HPC Guide</a></strong>.</li>
<li><strong><a href="api/training/">How to Run Experiments</a></strong>: A complete guide on running training jobs, setting custom hyperparameters, and overriding config options using Hydra.</li>
<li><strong><a href="api/training/#reproducing-experiments">Reproducing Experiments</a></strong>: Best practices for reproducing past training runs using exact seeds, dependencies, and automatic metadata logging.</li>
<li><strong><a href="api/reproduction/">Results &amp; Reproduction</a></strong>: Guide on how to access our public WandB training runs table and reproduce our training and evaluation phases (determining the best checkpoint vs. comparing architectures).</li>
<li><strong><a href="CONTRIBUTING/">Contribution Guidelines</a></strong>: Standards, rules, and best practices for developing and adding code to the repository.</li>
<li><strong><a href="#repository-structure">Repository Structure</a></strong>: Overview of the directories and files within the codebase.</li>
</ul>
<h2 id="repository-structure">Repository Structure</h2>
@ -1219,22 +974,23 @@
<h2 id="design-architecture-design">Design &amp; architecture (<code>/design</code>)</h2>
<p>If you are interested in the "why did you do it like this?"</p>
<ul>
<li><a href="design/actor-critic/">Actor/critic architecture</a>: Description of the actor-critic pipeline.</li>
<li><a href="design/communication/">Communication</a>: Message propagation, Nerve-Net style.</li>
<li><a href="design/controllers/">Controllers</a>: Macroscopig brain toplogy, centralized, arm-level, segment-level.</li>
<li><a href="design/input_action_spaces/">Input/output</a>: Description of the model's input and output.</li>
<li><a href="design/learning_algorithm/">Learning algorithm</a>: RL techniques, i.e. PPO.</li>
<li><a href="design/reward_function/">Reward function</a>: Goals, fitness tracking, and reward structures.</li>
<li><a href="design/actor-critic/">Actor-Critic Architecture</a>: Description of the actor-critic pipeline.</li>
<li><a href="design/communication/">Communication Scheme</a>: Message propagation, Nerve-Net style.</li>
<li><a href="design/controllers/">Modularity &amp; Topology</a>: Macroscopic brain topology, centralized, arm-level, segment-level.</li>
<li><a href="design/input_action_spaces/">Input &amp; Action Spaces</a>: Description of the model's input and output.</li>
<li><a href="design/learning_algorithm/">Reinforcement Learning Algorithm</a>: RL techniques, i.e. PPO.</li>
<li><a href="design/reward_function/">Reward Function &amp; Observation Space</a>: Goals, fitness tracking, and reward structures.</li>
</ul>
<h2 id="api-reference-api">API reference (<code>/api</code>)</h2>
<p>If you are interested in the "how do I use it?"</p>
<ul>
<li><a href="api/training/">Training</a>: How to configure and run experiments.</li>
<li><a href="api/environment/">Brittle Star Environment</a>: MuJoCo environment interaction and configuration.</li>
<li><a href="api/training/">Training Models</a>: How to configure and run experiments.</li>
<li><a href="api/tracking/">Tracking &amp; Monitoring</a>: Setting up WandB and TensorBoard to monitor runs.</li>
<li><a href="api/simulation/">Simulation</a>: Visualizing and evaluating models.</li>
<li><a href="api/environment/">Environment</a>: MuJoCo environment interaction and configuration.</li>
<li><a href="api/analysis/">Analysis</a>: Comparing checkpoints and generating plots.</li>
<li><a href="api/evaluation/">Evaluation</a>: Evaluating checkpoints and comparing fault tolerance.</li>
<li><a href="api/evaluation/">Checkpoint &amp; Model Evaluation</a>: Evaluating checkpoints and comparing fault tolerance.</li>
<li><a href="api/simulation/">Interactive Simulation &amp; Visualization</a>: Visualizing models in the MuJoCo viewer or rendering simulation videos.</li>
<li><a href="api/analysis/">Analysis &amp; Plotting Tools</a>: Comparing checkpoints and generating plots.</li>
<li><a href="api/reproduction/">Results &amp; Reproduction</a>: Accessing WandB results and running reproduction pipelines.</li>
</ul>

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load diff