stable-baselines3/docs
Roland Gavrilescu bb01253261
Tensorboard integration (#30)
* init commit tensorboard-integration

* Added tb logger to ppo (with output exclusions)

* fixed truncated stdout

* categorize stdout outputs by tag

* separated exclusions from values, added missing logs

* saving exclusions as dict instead of list

* reformatting, auto run indexing

* included renaming suggestions, fixed tests

* tb support for sac

* linting

* moved logging to base class

* tb support for td3

* removed histograms, non-verbose output working

* modifed changelog

* linting

* fixed type error

* moved logger config to utils

* removed episode_rewards log from ppo

* Enable tensorboard in tests

* Remove unused import

* Update logger sub titles

* Minor edit for PPO

* Update logger and tb log folder

* Pass correct logger to Callbacks

* updated docs

* added tb example image to docs

* add support for continuing training in tensorboard

* added tensorboard to docs index

* added tb test

* moved logger config to _setup_learn, updated tests

* accessing verbose from base class

* Update doc and tests

* Rename session -> time

* Update version

* Update logger truncate

* Update types

* Remove duplicated code

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2020-06-01 11:55:44 +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 Tensorboard integration (#30) 2020-06-01 11:55:44 +02:00
misc Tensorboard integration (#30) 2020-06-01 11:55:44 +02:00
modules Fix TD3 Example Code Documentation (#38) 2020-06-01 11:37:42 +03: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