stable-baselines3/docs
David Blom 3efab0d267
Training and evaluation: call model.train() and model.eval() (#537)
* training and evaluation: call model.train() and model.eval() to enable and disable dropout and batchnorm

* Add comment documentation

* Fix train and eval for the Actor class

* Run black

* Add github handle to changelog

* Add unit tests for PPO and DQN

* Refactor unit test

* Run black

* unit test: add a dropout layer and check that calling predict with deterministic=True is deterministic

* documentation: add bugfix description to changelog

* unit test: use learning_starts=0, decrease the size of the network and use more training steps

* on policy algorithms: call policy.train() and policy.eval() instead of disable_training and enable_training as it is a th.nn.module

* Rename unit test

* unit test: use drop out probability of 0.5

* Call policy.train and policy.eval

* Fixes + update tests

* Remove unneeded eval

Co-authored-by: David Blom <davidsblom@gmail.com>
Co-authored-by: Antonin Raffin <antonin.raffin@ensta.org>
2021-08-14 14:08:27 +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 Docs examples warning - issue #526 (#530) 2021-08-09 16:23:25 +03:00
misc Training and evaluation: call model.train() and model.eval() (#537) 2021-08-14 14:08:27 +02:00
modules Docs examples warning - issue #526 (#530) 2021-08-09 16:23:25 +03:00
conda_env.yml Documentation update (#450) 2021-05-23 13:13:11 +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