2020-05-07 08:10:51 +00:00
.. Stable Baselines3 documentation master file, created by
2019-09-26 09:46:40 +00:00
sphinx-quickstart on Thu Sep 26 11:06:54 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree`
2020-05-08 11:09:38 +00:00
Welcome to Stable Baselines3 docs! - RL Baselines Made Easy
===========================================================
2019-09-26 09:46:40 +00:00
2020-05-07 08:10:51 +00:00
`Stable Baselines3 <https://github.com/DLR-RM/stable-baselines3> `_ is a set of improved implementations of reinforcement learning algorithms in PyTorch.
2020-05-08 11:09:38 +00:00
It is the next major version of `Stable Baselines <https://github.com/hill-a/stable-baselines> `_ .
2020-05-07 08:10:51 +00:00
Github repository: https://github.com/DLR-RM/stable-baselines3
2019-09-26 09:46:40 +00:00
2020-05-05 15:41:57 +00:00
RL Baselines3 Zoo (collection of pre-trained agents): https://github.com/DLR-RM/rl-baselines3-zoo
2019-09-26 09:46:40 +00:00
2020-05-05 15:41:57 +00:00
RL Baselines3 Zoo also offers a simple interface to train, evaluate agents and do hyperparameter tuning.
2019-09-26 09:46:40 +00:00
2020-05-07 08:10:51 +00:00
Main Features
--------------
- Unified structure for all algorithms
- PEP8 compliant (unified code style)
- Documented functions and classes
- Tests, high code coverage and type hints
- Clean code
2020-06-01 09:55:44 +00:00
- Tensorboard support
2020-05-07 08:10:51 +00:00
2019-09-26 09:46:40 +00:00
.. toctree ::
:maxdepth: 2
:caption: User Guide
2020-05-07 08:10:51 +00:00
guide/install
2019-09-26 09:46:40 +00:00
guide/quickstart
2020-05-07 08:10:51 +00:00
guide/rl_tips
guide/rl
2020-05-07 14:08:23 +00:00
guide/algos
guide/examples
2019-09-26 09:46:40 +00:00
guide/vec_envs
2020-05-07 08:10:51 +00:00
guide/custom_env
2020-05-07 14:08:23 +00:00
guide/custom_policy
2020-05-07 08:10:51 +00:00
guide/callbacks
2020-06-01 09:55:44 +00:00
guide/tensorboard
2020-05-08 09:58:43 +00:00
guide/rl_zoo
2020-05-07 08:10:51 +00:00
guide/migration
guide/checking_nan
2020-05-08 14:20:21 +00:00
guide/developer
2019-09-26 09:46:40 +00:00
.. toctree ::
:maxdepth: 1
:caption: RL Algorithms
modules/base
2020-01-20 15:19:35 +00:00
modules/a2c
2019-09-26 09:46:40 +00:00
modules/ppo
modules/sac
modules/td3
2020-06-29 09:16:54 +00:00
modules/dqn
2019-09-26 09:46:40 +00:00
2020-05-07 08:10:51 +00:00
.. toctree ::
:maxdepth: 1
:caption: Common
2020-05-08 11:09:38 +00:00
common/atari_wrappers
2020-05-19 08:19:16 +00:00
common/cmd_util
2020-05-07 08:10:51 +00:00
common/distributions
common/evaluation
common/env_checker
2020-05-08 11:09:38 +00:00
common/monitor
common/logger
common/noise
common/utils
2019-09-26 09:46:40 +00:00
.. toctree ::
:maxdepth: 1
:caption: Misc
misc/changelog
2020-05-07 08:10:51 +00:00
misc/projects
2019-09-26 09:46:40 +00:00
2020-05-05 13:02:35 +00:00
Citing Stable Baselines3
2020-05-05 14:28:38 +00:00
------------------------
2019-09-26 09:46:40 +00:00
To cite this project in publications:
.. code-block :: bibtex
2020-05-05 14:28:38 +00:00
@misc{stable-baselines3,
2020-02-03 14:57:37 +00:00
author = {Raffin, Antonin and Hill, Ashley and Ernestus, Maximilian and Gleave, Adam and Kanervisto, Anssi and Dormann, Noah},
2020-05-05 13:02:35 +00:00
title = {Stable Baselines3},
2019-09-26 09:46:40 +00:00
year = {2019},
publisher = {GitHub},
journal = {GitHub repository},
2020-05-05 14:28:38 +00:00
howpublished = {\url{https://github.com/DLR-RM/stable-baselines3}},
2019-09-26 09:46:40 +00:00
}
Indices and tables
-------------------
* :ref: `genindex`
* :ref: `search`
* :ref: `modindex`
