Git Product home page Git Product logo

rl-x's Introduction

RL-X

A framework for Reinforcement Learning research.

OverviewGetting StartedDocumentationCitation

Overview

Highlights

  • 💡 Perfect to understand and prototype algorithms:
    • One algorithm = One directory -> No backtracking through parent classes
    • Algorithms can be easily copied out of RL-X
  • ⚒️ Known DL libraries: Implementations in PyTorch and mainly JAX (Flax)
  • Maximum speed: Just-In-Time (JIT) compilation and parallel environments
  • 🧪 Mix and match and extend: Generic interfaces between algorithms and environments
  • ⛰️​ Custom environments: Examples for custom environments with MuJoCo or pure socket communication
  • 🚀​ GPU environments: MuJoCo XLA (MJX) supports running 4000 parallel environments on a GPU
  • 📈 Experiments: Checkpoints, Evaluation, Console log, Tensorboard, Weights & Biases, SLURM, Docker

Implemented Algorithms

Usable Environments

  • Gymnasium
    • MuJoCo
    • Atari
    • Classic control
  • EnvPool
    • MuJoCo
    • Atari
    • Classic control
    • DeepMind Control Suite
  • Custom MuJoCo
    • Example of a custom MuJoCo environment
    • Example of a custom MuJoCo XLA (MJX) environment
  • Custom Interface
    • Prototype of a custom environment interface with socket communication

All listed environments are directly embedded in RL-X and can be used out-of-the-box.

For further information on the environments (README) and algorithms (README) and how to add your own, read the respective README files.

Getting Started

Install

Default installation for a Linux system with a NVIDIA GPU:

conda create -n rlx python=3.11.4
conda activate rlx
git clone [email protected]:nico-bohlinger/RL-X.git
cd RL-X
pip install -e .[all] --config-settings editable_mode=compat
pip uninstall $(pip freeze | grep -i '\-cu12' | cut -d '=' -f 1) -y
pip install "torch>=2.2.1" --index-url https://download.pytorch.org/whl/cu118 --upgrade
pip install -U "jax[cuda12_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

For other configurations, see the detailed installation guide in the documentation.

Example

cd experiments
python experiment.py

Detailed instructions for running experiments can be found in the README file in the experiments directory or in the documentation.

Example for Google Colab: Open In Colab

Citation

If you use RL-X in your research, please cite the following paper:

@incollection{bohlinger2023rlx,
      title={RL-X: A Deep Reinforcement Learning Library (not only) for RoboCup}, 
      author={Nico Bohlinger and Klaus Dorer},
      booktitle={Robot World Cup},
      pages={228--239},
      year={2023},
      publisher={Springer}
}

rl-x's People

Contributors

nico-bohlinger avatar kitaird avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.