diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..6753d87 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,16 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Set requirements using conda env +conda: + environment: docs/conda_env.yml diff --git a/README.md b/README.md index cdcc9fe..7550cee 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,9 @@ See documentation for the full list of included features. - [Truncated Quantile Critics (TQC)](https://arxiv.org/abs/2005.04269) - - +Documentation is available online: [https://sb3-contrib.readthedocs.io/](https://sb3-contrib.readthedocs.io/) ## Installation diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index f2ea8b0..8ab60da 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -4,7 +4,7 @@ Changelog ========== -Pre-Release 0.10.0a0 (WIP) +Pre-Release 0.10.0a1 (WIP) ------------------------------ Breaking Changes: diff --git a/sb3_contrib/version.txt b/sb3_contrib/version.txt index 37f1777..8dabd1f 100644 --- a/sb3_contrib/version.txt +++ b/sb3_contrib/version.txt @@ -1 +1 @@ -0.10.0a0 +0.10.0a1 diff --git a/setup.py b/setup.py index f5adfad..fce8b5a 100644 --- a/setup.py +++ b/setup.py @@ -8,13 +8,49 @@ with open(os.path.join("sb3_contrib", "version.txt"), "r") as file_handler: long_description = """ -# Stable-Baselines3 - Contrib +# Stable-Baselines3 - Contrib (SB3-Contrib) -Contrib package for [Stable-Baselines3](https://github.com/DLR-RM/stable-baselines3) - Experimental code +Contrib package for [Stable-Baselines3](https://github.com/DLR-RM/stable-baselines3) - Experimental reinforcement learning (RL) code. +"sb3-contrib" for short. -Implemented: +### What is SB3-Contrib? + +A place for RL algorithms and tools that are considered experimental, e.g. implementations of the latest publications. Goal is to keep the simplicity, documentation and style of stable-baselines3 but for less matured implementations. + +### Why create this repository? + +Over the span of stable-baselines and stable-baselines3, the community has been eager to contribute in form of better logging utilities, environment wrappers, extended support (e.g. different action spaces) and learning algorithms. + +However sometimes these utilities were too niche to be considered for stable-baselines or +proved to be too difficult to integrate well into existing code without a mess. sb3-contrib aims to fix this by not requiring the neatest code integration with existing code and not setting limits on what is too niche: almost everything remotely useful goes! We hope this allows to extend the known quality of stable-baselines style and documentation beyond the relatively small scope of utilities of the main repository. + + +## Features + +See documentation for the full list of included features. + +**RL Algorithms**: - [Truncated Quantile Critics (TQC)](https://arxiv.org/abs/2005.04269) + +## Documentation + +Documentation is available online: [https://sb3-contrib.readthedocs.io/](https://sb3-contrib.readthedocs.io/) + + +## Installation + +**Note:** You need the `master` version of [Stable Baselines3](https://github.com/DLR-RM/stable-baselines3/). + +To install Stable Baselines3 `master` version: +``` +pip install git+https://github.com/DLR-RM/stable-baselines3 +``` + +Install Stable Baselines3 - Contrib using pip: +``` +pip install git+https://github.com/Stable-Baselines-Team/stable-baselines3-contrib + """ # noqa:E501