From 8046a247197c6529ac1331a04b4a63fc0c901a99 Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Thu, 7 May 2020 16:08:23 +0200 Subject: [PATCH] More doc + sync VecEnvs + atari --- README.md | 12 +- docs/_static/img/breakout.gif | Bin 0 -> 199418 bytes docs/_static/img/colab.svg | 7 + docs/_static/img/try_it.png | Bin 0 -> 12156 bytes docs/guide/algos.rst | 48 +++ docs/guide/custom_policy.rst | 105 +++++ docs/guide/examples.rst | 396 ++++++++++++++++++ docs/guide/install.rst | 3 +- docs/index.rst | 3 + docs/misc/changelog.rst | 6 +- setup.py | 2 + stable_baselines3/__init__.py | 2 +- stable_baselines3/common/__init__.py | 2 + stable_baselines3/common/atari_wrappers.py | 76 ++++ stable_baselines3/common/cmd_util.py | 112 +++++ .../common/vec_env/base_vec_env.py | 74 +++- .../common/vec_env/dummy_vec_env.py | 24 +- .../common/vec_env/subproc_vec_env.py | 49 +-- stable_baselines3/version.txt | 2 +- tests/test_utils.py | 101 +++++ 20 files changed, 955 insertions(+), 69 deletions(-) create mode 100644 docs/_static/img/breakout.gif create mode 100644 docs/_static/img/colab.svg create mode 100644 docs/_static/img/try_it.png create mode 100644 docs/guide/algos.rst create mode 100644 docs/guide/custom_policy.rst create mode 100644 docs/guide/examples.rst create mode 100644 stable_baselines3/common/atari_wrappers.py create mode 100644 stable_baselines3/common/cmd_util.py create mode 100644 tests/test_utils.py diff --git a/README.md b/README.md index d8ee719..da0419a 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ Install the Stable Baselines3 package: pip install stable-baselines3[extra] ``` -This includes an optional dependency OpenCV to display the environments when using `SubprocVecEnv`. If you do not need it, you can install without OpenCV: +This includes an optional dependencies like OpenCV or `atari-py` to train on atari games. If you do not need those, you can use: ``` pip install stable-baselines3 ``` @@ -144,14 +144,14 @@ model = PPO('MlpPolicy', 'CartPole-v1').learn(10000) Please read the [documentation](https://stable-baselines.readthedocs.io/) for more examples. - +- [All Notebooks](https://github.com/Stable-Baselines-Team/rl-colab-notebooks/tree/sb3) +- [Getting Started](https://colab.research.google.com/github/Stable-Baselines-Team/rl-colab-notebooks/blob/sb3/stable_baselines_getting_started.ipynb) +