docs: proper newlines formatting
This commit is contained in:
parent
e4869e0061
commit
de6b038002
6 changed files with 20 additions and 3 deletions
|
|
@ -5,6 +5,7 @@ This guide outlines the tools available for analyzing experimental data and gene
|
|||
## Shared Configuration
|
||||
|
||||
All plotting scripts share a central configuration in `scripts/plots/plot_config.py`. This file defines:
|
||||
|
||||
- **Color Palette:** A color-blind friendly, high-contrast palette for different architectures.
|
||||
- **Typography:** Consistent font sizes and styles tailored for A0 posters.
|
||||
- **Markers:** Shared visual indicators, such as the ★ used for best performers.
|
||||
|
|
@ -40,6 +41,7 @@ uv run python scripts/plots/analyze_comparisons.py path/to/results.csv \
|
|||
### Outputs
|
||||
|
||||
The script generates four key plots, each saved as both `.png` and `.svg`:
|
||||
|
||||
1. **Forward Velocity:** Grouped bar chart (cm/s).
|
||||
2. **Accumulated Reward:** Mean cumulative reward.
|
||||
3. **Success Rate:** Target acquisition percentage.
|
||||
|
|
@ -65,6 +67,7 @@ uv run python scripts/plots/analyze_convergence.py --output_dir runs/convergence
|
|||
### Outputs
|
||||
|
||||
Generates three plots (PNG & SVG):
|
||||
|
||||
1. `convergence_comparison`: Grouped horizontal bar chart.
|
||||
2. `progress_reward_curves`: Line plots of reward over time.
|
||||
3. `progress_velocity_curves`: Line plots of velocity over time.
|
||||
|
|
@ -74,7 +77,9 @@ Generates three plots (PNG & SVG):
|
|||
## Poster Integration (Figma)
|
||||
|
||||
### SVG & Scaling
|
||||
|
||||
We recommend using the **SVG** outputs for poster design in Figma:
|
||||
|
||||
1. **No Resolution Loss:** SVGs are vector-based and will remain sharp at any size.
|
||||
2. **Native Text:** Text in the SVG imports as native text layers in Figma.
|
||||
3. **Exact Font Matching:** To ensure a `28pt` font in the plot matches a `28pt` font in your poster, set the `--fig_width` and `--fig_height` to match the physical dimensions of the plot box in your Figma layout.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
# Brittle star environment
|
||||
|
||||
## Creation
|
||||
|
||||
The environment package contains a factory class `BrittleStarEnvFactory`
|
||||
that creates instances of the environment/morphologies/... It uses the
|
||||
configuration classes defined in `env_config.py` to create the instances.
|
||||
|
||||
## Configuration
|
||||
|
||||
The data classes in `env_config` have default values as stated in the tutorials.
|
||||
|
||||
* MorphologyConfig: configuration for the morphology of the brittle star. Contains
|
||||
number of arms, number of segments per arm, and control mode.
|
||||
* ArenaConfig: configuration for the arena. Sets the size of the arena, whether to
|
||||
|
|
@ -15,10 +18,13 @@ set the ground floor to sand, attach a target and sizes of the walls.
|
|||
such as camera locations, simulation time and the task.
|
||||
|
||||
## Backend and Task enums
|
||||
|
||||
The Backend enum specifies either an MJC or MJX backend.
|
||||
|
||||
* MJC: runs on CPU
|
||||
* MJX: uses jax on the gpu
|
||||
|
||||
The Task enum specifies which task to use. 2 items are present:
|
||||
|
||||
* DIRECTED_LOCOMOTION: move to a target location
|
||||
* LIGHT_ESCAPE: situation where the robot must move to a darker location
|
||||
|
|
|
|||
Reference in a new issue