stable-baselines3/docs
Oleksii Kachaiev 0503e694b2
Introduce norm_obs_keys param for VecNormalize environment wrapper (#631)
* Implement new norm_obs_keys param for VecNormalize environment wrapper

* Simplified doc string to avoid issues with lint and doc

* Updated changelog

* Update changelog.rst

* Update test_vec_normalize.py

* Update sanity checks

* Fix backward compat

* Update doc

* Update changelog

* Fix lint warnings

* Fix tests

* Minor edit

* observation_space sanity check was applied twice

Co-authored-by: Oleksii Kachaiev <okachaiev@riotgames.com>
Co-authored-by: Anssi <kaneran21@hotmail.com>
Co-authored-by: Antonin Raffin <antonin.raffin@dlr.de>
2021-10-28 19:18:39 +02:00
..
_static Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +01:00
common Fix logger setup (#469) 2021-06-14 15:17:48 +02:00
guide Fix set_env to keep the number of timesteps (#615) 2021-10-23 16:36:40 +02:00
misc Introduce norm_obs_keys param for VecNormalize environment wrapper (#631) 2021-10-28 19:18:39 +02:00
modules Doc fix environment mixup (#588) 2021-09-29 10:16:59 +02:00
conda_env.yml ONNX Documentation Update (#464) 2021-09-26 17:40:35 +02:00
conf.py Update docs (custom policy, type hints) (#167) 2020-09-29 20:41:14 +03:00
index.rst Dictionary Observations (#243) 2021-05-11 12:29:30 +02: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