Readme · ReinforcementLearning.jl

ReinforcementLearning.jl, as the name says, is a package for reinforcement learning research in Julia.

Our design principles are:

Reusability and extensibility: Provide elaborately designed components and interfaces to help users implement new algorithms.
Easy experimentation: Make it easy for new users to run benchmark experiments, compare different algorithms, evaluate and diagnose agents.
Reproducibility: Facilitate reproducibility from traditional tabular methods to modern deep reinforcement learning algorithms.

🏹 Get Started

julia> ] add ReinforcementLearning

julia> using ReinforcementLearning

julia> run(
           RandomPolicy(),
           CartPoleEnv(),
           StopAfterStep(1_000),
           TotalRewardPerEpisode()
       )

The above simple example demonstrates four core components in a general reinforcement learning experiment:

Policy. The RandomPolicy is the simplest instance of AbstractPolicy. It generates a random action at each step.
Environment. The CartPoleEnv is a typical AbstractEnv to test reinforcement learning algorithms.
Stop Condition. The StopAfterStep(1_000) is to inform that our experiment should stop after 1_000 steps.
Hook. The TotalRewardPerEpisode structure is one of the most common AbstractHooks. It is used to collect the total reward of each episode in an experiment.

Check out the tutorial page to learn how these four components are assembled together to solve many interesting problems. We also write blog occasionally to explain the implementation details of some algorithms. Among them, the most recommended one is An Introduction to ReinforcementLearning.jl, which explains the design idea of this package. Besides, a collection of experiments are also provided to help you understand how to train or evaluate policies, tune parameters, log intermediate data, load or save parameters, plot results and record videos. For example:

[TODO: Use ReinforcementLearningExperiments.jl instead]

Here are the full list of available experiments! [TODO: Insert Demo Link]

E`JuliaRL_BasicDQN_CartPole`

E`JuliaRL_DQN_CartPole`

E`JuliaRL_PrioritizedDQN_CartPole`

E`JuliaRL_Rainbow_CartPole`

E`JuliaRL_IQN_CartPole`

E`JuliaRL_A2C_CartPole`

E`JuliaRL_A2CGAE_CartPole` (Thanks to @sriram13m

E`JuliaRL_MAC_CartPole` (Thanks to @RajGhugare19)

E`JuliaRL_PPO_CartPole`

E`JuliaRL_VPG_CartPole` (Thanks to @norci)

E`JuliaRL_DDPG_Pendulum`

E`JuliaRL_TD3_Pendulum` (Thanks to @rbange)

E`JuliaRL_SAC_Pendulum` (Thanks to @rbange)

E`JuliaRL_PPO_Pendulum`

E`JuliaRL_BasicDQN_MountainCar` (Thanks to @felixchalumeau)

E`JuliaRL_DQN_MountainCar` (Thanks to @felixchalumeau)

E`JuliaRL_Minimax_OpenSpiel(tic_tac_toe)`

E`JuliaRL_TabularCFR_OpenSpiel(kuhn_poker)`

E`JuliaRL_DeepCFR_OpenSpiel(leduc_poker)`

E`JuliaRL_DQN_SnakeGame`

E`JuliaRL_BC_CartPole`

E`JuliaRL_BasicDQN_EmptyRoom`

E`Dopamine_DQN_Atari(pong)`

E`Dopamine_Rainbow_Atari(pong)`

E`Dopamine_IQN_Atari(pong)`

E`rlpyt_A2C_Atari(pong)`

E`rlpyt_PPO_Atari(pong)`

🌲 Project Structure

ReinforcementLearning.jl itself is just a wrapper around several other subpackages. The relationship between them is depicted below:

+-----------------------------------------------------------------------------------+
|                                                                                   |
|  ReinforcementLearning.jl                                                         |
|                                                                                   |
|      +------------------------------+                                             |
|      | ReinforcementLearningBase.jl |                                             |
|      +----|-------------------------+                                             |
|           |                                                                       |
|           |     +--------------------------------------+                          |
|           +---->+ ReinforcementLearningEnvironments.jl |                          |
|           |     +--------------------------------------+                          |
|           |                                                                       |
|           |     +------------------------------+                                  |
|           +---->+ ReinforcementLearningCore.jl |                                  |
|                 +----|-------------------------+                                  |
|                      |                                                            |
|                      |     +-----------------------------+                        |
|                      +---->+ ReinforcementLearningZoo.jl |                        |
|                            +----|------------------------+                        |
|                                 |                                                 |
|                                 |     +-------------------------------------+     |
|                                 +---->+ DistributedReinforcementLearning.jl |     |
|                                       +-------------------------------------+     |
|                                                                                   |
+------|----------------------------------------------------------------------------+
       |
       |     +-------------------------------------+
       +---->+ ReinforcementLearningExperiments.jl |
       |     +-------------------------------------+
       |
       |     +----------------------------------------+
       +---->+ ReinforcementLearningAnIntroduction.jl |
             +----------------------------------------+

🖖 Supporting

ReinforcementLearning.jl is a MIT licensed open source project with its ongoing development made possible by many contributors in their spare time. However, modern reinforcement learning research requires huge computing resource, which is unaffordable for individual contributors. So if you or your organization could provide the computing resource in some degree and would like to cooperate in some way, please contact us!

✍️ Citing

If you use ReinforcementLearning.jl in a scientific publication, we would appreciate references to the CITATION.bib.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

_jbrea 💻📖🚧	_{Jun Tian} 💻📖🚧🤔	_{Aman Bhatia} 📖	_{Alexander Terenin} 💻	_Sid-Bhatia-0 💻	_norci 💻🚧	_Sriram 💻
_{Pavan B Govindaraju} 💻	_{Alex Lewandowski} 💻	_{Raj Ghugare} 💻	_{Roman Bange} 💻	_{Felix Chalumeau} 💻	_{Rishabh Varshney} 💻	_{Zachary Sunberg} 💻📖🚧🤔
_{Jonathan Laurent} 🤔	_{Andriy Drozdyuk} 📖	_{Ritchie Lee} 🐛	_{Xirui Zhao} 💻	_Nerd 📖	_{Albin Heimerson} 💻	_{michelangelo21} 🐛
_{GuoYu Yang} 📖💻	_{Prasidh Srikumar} 💻	_{Ilan Coulon} 💻	_{Jinrae Kim} 📖🐛	_luigiannelli 🐛	_{Jacob Boerma} 💻	_{Xavier Valcarce} 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!