stable-baselines3-contrib-sacd

History

kronion ab24f8039f PPO variant with invalid action masking (#25 ) * Add wrappers * Add maskable distributions * Add mypy configuration * Add maskable base datastructures * Add ppo_mask package * Fix circular dependency and remove test code that slipped in * Automatically mask vecenv if env is masked * Fix debugging change that slipped in * Workaround for subclassing RolloutBufferSamples * Duplicate lots of policy code in order to swap out the distributions used * Fix pytype error * Maintain py 3.6 compatibility * Fix isort lint errors * Use pyproject.toml to configure black line length * Blacken * Remove mypy.ini * Fully replace RolloutBufferSamples * Drop support for continuous distributions, remove SDE-related code * Eliminate MaskableAlgorithm and MaskableOnPolicyAlgorithm * Fix formatting * Override superclass methods as needed, fix circular import, improve naming * Fix codestyle * Eliminate VecActionMasker, replace with utils * Fix codestyle * Support masking for MultiDiscrete action spaces * Fix codestyle * Don't require the env to provide the mask already flattened * Consistent naming, prefer 'Maskable' to 'Masked' * Register policy * Link to abstract instead of pdf * Allow distribution masking to be unapplied + improved comments and docstrings * Don't use deprecated implicit optional typing * Check codestyle * Add docstring and remove misplaced TODO * Simplify env masking API, error if API unmet. Make use_masking a learn() kwarg * Fix codestyle * Update various internals to be consistent with latest SB3 * Simplify MaskableRolloutBuffer reset * Add docstring and type annotations * Ensure old probs aren't cached * Fix for new logger * Add test + fixes * Start doc * Fix type annotation * Remove abstract class + add test * Fix evaluation (add support for multi envs) * Handle merge conflicts in documentation * Bugfix: mask updates should apply to original logits, not the last masked output * Add test of distribution masking behavior * Reformat * Add MultiBinary support, remove unneeded distribution type checks * Remove unused import * Fix when using multiple envs * Remove addressed TODO * Upgrade for SB3 1.2.0 * Update docs with results + how to replicate * Add action masker tests, move wrapper tests * Move distributions, add more distribution tests * Add MaskablePPO tests, simplify and rename discrete test env * Address TODO * Add tests for MaskableMultiCategoricalDistribution, fix distributions * Add maskable identity envs for all supported action spaces, add tests, fix bug * Formatting fixes * Update doc env * Dict support not ready * Cleanup Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>		2021-09-23 14:50:10 +02:00
..
_static	Add TQC (#4 )	2020-10-22 13:43:46 +02:00
common	Add TimeFeatureWrapper (#7 )	2020-11-13 13:00:56 +02:00
guide	Add QR-DQN (#13 )	2020-12-21 11:17:48 +01:00
images	PPO variant with invalid action masking (#25 )	2021-09-23 14:50:10 +02:00
misc	PPO variant with invalid action masking (#25 )	2021-09-23 14:50:10 +02:00
modules	PPO variant with invalid action masking (#25 )	2021-09-23 14:50:10 +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	PPO variant with invalid action masking (#25 )	2021-09-23 14:50:10 +02:00
conf.py	Add base doc	2020-10-12 20:21:52 +02:00
index.rst	PPO variant with invalid action masking (#25 )	2021-09-23 14:50:10 +02:00
make.bat	Add base doc	2020-10-12 20:21:52 +02:00
spelling_wordlist.txt	Add base doc	2020-10-12 20:21:52 +02: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