stable-baselines3/docs
Max Weltevrede ef10189d80
Prohibit simultaneous use of optimize_memory_usage and handle_timeout_termination (#948)
* Prohibit simultaneous use of optimize_memory_buffer and handle_timeout_termination

* Modify test to avoid unsupported buffer configuration

* Change from assertion to raising of ValueError

* Update changelog

* Update style for consistency

* Use handle_timeout_termination when possible

Co-authored-by: Anssi <kaneran21@hotmail.com>
Co-authored-by: Antonin Raffin <antonin.raffin@ensta.org>
2022-07-04 15:08:54 +02:00
..
_static Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +01:00
common Add explanation of logger output (#803) 2022-03-07 12:20:43 +01:00
guide Update doc: SB3 Contrib RecurrentPPO (#927) 2022-05-31 18:11:16 +02:00
misc Prohibit simultaneous use of optimize_memory_usage and handle_timeout_termination (#948) 2022-07-04 15:08:54 +02:00
modules Update doc: SB3 Contrib RecurrentPPO (#927) 2022-05-31 18:11:16 +02:00
conda_env.yml Drop Python 3.6 support (#685) 2021-12-06 12:54:43 +01:00
conf.py Fix issues due to newer version of protobuf and sphinx (#924) 2022-05-29 21:09:50 +02:00
index.rst Update SB3 Contrib doc (ARS) and W&B integration (#726) 2022-01-18 15:10:25 +01:00
make.bat
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