Skip to content

mujocolab/mjlab

Repository files navigation

Project banner

mjlab

tests

mjlab combines Isaac Lab's proven API with best-in-class MuJoCo physics to provide lightweight, modular abstractions for RL robotics research and sim-to-real deployment.

⚠️ BETA PREVIEW mjlab is in active development. Expect breaking changes and missing features during the beta phase. There is no stable release yet. The PyPI package is only a snapshot — for the latest fixes and improvements, install from source or Git.


Quick Start

mjlab requires an NVIDIA GPU for training (via MuJoCo Warp). macOS is supported only for evaluation, which is significantly slower.

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

Run the demo (no installation needed):

uvx --from mjlab --with "mujoco-warp @ git+https://github.com/google-deepmind/mujoco_warp@486642c3fa262a989b482e0e506716d5793d61a9" demo

This launches an interactive viewer with a pre-trained Unitree G1 agent tracking a reference dance motion in MuJoCo Warp.

❓ Having issues? See the FAQ.

Try in Google Colab (no local setup required):

Open In Colab

Launch the demo directly in your browser with an interactive Viser viewer.


Installation

From source (recommended during beta):

git clone https://github.com/mujocolab/mjlab.git
cd mjlab
uv run demo

From PyPI (beta snapshot):

uv add mjlab "mujoco-warp @ git+https://github.com/google-deepmind/mujoco_warp@486642c3fa262a989b482e0e506716d5793d61a9"

A Dockerfile is also provided.

For full setup instructions, see the Installation Guide.


Training Examples

1. Velocity Tracking

Train a Unitree G1 humanoid to follow velocity commands on flat terrain:

uv run train Mjlab-Velocity-Flat-Unitree-G1 --env.scene.num-envs 4096

Multi-GPU Training: Scale to multiple GPUs using --gpu-ids:

uv run train Mjlab-Velocity-Flat-Unitree-G1 \
  --gpu-ids 0 1 \
  --env.scene.num-envs 4096

See the Distributed Training guide for details.

Evaluate a policy while training (fetches latest checkpoint from Weights & Biases):

uv run play Mjlab-Velocity-Flat-Unitree-G1 --wandb-run-path your-org/mjlab/run-id

2. Motion Imitation

Train a Unitree G1 to mimic reference motions. mjlab uses WandB to manage reference motion datasets:

  1. Create a registry collection in your WandB workspace named Motions

  2. Set your WandB entity:

    export WANDB_ENTITY=your-organization-name
  3. Process and upload motion files:

    MUJOCO_GL=egl uv run src/mjlab/scripts/csv_to_npz.py \
      --input-file /path/to/motion.csv \
      --output-name motion_name \
      --input-fps 30 \
      --output-fps 50 \
      --render  # Optional: generates preview video

Note: For detailed motion preprocessing instructions, see the BeyondMimic documentation.

Train and Play

uv run train Mjlab-Tracking-Flat-Unitree-G1 --registry-name your-org/motions/motion-name --env.scene.num-envs 4096

uv run play Mjlab-Tracking-Flat-Unitree-G1 --wandb-run-path your-org/mjlab/run-id

3. Sanity-check with Dummy Agents

Use built-in agents to sanity check your MDP before training.

uv run play Mjlab-Your-Task-Id --agent zero  # Sends zero actions.
uv run play Mjlab-Your-Task-Id --agent random  # Sends uniform random actions.

[!NOTE] When running motion-tracking tasks, add --registry-name your-org/motions/motion-name to the command.


Documentation


Development

Run tests:

make test          # Run all tests
make test-fast     # Skip slow integration tests

Format code:

uvx pre-commit install
make format

License

mjlab is licensed under the Apache License, Version 2.0.

Third-Party Code

Some portions of mjlab are forked from external projects:

  • src/mjlab/utils/lab_api/ — Utilities forked from NVIDIA Isaac Lab (BSD-3-Clause license, see file headers)
  • src/mjlab/asset_zoo/robots/unitree_go1/assets/walk_these_ways/ — Actuator network from walk-these-ways (MIT license, see asset README)

Forked components retain their original licenses (BSD-3-Clause for lab_api, MIT for walk-these-ways). See file headers and asset READMEs for details.


Acknowledgments

mjlab wouldn't exist without the excellent work of the Isaac Lab team, whose API design and abstractions mjlab builds upon.

Thanks to the MuJoCo Warp team — especially Erik Frey and Taylor Howell — for answering our questions, giving helpful feedback, and implementing features based on our requests countless times.

About

Isaac Lab API, powered by MuJoCo-Warp, for RL and robotics research.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages