stable-baselines3/docs
Carlos M. Casas Cuadrado 5993033c73
Add image and figure to tensorboard logger (#277)
* Added Image and Figure classes to logger. For now, these objects can only be logged by TensorBoardOutputFormat

* Added documentation for figure and image logging into tensorboard

* Updated changelog

* Minor changes to documentation. Reviewed supported types for logging images and figures

* Fix type for np arrays

* Added more explicit example for logging figures in the documentation. Added docstrings for parameters in logging auxiliary classes

* Added tests for image and figure logging

* Applied autoformatting

* Update doc

* Fix documentation example

* Bump version

Co-authored-by: Carlos Casas <ccasascuadrado@guidewire.com>
Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2021-01-08 15:47:08 +01:00
..
_static Cleanup docstring types (#169) 2020-10-02 20:05:55 +03:00
common Rename cmd_util to env_util (#197) 2020-10-22 11:05:52 +02:00
guide Add image and figure to tensorboard logger (#277) 2021-01-08 15:47:08 +01:00
misc Add image and figure to tensorboard logger (#277) 2021-01-08 15:47:08 +01:00
modules Update the code in Example. (#273) 2021-01-04 14:24:38 +02:00
conda_env.yml Update docs (custom policy, type hints) (#167) 2020-09-29 20:41:14 +03:00
conf.py Update docs (custom policy, type hints) (#167) 2020-09-29 20:41:14 +03:00
index.rst Update doc: SB3-Contrib (#267) 2020-12-21 16:17:24 +01: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