stable-baselines3/docs
Cody Wild b1aee71772
Improve error messages when PPO effective batch size is 1 and when last mini-batch is truncated (#270)
* Add warning about total_env_steps not dividing neatly into batch size

* Stylistic cleanup

* Black reformatting

* Add clearer documentation and update changelog

* Update changelog.rst

* Use specific RolloutBuffer terminology

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>

* Change to minibatch language

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>

* Cleaning up language describing rollout buffer requirements

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>

* Switch to using env.num_envs

* Working tests

* Black and isort still fighting each other

* codestyle finally happy

* Basic test exists, possibly in the wrong file

* Update phrasing

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2021-01-11 17:03:32 +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 Improve error messages when PPO effective batch size is 1 and when last mini-batch is truncated (#270) 2021-01-11 17:03:32 +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