stable-baselines3/docs
Quentin Gallouédec 92f7a6f23b
Fix test_vec_normalize.py, test_tensorboard.py and common/monitor.py type hint (#1194)
* Remove from mypy exclude

* type hint for metadata

* Union[float, int] -> float

* Remove useless __init__

* Type hint for model and logger in BaseCallback

* Type hint for metric_dict

* Update changelog

* fix test_tensorboard

* ignore gamma type checking

* Fix monitor type hint

* Update logger type hints

* Fix type annotation and bump version

* Fix circular import

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2023-01-13 18:28:22 +01:00
..
_static Adds info on split tensorboard graphs (#989) 2022-07-30 12:44:25 +02:00
common Fix support of image like normalized inputs (#1214) 2022-12-20 13:18:28 +01:00
guide Fix test_vec_normalize.py, test_tensorboard.py and common/monitor.py type hint (#1194) 2023-01-13 18:28:22 +01:00
misc Fix test_vec_normalize.py, test_tensorboard.py and common/monitor.py type hint (#1194) 2023-01-13 18:28:22 +01:00
modules Update changelog for #1184 (#1185) 2022-11-28 19:36:26 +01:00
conda_env.yml Release v1.6.0 (#958) 2022-07-12 22:50:23 +02:00
conf.py Mypy type checking (#1143) 2022-11-16 13:22:57 +01:00
index.rst Update SB3 Contrib doc (ARS) and W&B integration (#726) 2022-01-18 15:10:25 +01: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