|
| 1 | +# RSL-RL |
| 2 | + |
| 3 | +A fast and simple implementation of learning algorithms for robotics. For an overview of the library please have a look at https://arxiv.org/pdf/2509.10771. |
| 4 | + |
| 5 | +Environment repositories using the framework: |
| 6 | + |
| 7 | +* **`Isaac Lab`** (built on top of NVIDIA Isaac Sim): https://github.com/isaac-sim/IsaacLab |
| 8 | +* **`Legged Gym`** (built on top of NVIDIA Isaac Gym): https://leggedrobotics.github.io/legged_gym/ |
| 9 | +* **`MuJoCo Playground`** (built on top of MuJoCo MJX and Warp): https://github.com/google-deepmind/mujoco_playground/ |
| 10 | +* **`mjlab`** (built on top of MuJoCo Warp): https://github.com/mujocolab/mjlab |
| 11 | + |
| 12 | +The library currently supports **PPO** and **Student-Teacher Distillation** with additional features from our research. These include: |
| 13 | + |
| 14 | +* [Random Network Distillation (RND)](https://proceedings.mlr.press/v229/schwarke23a.html) - Encourages exploration by adding |
| 15 | + a curiosity driven intrinsic reward. |
| 16 | +* [Symmetry-based Augmentation](https://arxiv.org/abs/2403.04359) - Makes the learned behaviors more symmetrical. |
| 17 | + |
| 18 | +We welcome contributions from the community. Please check our contribution guidelines for more |
| 19 | +information. |
| 20 | + |
| 21 | +**Maintainer**: Mayank Mittal and Clemens Schwarke <br/> |
| 22 | +**Affiliation**: Robotic Systems Lab, ETH Zurich & NVIDIA <br/> |
| 23 | +**Contact**: cschwarke@ethz.ch |
| 24 | + |
| 25 | + |
| 26 | +## Setup |
| 27 | + |
| 28 | +The package can be installed via PyPI with: |
| 29 | + |
| 30 | +```bash |
| 31 | +pip install rsl-rl-lib |
| 32 | +``` |
| 33 | + |
| 34 | +or by cloning this repository and installing it with: |
| 35 | + |
| 36 | +```bash |
| 37 | +git clone https://github.com/leggedrobotics/rsl_rl |
| 38 | +cd rsl_rl |
| 39 | +pip install -e . |
| 40 | +``` |
| 41 | + |
| 42 | +The package supports the following logging frameworks which can be configured through `logger`: |
| 43 | + |
| 44 | +* Tensorboard: https://www.tensorflow.org/tensorboard/ |
| 45 | +* Weights & Biases: https://wandb.ai/site |
| 46 | +* Neptune: https://docs.neptune.ai/ |
| 47 | + |
| 48 | +For a demo configuration of PPO, please check the [example_config.yaml](config/example_config.yaml) file. |
| 49 | + |
| 50 | + |
| 51 | +## Contribution Guidelines |
| 52 | + |
| 53 | +For documentation, we adopt the [Google Style Guide](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for docstrings. Please make sure that your code is well-documented and follows the guidelines. |
| 54 | + |
| 55 | +We use the following tools for maintaining code quality: |
| 56 | + |
| 57 | +- [pre-commit](https://pre-commit.com/): Runs a list of formatters and linters over the codebase. |
| 58 | +- [ruff](https://github.com/astral-sh/ruff): An extremely fast Python linter and code formatter, written in Rust. |
| 59 | + |
| 60 | +Please check [here](https://pre-commit.com/#install) for instructions to set these up. To run over the entire repository, please execute the following command in the terminal: |
| 61 | + |
| 62 | +```bash |
| 63 | +# for installation (only once) |
| 64 | +pre-commit install |
| 65 | +# for running |
| 66 | +pre-commit run --all-files |
| 67 | +``` |
| 68 | + |
| 69 | +## Citing |
| 70 | + |
| 71 | +If you use this library for your research, please cite the following work: |
| 72 | + |
| 73 | +```text |
| 74 | +@article{schwarke2025rslrl, |
| 75 | + title={RSL-RL: A Learning Library for Robotics Research}, |
| 76 | + author={Schwarke, Clemens and Mittal, Mayank and Rudin, Nikita and Hoeller, David and Hutter, Marco}, |
| 77 | + journal={arXiv preprint arXiv:2509.10771}, |
| 78 | + year={2025} |
| 79 | +} |
| 80 | +``` |
| 81 | + |
| 82 | +If you use the library with curiosity-driven exploration (random network distillation), please cite: |
| 83 | + |
| 84 | +```text |
| 85 | +@InProceedings{schwarke2023curiosity, |
| 86 | + title = {Curiosity-Driven Learning of Joint Locomotion and Manipulation Tasks}, |
| 87 | + author = {Schwarke, Clemens and Klemm, Victor and Boon, Matthijs van der and Bjelonic, Marko and Hutter, Marco}, |
| 88 | + booktitle = {Proceedings of The 7th Conference on Robot Learning}, |
| 89 | + pages = {2594--2610}, |
| 90 | + year = {2023}, |
| 91 | + volume = {229}, |
| 92 | + series = {Proceedings of Machine Learning Research}, |
| 93 | + publisher = {PMLR}, |
| 94 | + url = {https://proceedings.mlr.press/v229/schwarke23a.html}, |
| 95 | +} |
| 96 | +``` |
| 97 | + |
| 98 | +If you use the library with symmetry augmentation, please cite: |
| 99 | + |
| 100 | +```text |
| 101 | +@InProceedings{mittal2024symmetry, |
| 102 | + author={Mittal, Mayank and Rudin, Nikita and Klemm, Victor and Allshire, Arthur and Hutter, Marco}, |
| 103 | + booktitle={2024 IEEE International Conference on Robotics and Automation (ICRA)}, |
| 104 | + title={Symmetry Considerations for Learning Task Symmetric Robot Policies}, |
| 105 | + year={2024}, |
| 106 | + pages={7433-7439}, |
| 107 | + doi={10.1109/ICRA57147.2024.10611493} |
| 108 | +} |
| 109 | +``` |
0 commit comments