stable-baselines3/docs
Anssi 44f8218df0
Review of code (A2C, PPO and refactoring) (#35)
* Split torch module code into torch_layers file

* Updated reference to CNN

* Change 'CxWxH' to 'CxHxW', as per common notion

* Fix missing import in policies.py

* Move PPOPolicy to OnlineActorCriticPolicy

* Create OnPolicyRLModel from PPO, and make A2C and PPO inherit

* Update A2C optimizer comment

* Clean weight init scales for clarity

* Fix A2C log_interval default parameter

* Rename 'progress' to 'progress_remaining

* Rename 'Models' to 'Algorithms'

* Rename 'OnlineActorCriticPolicy' to 'ActorCriticPolicy'

* Move static functions out from BaseAlgorithm

* Move on/off_policy base algorithms to their own files

* Add  files for A2C/PPO

* Fix docs

* Fix pytype

* Update documentation on OnPolicyAlgorithm

* Add proper doctstring for on_policy rollout gathering

* Add bit clarification on the mlppolicy/cnnpolicy naming

* Move static function is_vectorized_policies to utils.py

* Checking docstrings, pep8 fixes

* Update changelog

* Clean changelog

* Remove policy warnings for sac/td3

* Add monitor_wrapper for OnPolicyAlgorithm. Clean tb logging variables. Add parameter keywords to OffPolicyAlgorithm super init

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2020-06-09 13:54:18 +02:00
..
_static Tensorboard integration (#30) 2020-06-01 11:55:44 +02:00
common Update doc 2020-05-19 10:40:52 +02:00
guide Review of code (A2C, PPO and refactoring) (#35) 2020-06-09 13:54:18 +02:00
misc Review of code (A2C, PPO and refactoring) (#35) 2020-06-09 13:54:18 +02:00
modules Review of code (A2C, PPO and refactoring) (#35) 2020-06-09 13:54:18 +02:00
conda_env.yml Use conda env for building the doc (#16) 2020-05-11 17:39:41 +02:00
conf.py Use conda env for building the doc (#16) 2020-05-11 17:39:41 +02:00
index.rst Tensorboard integration (#30) 2020-06-01 11:55:44 +02: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 Fix typos 2020-05-08 12:28:41 +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