# clearlab-sustech/wheel-legged-gym architecture

> Architecture diagram of the GitHub repository clearlab-sustech/wheel-legged-gym, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/clearlab-sustech/wheel-legged-gym
- Repository: https://github.com/clearlab-sustech/wheel-legged-gym

## Overview

Wheel-Legged Gym provides Isaac Gym locomotion environments and an on-policy reinforcement-learning workflow. Users select a registered task, train or play a policy, and obtain checkpoints or policy exports. The map covers base and VMC environment variants, terrain generation, PPO policies and rollout storage. The README documents the user workflow and task capabilities; some internal connections are supported only by the source index, so uncertain links are omitted.

Main entry points: [`wheel_legged_gym/envs/base/legged_robot.py`](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/legged_robot.py) (Legged robot), [`wheel_legged_gym/rsl_rl/runners/on_policy_runner.py`](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/runners/on_policy_runner.py) (On-policy runner), [`wheel_legged_gym/envs/__init__.py`](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/__init__.py) (Task registration), [`wheel_legged_gym/utils/task_registry.py`](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/task_registry.py) (Task registry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Task entry"]
  node_train["Train command<br/>[train.py]"]
  node_play["Play command<br/>[play.py]"]
  node_registry["Task registry<br/>[task_registry.py]"]
  node_registration["Task registration<br/>[__init__.py]"]
end

subgraph group_sim["Simulation environments"]
  node_basecfg["Base config"]
  node_wheelcfg["Wheel config"]
  node_vmccfg["VMC config"]
  node_flatcfg["Flat config"]
  node_baseenv["Base task<br/>[base_task.py]"]
  node_robot["Legged robot<br/>[legged_robot.py]"]
  node_vmc["VMC robot"]
  node_terrain["Terrain generator<br/>[terrain.py]"]
  node_asset["Wheel-leg asset<br/>[wl.urdf]"]
end

subgraph group_learning["Policy learning"]
  node_runner["On-policy runner"]
  node_vecenv["Vector environment<br/>[vec_env.py]"]
  node_ppo["PPO optimizer<br/>[ppo.py]"]
  node_actor["Actor critic<br/>[actor_critic.py]"]
  node_sequence["Sequence policy"]
  node_recurrent["Recurrent policy"]
  node_storage[("Rollout storage<br/>[rollout_storage.py]")]
end

subgraph group_support["Runtime support"]
  node_helpers["Runtime helpers<br/>[helpers.py]"]
  node_math["Robot math<br/>[math.py]"]
  node_logger["Training logger<br/>[logger.py]"]
end

node_user(("Engineer"))
node_isaac["Isaac Gym"]
node_checkpoint["Model checkpoint"]
node_tensorboard["TensorBoard"]

node_user -->|"starts training"| node_train
node_user -->|"runs policy"| node_play
node_train -->|"selects task"| node_registry
node_play -->|"selects task"| node_registry
node_registration -->|"registers tasks"| node_registry
node_registration -->|"registers class"| node_robot
node_registration -->|"registers class"| node_vmc
node_registration -->|"registers config"| node_wheelcfg
node_registration -->|"registers config"| node_vmccfg
node_registration -->|"registers config"| node_flatcfg
node_wheelcfg -->|"inherits config"| node_basecfg
node_vmccfg -->|"inherits config"| node_wheelcfg
node_flatcfg -->|"inherits config"| node_vmccfg
node_registry -->|"creates environment"| node_robot
node_registry -->|"creates runner"| node_runner
node_robot -->|"extends task base"| node_baseenv
node_vmc -->|"extends robot"| node_robot
node_robot -->|"uses terrain"| node_terrain
node_robot -->|"uses math"| node_math
node_robot -->|"steps simulation"| node_isaac
node_runner -->|"steps environment"| node_vecenv
node_runner -->|"runs algorithm"| node_ppo
node_runner -->|"selects policy"| node_actor
node_runner -->|"selects policy"| node_sequence
node_ppo -->|"uses rollouts"| node_storage
node_ppo -->|"uses policy"| node_actor
node_recurrent -->|"extends policy"| node_actor
node_runner -->|"saves model"| node_checkpoint
node_play -->|"loads model"| node_checkpoint
node_runner -->|"logs metrics"| node_tensorboard
node_robot -.->|"loads robot asset"| node_asset

click node_train "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/scripts/train.py"
click node_play "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/scripts/play.py"
click node_registry "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/task_registry.py"
click node_registration "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/__init__.py"
click node_basecfg "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/legged_robot_config.py"
click node_wheelcfg "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged/wheel_legged_config.py"
click node_vmccfg "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc_config.py"
click node_flatcfg "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged_vmc_flat/wheel_legged_vmc_flat_config.py"
click node_baseenv "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/base_task.py"
click node_robot "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/legged_robot.py"
click node_vmc "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc.py"
click node_terrain "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/terrain.py"
click node_asset "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/resources/robots/wl/urdf/wl.urdf"
click node_runner "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/runners/on_policy_runner.py"
click node_vecenv "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/env/vec_env.py"
click node_ppo "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/algorithms/ppo.py"
click node_actor "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/modules/actor_critic.py"
click node_sequence "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/modules/actor_critic_sequence.py"
click node_recurrent "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/modules/actor_critic_recurrent.py"
click node_storage "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/storage/rollout_storage.py"
click node_helpers "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/helpers.py"
click node_math "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/math.py"
click node_logger "https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/logger.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_train,node_play,node_registry,node_registration toneBlue
class node_basecfg,node_wheelcfg,node_vmccfg,node_flatcfg,node_baseenv,node_robot,node_vmc,node_terrain,node_asset toneAmber
class node_runner,node_vecenv,node_ppo,node_actor,node_sequence,node_recurrent,node_storage toneMint
class node_helpers,node_math,node_logger toneRose
class node_user,node_isaac,node_checkpoint,node_tensorboard toneIndigo
```

## Components

### Task entry

- [Train command](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/scripts/train.py): `wheel_legged_gym/scripts/train.py`
- [Play command](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/scripts/play.py): `wheel_legged_gym/scripts/play.py`
- [Task registry](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/task_registry.py): `wheel_legged_gym/utils/task_registry.py`
- [Task registration](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/__init__.py): `wheel_legged_gym/envs/__init__.py`

### Simulation environments

- [Base config](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/legged_robot_config.py): `wheel_legged_gym/envs/base/legged_robot_config.py`
- [Wheel config](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged/wheel_legged_config.py): `wheel_legged_gym/envs/wheel_legged/wheel_legged_config.py`
- [VMC config](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc_config.py): `wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc_config.py`
- [Flat config](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged_vmc_flat/wheel_legged_vmc_flat_config.py): `wheel_legged_gym/envs/wheel_legged_vmc_flat/wheel_legged_vmc_flat_config.py`
- [Base task](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/base_task.py): `wheel_legged_gym/envs/base/base_task.py`
- [Legged robot](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/base/legged_robot.py): `wheel_legged_gym/envs/base/legged_robot.py`
- [VMC robot](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc.py): `wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc.py`
- [Terrain generator](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/terrain.py): `wheel_legged_gym/utils/terrain.py`
- [Wheel-leg asset](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/resources/robots/wl/urdf/wl.urdf): `resources/robots/wl/urdf/wl.urdf`

### Policy learning

- [On-policy runner](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/runners/on_policy_runner.py): `wheel_legged_gym/rsl_rl/runners/on_policy_runner.py`
- [Vector environment](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/env/vec_env.py): `wheel_legged_gym/rsl_rl/env/vec_env.py`
- [PPO optimizer](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/algorithms/ppo.py): `wheel_legged_gym/rsl_rl/algorithms/ppo.py`
- [Actor critic](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/modules/actor_critic.py): `wheel_legged_gym/rsl_rl/modules/actor_critic.py`
- [Sequence policy](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/modules/actor_critic_sequence.py): `wheel_legged_gym/rsl_rl/modules/actor_critic_sequence.py`
- [Recurrent policy](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/modules/actor_critic_recurrent.py): `wheel_legged_gym/rsl_rl/modules/actor_critic_recurrent.py`
- [Rollout storage](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/rsl_rl/storage/rollout_storage.py): `wheel_legged_gym/rsl_rl/storage/rollout_storage.py`

### Runtime support

- [Runtime helpers](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/helpers.py): `wheel_legged_gym/utils/helpers.py`
- [Robot math](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/math.py): `wheel_legged_gym/utils/math.py`
- [Training logger](https://github.com/clearlab-sustech/wheel-legged-gym/blob/master/wheel_legged_gym/utils/logger.py): `wheel_legged_gym/utils/logger.py`

### Other components

- **Engineer**
- **Isaac Gym**
- **Model checkpoint**
- **TensorBoard**

## Connections

- Engineer → Train command: starts training (evidence: `README.md`)
- Engineer → Play command: runs policy (evidence: `README.md`)
- Train command → Task registry: selects task (evidence: `wheel_legged_gym/scripts/train.py`)
- Play command → Task registry: selects task (evidence: `wheel_legged_gym/scripts/play.py`)
- Task registration → Task registry: registers tasks (evidence: `wheel_legged_gym/envs/__init__.py`)
- Task registration → Legged robot: registers class (evidence: `wheel_legged_gym/envs/__init__.py`)
- Task registration → VMC robot: registers class (evidence: `wheel_legged_gym/envs/__init__.py`)
- Task registration → Wheel config: registers config (evidence: `wheel_legged_gym/envs/__init__.py`)
- Task registration → VMC config: registers config (evidence: `wheel_legged_gym/envs/__init__.py`)
- Task registration → Flat config: registers config (evidence: `wheel_legged_gym/envs/__init__.py`)
- Wheel config → Base config: inherits config (evidence: `wheel_legged_gym/envs/wheel_legged/wheel_legged_config.py`)
- VMC config → Wheel config: inherits config (evidence: `wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc_config.py`)
- Flat config → VMC config: inherits config (evidence: `wheel_legged_gym/envs/wheel_legged_vmc_flat/wheel_legged_vmc_flat_config.py`)
- Task registry → Legged robot: creates environment (evidence: `wheel_legged_gym/utils/task_registry.py`)
- Task registry → On-policy runner: creates runner (evidence: `wheel_legged_gym/utils/task_registry.py`)
- Legged robot → Base task: extends task base (evidence: `wheel_legged_gym/envs/base/legged_robot.py`)
- VMC robot → Legged robot: extends robot (evidence: `wheel_legged_gym/envs/wheel_legged_vmc/wheel_legged_vmc.py`)
- Legged robot → Terrain generator: uses terrain (evidence: `wheel_legged_gym/envs/base/legged_robot.py`)
- Legged robot → Robot math: uses math (evidence: `wheel_legged_gym/envs/base/legged_robot.py`)
- Legged robot → Isaac Gym: steps simulation (evidence: `wheel_legged_gym/envs/base/legged_robot.py`)
- On-policy runner → Vector environment: steps environment (evidence: `wheel_legged_gym/rsl_rl/runners/on_policy_runner.py`)
- On-policy runner → PPO optimizer: runs algorithm (evidence: `wheel_legged_gym/rsl_rl/runners/on_policy_runner.py`)
- On-policy runner → Actor critic: selects policy (evidence: `wheel_legged_gym/rsl_rl/runners/on_policy_runner.py`)
- On-policy runner → Sequence policy: selects policy (evidence: `wheel_legged_gym/rsl_rl/runners/on_policy_runner.py`)
- PPO optimizer → Rollout storage: uses rollouts (evidence: `wheel_legged_gym/rsl_rl/algorithms/ppo.py`)
- PPO optimizer → Actor critic: uses policy (evidence: `wheel_legged_gym/rsl_rl/algorithms/ppo.py`)
- Recurrent policy → Actor critic: extends policy (evidence: `wheel_legged_gym/rsl_rl/modules/actor_critic_recurrent.py`)
- On-policy runner → Model checkpoint: saves model (evidence: `README.md`)
- Play command → Model checkpoint: loads model (evidence: `README.md`)
- On-policy runner → TensorBoard: logs metrics (evidence: `README.md`)
- Legged robot → Wheel-leg asset: loads robot asset
