stable-baselines3/docs
Francisco Caio 5fc90a7f7d
Add StopTrainingOnMaxEpisodes to callback collection (#147)
* Add StopTrainingOnMaxEpisodes class to pre-made callback collection

* Adjust instant when counters are incremented for both OnPolicy and OffPolicy algorithms

* Improv to StopTrainingOnMaxEpisodes including output, tests and doc

* Improv StopTrainingOnMaxEpisodes callback running _init_callback

* Update callbacks.py

* Update test_callbacks.py

* Fix style

* Update changelog.rst

* Fix test

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
Co-authored-by: Antonin Raffin <antonin.raffin@dlr.de>
2020-08-28 11:36:33 +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 Add StopTrainingOnMaxEpisodes to callback collection (#147) 2020-08-28 11:36:33 +02:00
misc Add StopTrainingOnMaxEpisodes to callback collection (#147) 2020-08-28 11:36:33 +02:00
modules Match performance with stable-baselines (discrete case) (#110) 2020-08-03 22:22:51 +02:00
conda_env.yml Use conda env for building the doc (#16) 2020-05-11 17:39:41 +02:00
conf.py Auto-formatting with black and isort (#97) 2020-07-16 16:12:16 +02:00
index.rst Remove "device" argument from policies (#141) 2020-08-23 13:27:52 +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 Implement DDPG (#92) 2020-07-16 14:14:22 +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