mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-05-14 20:58:03 +00:00
dd3d0acf15
* Update readme and clarify planned features * Fix rtd python version * Fix pip version for rtd * Update rtd ubuntu and mambaforge * Add upper bound for gymnasium * [ci skip] Update readme
132 lines
3.5 KiB
ReStructuredText
132 lines
3.5 KiB
ReStructuredText
.. Stable Baselines3 documentation master file, created by
|
|
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` directive.
|
|
|
|
Stable-Baselines3 Docs - Reliable Reinforcement Learning Implementations
|
|
========================================================================
|
|
|
|
`Stable Baselines3 (SB3) <https://github.com/DLR-RM/stable-baselines3>`_ is a set of reliable implementations of reinforcement learning algorithms in PyTorch.
|
|
It is the next major version of `Stable Baselines <https://github.com/hill-a/stable-baselines>`_.
|
|
|
|
|
|
Github repository: https://github.com/DLR-RM/stable-baselines3
|
|
|
|
Paper: https://jmlr.org/papers/volume22/20-1364/20-1364.pdf
|
|
|
|
RL Baselines3 Zoo (training framework for SB3): https://github.com/DLR-RM/rl-baselines3-zoo
|
|
|
|
RL Baselines3 Zoo provides a collection of pre-trained agents, scripts for training, evaluating agents, tuning hyperparameters, plotting results and recording videos.
|
|
|
|
SB3 Contrib (experimental RL code, latest algorithms): https://github.com/Stable-Baselines-Team/stable-baselines3-contrib
|
|
|
|
|
|
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
|
|
- Tensorboard support
|
|
- **The performance of each algorithm was tested** (see *Results* section in their respective page)
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User Guide
|
|
|
|
guide/install
|
|
guide/quickstart
|
|
guide/rl_tips
|
|
guide/rl
|
|
guide/algos
|
|
guide/examples
|
|
guide/vec_envs
|
|
guide/custom_policy
|
|
guide/custom_env
|
|
guide/callbacks
|
|
guide/tensorboard
|
|
guide/integrations
|
|
guide/rl_zoo
|
|
guide/sb3_contrib
|
|
guide/sbx
|
|
guide/imitation
|
|
guide/migration
|
|
guide/checking_nan
|
|
guide/developer
|
|
guide/save_format
|
|
guide/export
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: RL Algorithms
|
|
|
|
modules/base
|
|
modules/a2c
|
|
modules/ddpg
|
|
modules/dqn
|
|
modules/her
|
|
modules/ppo
|
|
modules/sac
|
|
modules/td3
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Common
|
|
|
|
common/atari_wrappers
|
|
common/env_util
|
|
common/envs
|
|
common/distributions
|
|
common/evaluation
|
|
common/env_checker
|
|
common/monitor
|
|
common/logger
|
|
common/noise
|
|
common/utils
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Misc
|
|
|
|
misc/changelog
|
|
misc/projects
|
|
|
|
|
|
Citing Stable Baselines3
|
|
------------------------
|
|
To cite this project in publications:
|
|
|
|
.. code-block:: bibtex
|
|
|
|
@article{stable-baselines3,
|
|
author = {Antonin Raffin and Ashley Hill and Adam Gleave and Anssi Kanervisto and Maximilian Ernestus and Noah Dormann},
|
|
title = {Stable-Baselines3: Reliable Reinforcement Learning Implementations},
|
|
journal = {Journal of Machine Learning Research},
|
|
year = {2021},
|
|
volume = {22},
|
|
number = {268},
|
|
pages = {1-8},
|
|
url = {http://jmlr.org/papers/v22/20-1364.html}
|
|
}
|
|
|
|
Note: If you need to refer to a specific version of SB3, you can also use the `Zenodo DOI <https://doi.org/10.5281/zenodo.8123988>`_.
|
|
|
|
Contributing
|
|
------------
|
|
|
|
To any interested in making the rl baselines better, there are still some improvements
|
|
that need to be done.
|
|
You can check issues in the `repository <https://github.com/DLR-RM/stable-baselines3/labels/help%20wanted>`_.
|
|
|
|
If you want to contribute, please read `CONTRIBUTING.md <https://github.com/DLR-RM/stable-baselines3/blob/master/CONTRIBUTING.md>`_ first.
|
|
|
|
Indices and tables
|
|
-------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|
|
* :ref:`modindex`
|