From 4a022dacd87ef3a0f7f7c20a6487e0931fcaeb3b Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Mon, 2 Nov 2020 10:43:25 +0100 Subject: [PATCH] Add more issue templates (#211) * Update algo table * Add more templates * Add doc build in the checklist * Address comments --- .../{issue-template.md => bug_report.md} | 43 +++++---- .github/ISSUE_TEMPLATE/custom_env.md | 89 +++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 21 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 39 ++++++++ .github/ISSUE_TEMPLATE/question.md | 26 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 2 + README.md | 1 + docs/guide/algos.rst | 1 + docs/misc/changelog.rst | 24 +++++ stable_baselines3/version.txt | 2 +- 10 files changed, 229 insertions(+), 19 deletions(-) rename .github/ISSUE_TEMPLATE/{issue-template.md => bug_report.md} (56%) create mode 100644 .github/ISSUE_TEMPLATE/custom_env.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 56% rename from .github/ISSUE_TEMPLATE/issue-template.md rename to .github/ISSUE_TEMPLATE/bug_report.md index 1268278..e302748 100644 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,30 +1,25 @@ --- -name: Issue Template -about: How to create an issue for this repository - +name: "\U0001F41B Bug Report" +about: Submit a bug report to help us improve Stable-Baselines3 +labels: bug +title: [Bug] bug title --- **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. Please post your question on [reddit](https://www.reddit.com/r/reinforcementlearning/) or [stack overflow](https://stackoverflow.com/) in that case. -If you have any questions, feel free to create an issue with the tag [question]. -If you wish to suggest an enhancement or feature request, add the tag [feature request]. -If you are submitting a bug report, please fill in the following details. -If your issue is related to a custom gym environment, please check it first using: +If your issue is related to a **custom gym environment**, please use the custom gym env template. -```python -from stable_baselines3.common.env_checker import check_env +### 🐛 Bug -env = CustomEnv(arg1, ...) -# It will check your custom environment and output additional warnings if needed -check_env(env) -``` - -**Describe the bug** A clear and concise description of what the bug is. -**Code example** + +### To Reproduce + +Steps to reproduce the behavior. + Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful. Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) @@ -40,7 +35,13 @@ Traceback (most recent call last): File ... ``` -**System Info** +### Expected behavior + +A clear and concise description of what you expected to happen. + + +### System Info + Describe the characteristic of your environment: * Describe how the library was installed (pip, docker, source, ...) * GPU models and configuration @@ -49,5 +50,11 @@ Describe the characteristic of your environment: * Gym version * Versions of any other relevant libraries -**Additional context** +### Additional context Add any other context about the problem here. + +### Checklist + +- [ ] I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo (**required**) +- [ ] I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) (**required**) +- [ ] I have provided a minimal working example to reproduce the bug (**required**) diff --git a/.github/ISSUE_TEMPLATE/custom_env.md b/.github/ISSUE_TEMPLATE/custom_env.md new file mode 100644 index 0000000..0c9802e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom_env.md @@ -0,0 +1,89 @@ +--- +name: "\U0001F916 Custom Gym Environment Issue" +about: How to report an issue when using a custom Gym environment +labels: question, custom gym env +--- + +**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. +Please post your question on [reddit](https://www.reddit.com/r/reinforcementlearning/) or [stack overflow](https://stackoverflow.com/) in that case. + +### 🤖 Custom Gym Environment + +**Please check your environment first using**: + +```python +from stable_baselines3.common.env_checker import check_env + +env = CustomEnv(arg1, ...) +# It will check your custom environment and output additional warnings if needed +check_env(env) +``` + +### Describe the bug + +A clear and concise description of what the bug is. + +### Code example + +Please try to provide a minimal example to reproduce the bug. +For a custom environment, you need to give at least the observation space, action space, `reset()` and `step()` methods +(see working example below). +Error messages and stack traces are also helpful. + +Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) +for both code and stack traces. + +```python +import gym +import numpy as np + +from stable_baselines3 import A2C +from stable_baselines3.common.env_checker import check_env + + +class CustomEnv(gym.Env): + + def __init__(self): + super(CustomEnv, self).__init__() + self.observation_space = gym.spaces.Box(low=-np.inf, high=np.inf, shape=(14,)) + self.action_space = gym.spaces.Box(low=-1, high=1, shape=(6,)) + + def reset(self): + return self.observation_space.sample() + + def step(self, action): + obs = self.observation_space.sample() + reward = 1.0 + done = False + info = {} + return obs, reward, done, info + +env = CustomEnv() +check_env(env) + +model = A2C("MlpPolicy", env, verbose=1).learn(1000) +``` + +```bash +Traceback (most recent call last): File ... + +``` + +### System Info +Describe the characteristic of your environment: + * Describe how the library was installed (pip, docker, source, ...) + * GPU models and configuration + * Python version + * PyTorch version + * Gym version + * Versions of any other relevant libraries + +### Additional context +Add any other context about the problem here. + +### Checklist + +- [ ] I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) (**required**) +- [ ] I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo (**required**) +- [ ] I have checked my env using the env checker (**required**) +- [ ] I have provided a minimal working example to reproduce the bug (**required**) diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..f87070d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,21 @@ +--- +name: "\U0001F4DA Documentation" +about: Report an issue related to Stable-Baselines3 documentation +labels: documentation +--- + +**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. +Please post your question on [reddit](https://www.reddit.com/r/reinforcementlearning/) or [stack overflow](https://stackoverflow.com/) in that case. + +### 📚 Documentation + +A clear and concise description of what should be improved in the documentation. + +### Checklist + +- [ ] I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) (**required**) +- [ ] I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo (**required**) + + + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d55c997 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,39 @@ +--- +name: "\U0001F680Feature Request" +about: How to create an issue for requesting a feature +labels: enhancement +title: [Feature Request] request title +--- + +**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. +Please post your question on [reddit](https://www.reddit.com/r/reinforcementlearning/) or [stack overflow](https://stackoverflow.com/) in that case. + + +### 🚀 Feature + +A clear and concise description of the feature proposal. + +### Motivation + +Please outline the motivation for the proposal. +Is your feature request related to a problem? e.g.,"I'm always frustrated when [...]". +If this is related to another GitHub issue, please link here too. + +### Pitch + +A clear and concise description of what you want to happen. + +### Alternatives + +A clear and concise description of any alternative solutions or features you've considered, if any. + +### Additional context + +Add any other context or screenshots about the feature request here. + +### Checklist + +- [ ] I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo (**required**) + + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..aeb8614 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,26 @@ +--- +name: ❓Question +about: How to ask a question regarding Stable-Baselines3 +labels: question +title: [Question] question title +--- + +**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. +Please post your question on [reddit](https://www.reddit.com/r/reinforcementlearning/) or [stack overflow](https://stackoverflow.com/) in that case. + + +### Question + +Your question. This can be e.g. questions regarding confusing or unclear behaviour of functions or a question if X can be done using stable-baselines3. Make sure to check out the documentation first. + +### Additional context + +Add any other context about the question here. + + +### Checklist + +- [ ] I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) (**required**) +- [ ] I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo (**required**) + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2b35d61..03300e1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -27,7 +27,9 @@ - [ ] I have reformatted the code using `make format` (**required**) - [ ] I have checked the codestyle using `make check-codestyle` and `make lint` (**required**) - [ ] I have ensured `make pytest` and `make type` both pass. (**required**) +- [ ] I have checked that the documentation builds using `make doc` (**required**) +Note: You can run most of the checks using `make commit-checks`. Note: we are using a maximum length of 127 characters per line diff --git a/README.md b/README.md index 7f92841..4e75bd6 100644 --- a/README.md +++ b/README.md @@ -153,6 +153,7 @@ All the following examples can be executed online using Google colab notebooks: | A2C | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | DDPG | :x: | :heavy_check_mark: | :x: | :x: | :x: | :x: | | DQN | :x: | :x: | :heavy_check_mark: | :x: | :x: | :x: | +| HER | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :x: | | PPO | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | SAC | :x: | :heavy_check_mark: | :x: | :x: | :x: | :x: | | TD3 | :x: | :heavy_check_mark: | :x: | :x: | :x: | :x: | diff --git a/docs/guide/algos.rst b/docs/guide/algos.rst index 1cc3e9d..2ca362d 100644 --- a/docs/guide/algos.rst +++ b/docs/guide/algos.rst @@ -11,6 +11,7 @@ Name ``Box`` ``Discrete`` ``MultiDiscrete`` ``MultiBinary`` Multi Pr A2C ✔️ ✔️ ✔️ ✔️ ✔️ DDPG ✔️ ❌ ❌ ❌ ❌ DQN ❌ ✔️ ❌ ❌ ❌ +HER ✔️ ✔️ ❌ ❌ ❌ PPO ✔️ ✔️ ✔️ ✔️ ✔️ SAC ✔️ ❌ ❌ ❌ ❌ TD3 ✔️ ❌ ❌ ❌ ❌ diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 8c0c7e5..60d92bc 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -3,6 +3,30 @@ Changelog ========== +Pre-Release 0.11.0a0 (WIP) +------------------------------- + + +Breaking Changes: +^^^^^^^^^^^^^^^^^ + +New Features: +^^^^^^^^^^^^^ + +Bug Fixes: +^^^^^^^^^^ + +Deprecations: +^^^^^^^^^^^^^ + +Others: +^^^^^^^ +- Add more issue templates + +Documentation: +^^^^^^^^^^^^^^ +- Updated algorithm table + Pre-Release 0.10.0 (2020-10-28) ------------------------------- diff --git a/stable_baselines3/version.txt b/stable_baselines3/version.txt index 78bc1ab..d22e31d 100644 --- a/stable_baselines3/version.txt +++ b/stable_baselines3/version.txt @@ -1 +1 @@ -0.10.0 +0.11.0a0