Isaac Lab API, powered by MuJoCo-Warp, for RL and robotics research.
Project description
mjlab
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.
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@7c20a44bfed722e6415235792a1b247ea6b6a6d3" 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):
Launch the demo directly in your browser with an interactive Viser viewer.
Installation
From source:
git clone https://github.com/mujocolab/mjlab.git
cd mjlab
uv run demo
From PyPI:
uv add mjlab "mujoco-warp @ git+https://github.com/google-deepmind/mujoco_warp@7c20a44bfed722e6415235792a1b247ea6b6a6d3"
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:
-
Create a registry collection in your WandB workspace named
Motions -
Set your WandB entity:
export WANDB_ENTITY=your-organization-name
-
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-nameto the command.
Documentation
Full documentation is available at mujocolab.github.io/mjlab.
Development
Run tests:
make test # Run all tests
make test-fast # Skip slow integration tests
Format code:
uvx pre-commit install
make format
Compile documentation locally:
uv pip install -r docs/requirements.txt
make docs
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)
Forked components retain their original licenses. See file headers 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mjlab-1.0.0.tar.gz.
File metadata
- Download URL: mjlab-1.0.0.tar.gz
- Upload date:
- Size: 14.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4d250aa2e3e5690e0a984d00382d2ebdc61f0630ebafd7b218a8d29183fac30
|
|
| MD5 |
74cad36c68a3f24a61c62ca2ee45ee25
|
|
| BLAKE2b-256 |
5e4b582d1ca76d8e99f5993487f3b5893fe970f1d4ba3e8adfa2a9c3349c578c
|
File details
Details for the file mjlab-1.0.0-py3-none-any.whl.
File metadata
- Download URL: mjlab-1.0.0-py3-none-any.whl
- Upload date:
- Size: 14.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a69d06e096e146e1e0525a86a46a7acdd9b6595512bff141e0e4e71ea6dabcd
|
|
| MD5 |
c54ed6f252d8d772abaf75179188dd16
|
|
| BLAKE2b-256 |
6d13ad6c9a6818b85d3fce8549ca78107312a4f0f16c6e62e27cb9dca7a68e34
|