stable-baselines3/docs
Alex Pasquali 6d55a09f81
Updated custom policy docs to better explain the `mlp_extractor`'s dimensions (#1196)
* Updated custom policy docs

Better explained how the dimensions of the mlp_extractor work, including the action net and the value net after the layers specified in net_arch.

* Improved custom policy doc

Section: Custom Network Architecture.
Explained with greater detail that an action net and a value net will be added on top of the net_arch.

* Improved custom policy doc

Section: Custom Network Architecture.
Merged a comment into a note

* Alignment

Co-authored-by: Quentin GALLOUÉDEC <gallouedec.quentin@gmail.com>
2022-12-12 16:19:51 +01:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Add explanation of logger output (#803) 2022-03-07 12:20:43 +01:00
guide Updated custom policy docs to better explain the `mlp_extractor`'s dimensions (#1196) 2022-12-12 16:19:51 +01:00
misc Updated custom policy docs to better explain the `mlp_extractor`'s dimensions (#1196) 2022-12-12 16:19:51 +01:00
modules Update changelog for #1184 (#1185) 2022-11-28 19:36:26 +01:00
conda_env.yml Release v1.6.0 (#958) 2022-07-12 22:50:23 +02:00
conf.py Mypy type checking (#1143) 2022-11-16 13:22:57 +01:00
index.rst Update SB3 Contrib doc (ARS) and W&B integration (#726) 2022-01-18 15:10:25 +01:00
make.bat Add doc 2019-09-26 11:46:40 +02:00
Makefile Dictionary Observations (#243) 2021-05-11 12:29:30 +02:00
README.md Add package to install (#378) 2021-04-10 14:04:37 +02:00
spelling_wordlist.txt Add custom objects support + bug fix (#336) 2021-03-06 15:17:43 +02:00

Stable Baselines3 Documentation

This folder contains documentation for the RL baselines.

Build the Documentation

Install Sphinx and Theme

Execute this command in the project root:

pip install -e .[docs]

Building the Docs

In the docs/ folder:

make html

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

sphinx-autobuild . _build/html