stable-baselines3/docs
Anssi b833207142
Add some missing tests, update VecNormalize and RolloutBuffer (#50)
* Change saving/loading normalization parameters to use single pickle file

* Remove 'use_gae' from RolloutBuffer compute_returns function

* Add some missing tests for normalizer, nan-checker and PPO clip_value_fn argument

* Update changelog

* Fix typo

* Use proper pytest.raises for catching errors in tests

* Add comment on GAE and how to obtain non-GAE behaviour

* Remove save/load_running_average from VecNormalize in favor of load/save

* Update changelog

* Update docstring

* Add accidentally removed tests for VecNormalize

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2020-06-10 12:09:04 +02:00
..
_static Tensorboard integration (#30) 2020-06-01 11:55:44 +02:00
common Update doc 2020-05-19 10:40:52 +02:00
guide Review of code (A2C, PPO and refactoring) (#35) 2020-06-09 13:54:18 +02:00
misc Add some missing tests, update VecNormalize and RolloutBuffer (#50) 2020-06-10 12:09:04 +02:00
modules Review of code (A2C, PPO and refactoring) (#35) 2020-06-09 13:54:18 +02:00
conda_env.yml Use conda env for building the doc (#16) 2020-05-11 17:39:41 +02:00
conf.py Use conda env for building the doc (#16) 2020-05-11 17:39:41 +02:00
index.rst Tensorboard integration (#30) 2020-06-01 11:55:44 +02:00
make.bat Add doc 2019-09-26 11:46:40 +02:00
Makefile Add doc 2019-09-26 11:46:40 +02:00
README.md Add base doc 2020-05-07 10:10:51 +02:00
spelling_wordlist.txt Fix typos 2020-05-08 12:28:41 +02:00

Stable Baselines3 Documentation

This folder contains documentation for the RL baselines.

Build the Documentation

Install Sphinx and Theme

pip install sphinx sphinx-autobuild sphinx-rtd-theme

Building the Docs

In the docs/ folder:

make html

if you want to building each time a file is changed:

sphinx-autobuild . _build/html