stable-baselines3-contrib-sacd/docs
Antonin RAFFIN 75b2de1399
Recurrent PPO (#53)
* Running (not working yet) version of recurrent PPO

* Fixes for multi envs

* Save WIP, rework the sampling

* Add Box support

* Fix sample order

* Being cleanup, code is broken (again)

* First working version (no shared lstm)

* Start cleanup

* Try rnn with value function

* Re-enable batch size

* Deactivate vf rnn

* Allow any batch size

* Add support for evaluation

* Add CNN support

* Fix start of sequence

* Allow shared LSTM

* Rename mask to episode_start

* Fix type hint

* Enable LSTM for critic

* Clean code

* Fix for CNN LSTM

* Fix sampling with n_layers > 1

* Add std logger

* Update wording

* Rename and add dict obs support

* Fixes for dict obs support

* Do not run slow tests

* Fix doc

* Update recurrent PPO example

* Update README

* Use Pendulum-v1 for tests

* Fix image env

* Speedup LSTM forward pass (#63)

* added more efficient lstm implementation

* Rename and add comment

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

* Fixes

* Remove OpenAI sampling and improve coverage

* Sync with SB3 PPO

* Pass state shape and allow lstm kwargs

* Update tests

* Add masking for padded sequences

* Update default in perf test

* Remove TODO, mask is now working

* Add helper to remove duplicated code, remove hack for padding

* Enable LSTM critic and raise threshold for cartpole with no vel

* Fix tests

* Update doc and tests

* Doc fix

* Fix for new Sphinx version

* Fix doc note

* Switch to batch first, no more additional swap

* Add comments and mask entropy loss

Co-authored-by: Neville Walo <43504521+Walon1998@users.noreply.github.com>
2022-05-30 04:31:12 +02:00
..
_static Add TQC (#4) 2020-10-22 13:43:46 +02:00
common Add Trust Region Policy Optimization (TRPO) (#40) 2021-12-29 11:58:03 +01:00
guide Recurrent PPO (#53) 2022-05-30 04:31:12 +02:00
images PPO variant with invalid action masking (#25) 2021-09-23 14:50:10 +02:00
misc Recurrent PPO (#53) 2022-05-30 04:31:12 +02:00
modules Recurrent PPO (#53) 2022-05-30 04:31:12 +02:00
Makefile Add base doc 2020-10-12 20:21:52 +02:00
README.md Review docs and update changelog 2020-10-15 02:17:36 +03:00
conda_env.yml Drop python 3.6 support (#55) 2021-12-06 12:59:53 +01:00
conf.py Upgrade min SB3 version (#70) 2022-05-29 21:54:23 +02:00
index.rst Recurrent PPO (#53) 2022-05-30 04:31:12 +02:00
make.bat Add base doc 2020-10-12 20:21:52 +02:00
spelling_wordlist.txt Augmented Random Search (ARS) (#42) 2022-01-18 13:57:27 +01:00

README.md

Stable Baselines3 Contrib Documentation

This folder contains documentation for the RL baselines contribution repository.

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