diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 7cbc198..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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 the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case. - - -If your issue is related to a **custom gym environment**, please use the custom gym env template. - -### 🐛 Bug - -A clear and concise description of what the bug is. - - -### 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) -for both code and stack traces. - -```python -from stable_baselines3 import ... - -``` - -```bash -Traceback (most recent call last): File ... - -``` - -### 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 - * Python version - * PyTorch version - * Gym version - * Versions of any other relevant libraries - -You can use `sb3.get_system_info()` to print relevant packages info: -```python -import stable_baselines3 as sb3 -sb3.get_system_info() -``` - -### 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/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..d6f0a07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,67 @@ +name: "\U0001F41B Bug Report" +description: Submit a bug report to help us improve Stable-Baselines3 +title: "[Bug]: bug title" +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. + Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case. + + If your issue is related to a **custom gym environment**, please use the custom gym env template. + - type: textarea + id: description + attributes: + label: 🐛 Bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To Reproduce + description: | + 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) for both code and stack traces. + value: | + ```python + from stable_baselines3 import ... + + ``` + + ```bash + Traceback (most recent call last): File ... + + ``` + - type: textarea + id: system-info + attributes: + label: System Info + description: | + 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 + + You can use `sb3.get_system_info()` to print relevant packages info: + ```python + import stable_baselines3 as sb3 + sb3.get_system_info() + ``` + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo + required: true + - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) + required: true + - label: I have provided a minimal working example to reproduce the bug + required: true + - label: I've used the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces. + required: true diff --git a/.github/ISSUE_TEMPLATE/custom_env.md b/.github/ISSUE_TEMPLATE/custom_env.md deleted file mode 100644 index 0a12a68..0000000 --- a/.github/ISSUE_TEMPLATE/custom_env.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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 the [RL Discord](https://discord.com/invite/xhfNqQv), [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 - -You can use `sb3.get_system_info()` to print relevant packages info: -```python -import stable_baselines3 as sb3 -sb3.get_system_info() -``` - -### 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/custom_env.yml b/.github/ISSUE_TEMPLATE/custom_env.yml new file mode 100644 index 0000000..d36e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom_env.yml @@ -0,0 +1,103 @@ +name: "\U0001F916 Custom Gym Environment Issue" +description: How to report an issue when using a custom Gym environment +labels: ["question", "custom gym env"] +body: + - type: markdown + attributes: + value: | + **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. + Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case. + + **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) + ``` + - type: textarea + id: description + attributes: + label: 🐛 Bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: code-example + attributes: + label: Code example + description: | + 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. + value: | + ```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 ... + + ``` + - type: textarea + id: system-info + attributes: + label: System Info + description: | + 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 + + You can use `sb3.get_system_info()` to print relevant packages info: + ```python + import stable_baselines3 as sb3 + sb3.get_system_info() + ``` + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo + required: true + - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) + required: true + - label: I have provided a minimal working example to reproduce the bug + required: true + - label: I have checked my env using the env checker + required: true + - label: I've used the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces. + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 59e5da5..0000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -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 the [RL Discord](https://discord.com/invite/xhfNqQv), [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/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..025e2d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,25 @@ +name: "\U0001F4DA Documentation" +description: Report an issue related to Stable-Baselines3 documentation +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. + Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case. + - type: textarea + id: description + attributes: + label: 📚 Documentation + description: A clear and concise description of what should be improved in the documentation. + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo + required: true + - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a650863..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 the [RL Discord](https://discord.com/invite/xhfNqQv), [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/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1d598a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +name: "\U0001F680 Feature Request" +description: How to create an issue for requesting a feature +title: "[Feature Request] request title" +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. + Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case. + - type: textarea + id: description + attributes: + label: 🚀 Feature + description: A clear and concise description of the feature proposal. + validations: + required: true + - type: textarea + id: motivation + attributes: + label: Motivation + description: 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. + - type: textarea + id: pitch + attributes: + label: Pitch + description: A clear and concise description of what you want to happen. + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: A clear and concise description of any alternative solutions or features you've considered, if any. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo + required: true diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index b3288d8..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -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 the [RL Discord](https://discord.com/invite/xhfNqQv), [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/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..b2fb2f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,30 @@ +name: "❓ Question" +description: How to ask a question regarding Stable-Baselines3 +title: "[Question] question title" +labels: ["question"] +body: + - type: markdown + attributes: + value: | + **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email. + Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case. + - type: textarea + id: question + attributes: + label: ❓ Question + description: 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. + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo + required: true + - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/) + required: true + - label: If code there is, it is minimal and working + required: true + - label: If code there is, it is formatted using the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces. + required: true diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 0d0bf33..1d92231 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -28,6 +28,7 @@ Deprecations: Others: ^^^^^^^ +- Used issue forms instead of issue templates Documentation: ^^^^^^^^^^^^^^