Fast and simple implementation of RL algorithms, designed to run fully on GPU.
Go to file
Mayank Mittal 73fd7c621b Merge branch 'release' 2024-10-11 14:26:58 +02:00
config Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
licenses/dependencies Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
rsl_rl Merge branch 'release' 2024-10-11 14:26:58 +02:00
.flake8 Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
.gitignore Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
.pre-commit-config.yaml Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
CONTRIBUTORS.md Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
LICENSE Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
README.md added notice on algorithms branch to README 2023-12-12 18:44:24 +01:00
pyproject.toml Updates RSL-RL to version 2.0 (#14) 2023-11-02 00:43:02 +01:00
setup.py bumps version 2023-12-11 19:09:35 +01:00

README.md

RSL RL

Fast and simple implementation of RL algorithms, designed to run fully on GPU. This code is an evolution of rl-pytorch provided with NVIDIA's Isaac GYM.

The algorithms branch supports additional algorithms (SAC, DDPG, DSAC, and more)!

Only PPO is implemented for now. More algorithms will be added later. Contributions are welcome.

Maintainer: David Hoeller and Nikita Rudin
Affiliation: Robotic Systems Lab, ETH Zurich & NVIDIA
Contact: rudinn@ethz.ch

Setup

Following are the instructions to setup the repository for your workspace:

git clone https://github.com/leggedrobotics/rsl_rl
cd rsl_rl
pip install -e .

The framework supports the following logging frameworks which can be configured through logger:

For a demo configuration of the PPO, please check: dummy_config.yaml file.

Contribution Guidelines

For documentation, we adopt the Google Style Guide for docstrings. We use Sphinx for generating the documentation. Please make sure that your code is well-documented and follows the guidelines.

We use the following tools for maintaining code quality:

  • pre-commit: Runs a list of formatters and linters over the codebase.
  • black: The uncompromising code formatter.
  • flake8: A wrapper around PyFlakes, pycodestyle, and McCabe complexity checker.

Please check here for instructions to set these up. To run over the entire repository, please execute the following command in the terminal:

# for installation (only once)
pre-commit install
# for running
pre-commit run --all-files

Environment repositories using the framework: