Add base doc
This commit is contained in:
Antonin RAFFIN
parent
5d7b79d41a
commit
5033b192cb
|
|
@ -29,15 +29,16 @@ jobs:
|
||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
# cpu version of pytorch
|
# cpu version of pytorch
|
||||||
pip install torch==1.6.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
|
pip install torch==1.6.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
|
||||||
|
# Install dependencies for docs and tests
|
||||||
pip install stable_baselines3[extra,tests,docs]
|
pip install stable_baselines3[extra,tests,docs]
|
||||||
# Install master version
|
# Install master version
|
||||||
pip install git+https://github.com/DLR-RM/stable-baselines3
|
pip install git+https://github.com/DLR-RM/stable-baselines3
|
||||||
pip install .
|
pip install .
|
||||||
# Use headless version
|
# Use headless version
|
||||||
pip install opencv-python-headless
|
pip install opencv-python-headless
|
||||||
# - name: Build the doc
|
- name: Build the doc
|
||||||
# run: |
|
run: |
|
||||||
# make doc
|
make doc
|
||||||
- name: Type check
|
- name: Type check
|
||||||
run: |
|
run: |
|
||||||
make type
|
make type
|
||||||
|
|
|
||||||
7
Makefile
7
Makefile
|
|
@ -28,6 +28,11 @@ check-codestyle:
|
||||||
|
|
||||||
commit-checks: format type lint
|
commit-checks: format type lint
|
||||||
|
|
||||||
|
doc:
|
||||||
|
cd docs && make html
|
||||||
|
|
||||||
|
spelling:
|
||||||
|
cd docs && make spelling
|
||||||
|
|
||||||
# PyPi package release
|
# PyPi package release
|
||||||
release:
|
release:
|
||||||
|
|
@ -41,4 +46,4 @@ test-release:
|
||||||
python setup.py bdist_wheel
|
python setup.py bdist_wheel
|
||||||
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
|
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
|
||||||
|
|
||||||
.PHONY: lint format check-codestyle commit-checks
|
.PHONY: lint format check-codestyle commit-checks doc spelling
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS = -W # make warnings fatal
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
SPHINXPROJ = StableBaselines
|
||||||
|
SOURCEDIR = .
|
||||||
|
BUILDDIR = _build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
## 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
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
/* Main colors adapted from pytorch doc */
|
||||||
|
:root{
|
||||||
|
--main-bg-color: #343A40;
|
||||||
|
--link-color: #FD7E14;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Header fonts y */
|
||||||
|
h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend, p.caption {
|
||||||
|
font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* Docs background */
|
||||||
|
.wy-side-nav-search{
|
||||||
|
background-color: var(--main-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Mobile version */
|
||||||
|
.wy-nav-top{
|
||||||
|
background-color: var(--main-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Change link colors (except for the menu) */
|
||||||
|
a {
|
||||||
|
color: var(--link-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
color: #4F778F;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu a {
|
||||||
|
color: #b3b3b3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu a:hover {
|
||||||
|
color: #b3b3b3;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.icon.icon-home {
|
||||||
|
color: #b3b3b3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.version{
|
||||||
|
color: var(--link-color) !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* Make code blocks have a background */
|
||||||
|
.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'] {
|
||||||
|
background: #f8f8f8;;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Change style of types in the docstrings .rst-content .field-list */
|
||||||
|
.field-list .xref.py.docutils, .field-list code.docutils, .field-list .docutils.literal.notranslate
|
||||||
|
{
|
||||||
|
border: None;
|
||||||
|
padding-left: 0;
|
||||||
|
padding-right: 0;
|
||||||
|
color: #404040;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="117" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="117" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h30v20H0z"/><path fill="#007ec6" d="M30 0h87v20H30z"/><path fill="url(#b)" d="M0 0h117v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><svg x="4px" y="0px" width="22px" height="20px" viewBox="-2 0 28 24" style="background-color: #fff;border-radius: 1px;"><path style="fill:#ef9008;" d="M1.977,16.77c-2.667-2.277-2.605-7.079,0-9.357C2.919,8.057,3.522,9.075,4.49,9.691c-1.152,1.6-1.146,3.201-0.004,4.803C3.522,15.111,2.918,16.126,1.977,16.77z"/><path style="fill:#fdba18;" d="M12.257,17.114c-1.767-1.633-2.485-3.658-2.118-6.02c0.451-2.91,2.139-4.893,4.946-5.678c2.565-0.718,4.964-0.217,6.878,1.819c-0.884,0.743-1.707,1.547-2.434,2.446C18.488,8.827,17.319,8.435,16,8.856c-2.404,0.767-3.046,3.241-1.494,5.644c-0.241,0.275-0.493,0.541-0.721,0.826C13.295,15.939,12.511,16.3,12.257,17.114z"/><path style="fill:#ef9008;" d="M19.529,9.682c0.727-0.899,1.55-1.703,2.434-2.446c2.703,2.783,2.701,7.031-0.005,9.764c-2.648,2.674-6.936,2.725-9.701,0.115c0.254-0.814,1.038-1.175,1.528-1.788c0.228-0.285,0.48-0.552,0.721-0.826c1.053,0.916,2.254,1.268,3.6,0.83C20.502,14.551,21.151,11.927,19.529,9.682z"/><path style="fill:#fdba18;" d="M4.49,9.691C3.522,9.075,2.919,8.057,1.977,7.413c2.209-2.398,5.721-2.942,8.476-1.355c0.555,0.32,0.719,0.606,0.285,1.128c-0.157,0.188-0.258,0.422-0.391,0.631c-0.299,0.47-0.509,1.067-0.929,1.371C8.933,9.539,8.523,8.847,8.021,8.746C6.673,8.475,5.509,8.787,4.49,9.691z"/><path style="fill:#fdba18;" d="M1.977,16.77c0.941-0.644,1.545-1.659,2.509-2.277c1.373,1.152,2.85,1.433,4.45,0.499c0.332-0.194,0.503-0.088,0.673,0.19c0.386,0.635,0.753,1.285,1.181,1.89c0.34,0.48,0.222,0.715-0.253,1.006C7.84,19.73,4.205,19.188,1.977,16.77z"/></svg><text x="245" y="140" transform="scale(.1)" textLength="30"> </text><text x="725" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="770">Open in Colab</text><text x="725" y="140" transform="scale(.1)" textLength="770">Open in Colab</text></g> </svg>
|
||||||
|
After Width: | Height: | Size: 2.3 KiB |
|
|
@ -0,0 +1,7 @@
|
||||||
|
<svg width="24px" height="15px" viewBox="0 0 24 15" version="1.1" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<path d="M1.977,11.77 C-0.69,9.493 -0.628,4.691 1.977,2.413 C2.919,3.057 3.522,4.075 4.49,4.691 C3.338,6.291 3.344,7.892 4.486,9.494 C3.522,10.111 2.918,11.126 1.977,11.77 Z" fill="#FDBA18"/>
|
||||||
|
<path d="M12.257,12.114 C10.49,10.481 9.772,8.456 10.139,6.094 C10.59,3.184 12.278,1.201 15.085,0.416 C17.65,-0.302 20.049,0.199 21.963,2.235 C21.079,2.978 20.256,3.782 19.529,4.681 C18.488,3.827 17.319,3.435 16,3.856 C13.596,4.623 12.954,7.097 14.506,9.5 C14.265,9.775 14.013,10.041 13.785,10.326 C13.295,10.939 12.511,11.3 12.257,12.114 Z" fill="#FCD93D"/>
|
||||||
|
<path d="M19.529,4.682 C20.256,3.783 21.079,2.979 21.963,2.236 C24.666,5.019 24.664,9.267 21.958,12 C19.31,14.674 15.022,14.725 12.257,12.115 C12.511,11.301 13.295,10.94 13.785,10.327 C14.013,10.042 14.265,9.775 14.506,9.501 C15.559,10.417 16.76,10.769 18.106,10.331 C20.502,9.551 21.151,6.927 19.529,4.682 Z" fill="#FDBA18"/>
|
||||||
|
<path d="M4.49,4.691 C3.522,4.075 2.919,3.057 1.977,2.413 C4.186,0.015 7.698,-0.529 10.453,1.058 C11.008,1.378 11.172,1.664 10.738,2.186 C10.581,2.374 10.48,2.608 10.347,2.817 C10.048,3.287 9.838,3.884 9.418,4.188 C8.933,4.539 8.523,3.847 8.021,3.746 C6.673,3.475 5.509,3.787 4.49,4.691 Z" fill="#FCD93D"/>
|
||||||
|
<path d="M1.977,11.77 C2.918,11.126 3.522,10.111 4.486,9.493 C5.859,10.645 7.336,10.926 8.936,9.992 C9.268,9.798 9.439,9.904 9.609,10.182 C9.995,10.817 10.362,11.467 10.79,12.072 C11.13,12.552 11.012,12.787 10.537,13.078 C7.84,14.73 4.205,14.188 1.977,11.77 Z" fill="#FCD93D"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
|
|
@ -0,0 +1,18 @@
|
||||||
|
name: root
|
||||||
|
channels:
|
||||||
|
- pytorch
|
||||||
|
- defaults
|
||||||
|
dependencies:
|
||||||
|
- cpuonly=1.0=0
|
||||||
|
- pip=20.2
|
||||||
|
- python=3.6
|
||||||
|
- pytorch=1.5.0=py3.6_cpu_0
|
||||||
|
- pip:
|
||||||
|
- gym>=0.17.2
|
||||||
|
- cloudpickle
|
||||||
|
- opencv-python-headless
|
||||||
|
- pandas
|
||||||
|
- numpy
|
||||||
|
- matplotlib
|
||||||
|
- sphinx_autodoc_typehints
|
||||||
|
- stable-baselines3>=0.9.0
|
||||||
|
|
@ -0,0 +1,219 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Configuration file for the Sphinx documentation builder.
|
||||||
|
#
|
||||||
|
# This file does only contain a selection of the most common options. For a
|
||||||
|
# full list see the documentation:
|
||||||
|
# http://www.sphinx-doc.org/en/master/config
|
||||||
|
|
||||||
|
# -- Path setup --------------------------------------------------------------
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
#
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
|
||||||
|
# We CANNOT enable 'sphinxcontrib.spelling' because ReadTheDocs.org does not support
|
||||||
|
# PyEnchant.
|
||||||
|
try:
|
||||||
|
import sphinxcontrib.spelling # noqa: F401
|
||||||
|
|
||||||
|
enable_spell_check = True
|
||||||
|
except ImportError:
|
||||||
|
enable_spell_check = False
|
||||||
|
|
||||||
|
# source code directory, relative to this file, for sphinx-autobuild
|
||||||
|
sys.path.insert(0, os.path.abspath(".."))
|
||||||
|
|
||||||
|
|
||||||
|
class Mock(MagicMock):
|
||||||
|
__subclasses__ = []
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def __getattr__(cls, name):
|
||||||
|
return MagicMock()
|
||||||
|
|
||||||
|
|
||||||
|
# Mock modules that requires C modules
|
||||||
|
# Note: because of that we cannot test examples using CI
|
||||||
|
# 'torch', 'torch.nn', 'torch.nn.functional',
|
||||||
|
# DO not mock modules for now, we will need to do that for read the docs later
|
||||||
|
MOCK_MODULES = []
|
||||||
|
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
|
||||||
|
|
||||||
|
# Read version from file
|
||||||
|
version_file = os.path.join(os.path.dirname(__file__), "../sb3_contrib", "version.txt")
|
||||||
|
with open(version_file, "r") as file_handler:
|
||||||
|
__version__ = file_handler.read().strip()
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
|
project = "Stable Baselines3 - Contrib"
|
||||||
|
copyright = "2020, Stable Baselines3"
|
||||||
|
author = "Stable Baselines3 Contributors"
|
||||||
|
|
||||||
|
# The short X.Y version
|
||||||
|
version = "master (" + __version__ + " )"
|
||||||
|
# The full version, including alpha/beta/rc tags
|
||||||
|
release = __version__
|
||||||
|
|
||||||
|
|
||||||
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
#
|
||||||
|
# needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
|
# ones.
|
||||||
|
extensions = [
|
||||||
|
"sphinx.ext.autodoc",
|
||||||
|
"sphinx_autodoc_typehints",
|
||||||
|
"sphinx.ext.autosummary",
|
||||||
|
"sphinx.ext.mathjax",
|
||||||
|
"sphinx.ext.ifconfig",
|
||||||
|
"sphinx.ext.viewcode",
|
||||||
|
# 'sphinx.ext.intersphinx',
|
||||||
|
# 'sphinx.ext.doctest'
|
||||||
|
]
|
||||||
|
|
||||||
|
if enable_spell_check:
|
||||||
|
extensions.append("sphinxcontrib.spelling")
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ["_templates"]
|
||||||
|
|
||||||
|
# The suffix(es) of source filenames.
|
||||||
|
# You can specify multiple suffix as a list of string:
|
||||||
|
#
|
||||||
|
# source_suffix = ['.rst', '.md']
|
||||||
|
source_suffix = ".rst"
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = "index"
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
#
|
||||||
|
# This is also used if you do content translation via gettext catalogs.
|
||||||
|
# Usually you set "language" from the command line for these cases.
|
||||||
|
language = None
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
# This pattern also affects html_static_path and html_extra_path .
|
||||||
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = "sphinx"
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
|
||||||
|
# Fix for read the docs
|
||||||
|
on_rtd = os.environ.get("READTHEDOCS") == "True"
|
||||||
|
if on_rtd:
|
||||||
|
html_theme = "default"
|
||||||
|
else:
|
||||||
|
html_theme = "sphinx_rtd_theme"
|
||||||
|
|
||||||
|
html_logo = "_static/img/logo.png"
|
||||||
|
|
||||||
|
|
||||||
|
def setup(app):
|
||||||
|
app.add_css_file("css/baselines_theme.css")
|
||||||
|
|
||||||
|
|
||||||
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
#
|
||||||
|
# html_theme_options = {}
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
html_static_path = ["_static"]
|
||||||
|
|
||||||
|
# Custom sidebar templates, must be a dictionary that maps document names
|
||||||
|
# to template names.
|
||||||
|
#
|
||||||
|
# The default sidebars (for documents that don't match any pattern) are
|
||||||
|
# defined by theme itself. Builtin themes are using these templates by
|
||||||
|
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
||||||
|
# 'searchbox.html']``.
|
||||||
|
#
|
||||||
|
# html_sidebars = {}
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTMLHelp output ---------------------------------------------
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = "StableBaselines3doc"
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for LaTeX output ------------------------------------------------
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
#
|
||||||
|
# 'papersize': 'letterpaper',
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
#
|
||||||
|
# 'pointsize': '10pt',
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
#
|
||||||
|
# 'preamble': '',
|
||||||
|
# Latex figure (float) alignment
|
||||||
|
#
|
||||||
|
# 'figure_align': 'htbp',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title,
|
||||||
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
latex_documents = [
|
||||||
|
(master_doc, "StableBaselines3.tex", "Stable Baselines3 Documentation", "Stable Baselines3 Contributors", "manual"),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for manual page output ------------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
man_pages = [(master_doc, "stablebaselines3", "Stable Baselines3 Documentation", [author], 1)]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Texinfo output ----------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree into Texinfo files. List of tuples
|
||||||
|
# (source start file, target name, title, author,
|
||||||
|
# dir menu entry, description, category)
|
||||||
|
texinfo_documents = [
|
||||||
|
(
|
||||||
|
master_doc,
|
||||||
|
"StableBaselines3",
|
||||||
|
"Stable Baselines3 Documentation",
|
||||||
|
author,
|
||||||
|
"StableBaselines3",
|
||||||
|
"One line description of project.",
|
||||||
|
"Miscellaneous",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Extension configuration -------------------------------------------------
|
||||||
|
|
||||||
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
|
# intersphinx_mapping = {
|
||||||
|
# 'python': ('https://docs.python.org/3/', None),
|
||||||
|
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
|
||||||
|
# 'torch': ('http://pytorch.org/docs/master/', None),
|
||||||
|
# }
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
RL Algorithms
|
||||||
|
=============
|
||||||
|
|
||||||
|
This table displays the rl algorithms that are implemented in the Stable Baselines3 contrib project,
|
||||||
|
along with some useful characteristics: support for discrete/continuous actions, multiprocessing.
|
||||||
|
|
||||||
|
..
|
||||||
|
.. ============ =========== ============ ================= =============== ================
|
||||||
|
.. Name ``Box`` ``Discrete`` ``MultiDiscrete`` ``MultiBinary`` Multi Processing
|
||||||
|
.. ============ =========== ============ ================= =============== ================
|
||||||
|
.. A2C ✔️ ✔️ ✔️ ✔️ ✔️
|
||||||
|
.. DDPG ✔️ ❌ ❌ ❌ ❌
|
||||||
|
.. DQN ❌ ✔️ ❌ ❌ ❌
|
||||||
|
.. PPO ✔️ ✔️ ✔️ ✔️ ✔️
|
||||||
|
.. SAC ✔️ ❌ ❌ ❌ ❌
|
||||||
|
.. TD3 ✔️ ❌ ❌ ❌ ❌
|
||||||
|
.. ============ =========== ============ ================= =============== ================
|
||||||
|
|
||||||
|
|
||||||
|
.. .. note::
|
||||||
|
.. Non-array spaces such as ``Dict`` or ``Tuple`` are not currently supported by any algorithm.
|
||||||
|
..
|
||||||
|
.. Actions ``gym.spaces``:
|
||||||
|
..
|
||||||
|
.. - ``Box``: A N-dimensional box that contains every point in the action
|
||||||
|
.. space.
|
||||||
|
.. - ``Discrete``: A list of possible actions, where each timestep only
|
||||||
|
.. one of the actions can be used.
|
||||||
|
.. - ``MultiDiscrete``: A list of possible actions, where each timestep only one action of each discrete set can be used.
|
||||||
|
.. - ``MultiBinary``: A list of possible actions, where each timestep any of the actions can be used in any combination.
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
.. _examples:
|
||||||
|
|
||||||
|
Examples
|
||||||
|
========
|
||||||
|
|
||||||
|
WIP
|
||||||
|
|
||||||
|
.. PyBullet: Normalizing input features
|
||||||
|
.. ------------------------------------
|
||||||
|
..
|
||||||
|
.. Normalizing input features may be essential to successful training of an RL agent
|
||||||
|
.. (by default, images are scaled but not other types of input),
|
||||||
|
.. for instance when training on `PyBullet <https://github.com/bulletphysics/bullet3/>`__ environments. For that, a wrapper exists and
|
||||||
|
.. will compute a running average and standard deviation of input features (it can do the same for rewards).
|
||||||
|
..
|
||||||
|
|
||||||
|
.. .. note::
|
||||||
|
..
|
||||||
|
.. you need to install pybullet with ``pip install pybullet``
|
||||||
|
..
|
||||||
|
..
|
||||||
|
.. .. image:: ../_static/img/colab-badge.svg
|
||||||
|
.. :target: https://colab.research.google.com/github/Stable-Baselines-Team/rl-colab-notebooks/blob/sb3/pybullet.ipynb
|
||||||
|
..
|
||||||
|
..
|
||||||
|
.. .. code-block:: python
|
||||||
|
..
|
||||||
|
.. import gym
|
||||||
|
.. import pybullet_envs
|
||||||
|
..
|
||||||
|
.. from stable_baselines3.common.vec_env import DummyVecEnv, VecNormalize
|
||||||
|
.. from stable_baselines3 import PPO
|
||||||
|
..
|
||||||
|
.. env = DummyVecEnv([lambda: gym.make("HalfCheetahBulletEnv-v0")])
|
||||||
|
.. # Automatically normalize the input features and reward
|
||||||
|
.. env = VecNormalize(env, norm_obs=True, norm_reward=True,
|
||||||
|
.. clip_obs=10.)
|
||||||
|
..
|
||||||
|
.. model = PPO('MlpPolicy', env)
|
||||||
|
.. model.learn(total_timesteps=2000)
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
.. _install:
|
||||||
|
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Please read `Stable-Baselines3 installation guide <https://stable-baselines3.readthedocs.io/en/master/guide/install.html>`_ first.
|
||||||
|
|
||||||
|
|
||||||
|
Stable Release
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
To install Stable Baselines3 contrib with pip, execute:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
pip install sb3-contrib
|
||||||
|
|
||||||
|
|
||||||
|
Bleeding-edge version
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
pip install git+https://github.com/Stable-Baselines-Team/stable-baselines3-contrib/
|
||||||
|
|
||||||
|
|
||||||
|
Development version
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
To contribute to Stable-Baselines3, with support for running tests and building the documentation.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
git clone https://github.com/Stable-Baselines-Team/stable-baselines3-contrib/ && cd stable-baselines3-contrib
|
||||||
|
pip install -e .
|
||||||
|
|
@ -0,0 +1,78 @@
|
||||||
|
.. Stable Baselines3 documentation master file, created by
|
||||||
|
sphinx-quickstart on Thu Sep 26 11:06:54 2019.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to Stable Baselines3 Contrib docs!
|
||||||
|
==========================================
|
||||||
|
|
||||||
|
Contrib package for `Stable Baselines3 <https://github.com/DLR-RM/stable-baselines3>`_ - Experimental code.
|
||||||
|
|
||||||
|
|
||||||
|
Github repository: https://github.com/Stable-Baselines-Team/stable-baselines3-contrib
|
||||||
|
|
||||||
|
SB3 repository: https://github.com/DLR-RM/stable-baselines3
|
||||||
|
|
||||||
|
RL Baselines3 Zoo (collection of pre-trained agents): https://github.com/DLR-RM/rl-baselines3-zoo
|
||||||
|
|
||||||
|
RL Baselines3 Zoo also offers a simple interface to train, evaluate agents and do hyperparameter tuning.
|
||||||
|
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: User Guide
|
||||||
|
|
||||||
|
guide/install
|
||||||
|
guide/algos
|
||||||
|
guide/examples
|
||||||
|
|
||||||
|
|
||||||
|
.. .. toctree::
|
||||||
|
.. :maxdepth: 1
|
||||||
|
.. :caption: RL Algorithms
|
||||||
|
..
|
||||||
|
.. modules/a2c
|
||||||
|
|
||||||
|
.. .. toctree::
|
||||||
|
.. :maxdepth: 1
|
||||||
|
.. :caption: Common
|
||||||
|
..
|
||||||
|
.. common/atari_wrappers
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:caption: Misc
|
||||||
|
|
||||||
|
misc/changelog
|
||||||
|
|
||||||
|
|
||||||
|
Citing Stable Baselines3
|
||||||
|
------------------------
|
||||||
|
To cite this project in publications:
|
||||||
|
|
||||||
|
.. code-block:: bibtex
|
||||||
|
|
||||||
|
@misc{stable-baselines3,
|
||||||
|
author = {Raffin, Antonin and Hill, Ashley and Ernestus, Maximilian and Gleave, Adam and Kanervisto, Anssi and Dormann, Noah},
|
||||||
|
title = {Stable Baselines3},
|
||||||
|
year = {2019},
|
||||||
|
publisher = {GitHub},
|
||||||
|
journal = {GitHub repository},
|
||||||
|
howpublished = {\url{https://github.com/DLR-RM/stable-baselines3}},
|
||||||
|
}
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
|
To any interested in making the rl baselines better, there are still some improvements
|
||||||
|
that need to be done.
|
||||||
|
You can check issues in the `repo <https://github.com/DLR-RM/stable-baselines3/issues>`_.
|
||||||
|
|
||||||
|
If you want to contribute, please read `CONTRIBUTING.md <https://github.com/DLR-RM/stable-baselines3/blob/master/CONTRIBUTING.md>`_ first.
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`search`
|
||||||
|
* :ref:`modindex`
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set SOURCEDIR=.
|
||||||
|
set BUILDDIR=_build
|
||||||
|
set SPHINXPROJ=StableBaselines
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% >NUL 2>NUL
|
||||||
|
if errorlevel 9009 (
|
||||||
|
echo.
|
||||||
|
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||||
|
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||||
|
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||||
|
echo.may add the Sphinx directory to PATH.
|
||||||
|
echo.
|
||||||
|
echo.If you don't have Sphinx installed, grab it from
|
||||||
|
echo.http://sphinx-doc.org/
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
.. _changelog:
|
||||||
|
|
||||||
|
Changelog
|
||||||
|
==========
|
||||||
|
|
||||||
|
|
||||||
|
Pre-Release 0.10.0a0 (WIP)
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
Breaking Changes:
|
||||||
|
^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
New Features:
|
||||||
|
^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Bug Fixes:
|
||||||
|
^^^^^^^^^^
|
||||||
|
|
||||||
|
Deprecations:
|
||||||
|
^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Others:
|
||||||
|
^^^^^^^
|
||||||
|
|
||||||
|
Documentation:
|
||||||
|
^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
|
||||||
|
Maintainers
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Stable-Baselines3 is currently maintained by `Antonin Raffin`_ (aka `@araffin`_), `Ashley Hill`_ (aka @hill-a),
|
||||||
|
`Maximilian Ernestus`_ (aka @erniejunior), `Adam Gleave`_ (`@AdamGleave`_) and `Anssi Kanervisto`_ (aka `@Miffyli`_).
|
||||||
|
|
||||||
|
.. _Ashley Hill: https://github.com/hill-a
|
||||||
|
.. _Antonin Raffin: https://araffin.github.io/
|
||||||
|
.. _Maximilian Ernestus: https://github.com/erniejunior
|
||||||
|
.. _Adam Gleave: https://gleave.me/
|
||||||
|
.. _@araffin: https://github.com/araffin
|
||||||
|
.. _@AdamGleave: https://github.com/adamgleave
|
||||||
|
.. _Anssi Kanervisto: https://github.com/Miffyli
|
||||||
|
.. _@Miffyli: https://github.com/Miffyli
|
||||||
|
|
@ -0,0 +1,121 @@
|
||||||
|
py
|
||||||
|
env
|
||||||
|
atari
|
||||||
|
argparse
|
||||||
|
Argparse
|
||||||
|
TensorFlow
|
||||||
|
feedforward
|
||||||
|
envs
|
||||||
|
VecEnv
|
||||||
|
pretrain
|
||||||
|
petrained
|
||||||
|
tf
|
||||||
|
th
|
||||||
|
nn
|
||||||
|
np
|
||||||
|
str
|
||||||
|
mujoco
|
||||||
|
cpu
|
||||||
|
ndarray
|
||||||
|
ndarrays
|
||||||
|
timestep
|
||||||
|
timesteps
|
||||||
|
stepsize
|
||||||
|
dataset
|
||||||
|
adam
|
||||||
|
fn
|
||||||
|
normalisation
|
||||||
|
Kullback
|
||||||
|
Leibler
|
||||||
|
boolean
|
||||||
|
deserialized
|
||||||
|
pretrained
|
||||||
|
minibatch
|
||||||
|
subprocesses
|
||||||
|
ArgumentParser
|
||||||
|
Tensorflow
|
||||||
|
Gaussian
|
||||||
|
approximator
|
||||||
|
minibatches
|
||||||
|
hyperparameters
|
||||||
|
hyperparameter
|
||||||
|
vectorized
|
||||||
|
rl
|
||||||
|
colab
|
||||||
|
dataloader
|
||||||
|
npz
|
||||||
|
datasets
|
||||||
|
vf
|
||||||
|
logits
|
||||||
|
num
|
||||||
|
Utils
|
||||||
|
backpropagate
|
||||||
|
prepend
|
||||||
|
NaN
|
||||||
|
preprocessing
|
||||||
|
Cloudpickle
|
||||||
|
async
|
||||||
|
multiprocess
|
||||||
|
tensorflow
|
||||||
|
mlp
|
||||||
|
cnn
|
||||||
|
neglogp
|
||||||
|
tanh
|
||||||
|
coef
|
||||||
|
repo
|
||||||
|
Huber
|
||||||
|
params
|
||||||
|
ppo
|
||||||
|
arxiv
|
||||||
|
Arxiv
|
||||||
|
func
|
||||||
|
DQN
|
||||||
|
Uhlenbeck
|
||||||
|
Ornstein
|
||||||
|
multithread
|
||||||
|
cancelled
|
||||||
|
Tensorboard
|
||||||
|
parallelize
|
||||||
|
customising
|
||||||
|
serializable
|
||||||
|
Multiprocessed
|
||||||
|
cartpole
|
||||||
|
toolset
|
||||||
|
lstm
|
||||||
|
rescale
|
||||||
|
ffmpeg
|
||||||
|
avconv
|
||||||
|
unnormalized
|
||||||
|
Github
|
||||||
|
pre
|
||||||
|
preprocess
|
||||||
|
backend
|
||||||
|
attr
|
||||||
|
preprocess
|
||||||
|
Antonin
|
||||||
|
Raffin
|
||||||
|
araffin
|
||||||
|
Homebrew
|
||||||
|
Numpy
|
||||||
|
Theano
|
||||||
|
rollout
|
||||||
|
kfac
|
||||||
|
Piecewise
|
||||||
|
csv
|
||||||
|
nvidia
|
||||||
|
visdom
|
||||||
|
tensorboard
|
||||||
|
preprocessed
|
||||||
|
namespace
|
||||||
|
sklearn
|
||||||
|
GoalEnv
|
||||||
|
Torchy
|
||||||
|
pytorch
|
||||||
|
dicts
|
||||||
|
optimizers
|
||||||
|
Deprecations
|
||||||
|
forkserver
|
||||||
|
cuda
|
||||||
|
Polyak
|
||||||
|
gSDE
|
||||||
|
rollouts
|
||||||
|
|
@ -1 +1 @@
|
||||||
0.9.0a2
|
0.10.0a0
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue