stable-baselines3/docs
Costa Huang ddbe0e93f9
Support for VecMonitor for gym3-style environments (#311)
* add vectorized monitor

* auto format of the code

* add documentation and VecExtractDictObs

* refactor and add test cases

* add test cases and format

* avoid circular import and fix doc

* fix type

* fix type

* oops

* Update stable_baselines3/common/monitor.py

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

* Update stable_baselines3/common/monitor.py

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

* add test cases

* update changelog

* fix mutable argument

* quick fix

* Apply suggestions from code review

* fix terminal observation for gym3 envs

* delete comment

* Update doc and bump version

* Add warning when already using `Monitor` wrapper

* Update vecmonitor tests

* Fixes

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2021-04-13 18:09:31 +02:00
..
_static Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +01:00
common Rename cmd_util to env_util (#197) 2020-10-22 11:05:52 +02:00
guide Support for VecMonitor for gym3-style environments (#311) 2021-04-13 18:09:31 +02:00
misc Support for VecMonitor for gym3-style environments (#311) 2021-04-13 18:09:31 +02:00
modules Add code of conduct + update doc (#373) 2021-03-31 10:31:03 +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 Stable-Baselines3 v1.0 (#354) 2021-03-17 14:20:31 +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 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