mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-11-17 08:56:08 +00:00
Improve issue templates to provide more guidance (#1563)
* update issue templates * close bf * Cap Sphinx version * Relax sphinx version for python 3.7 * Fix Numpy deprecations --------- Co-authored-by: Antonin Raffin <antonin.raffin@ensta.org>
This commit is contained in:
parent
ffe26ccf95
commit
4eed3e9769
8 changed files with 14 additions and 10 deletions
4
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
4
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,5 +1,5 @@
|
||||||
name: "\U0001F41B Bug Report"
|
name: "\U0001F41B Bug Report"
|
||||||
description: Submit a bug report to help us improve Stable-Baselines3
|
description: If you encounter an unexpected behavior, software crash, or other bug.
|
||||||
title: "[Bug]: bug title"
|
title: "[Bug]: bug title"
|
||||||
labels: ["bug"]
|
labels: ["bug"]
|
||||||
body:
|
body:
|
||||||
|
|
@ -61,6 +61,8 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Checklist
|
label: Checklist
|
||||||
options:
|
options:
|
||||||
|
- label: My issue does not relate to a custom gym environment. (Use the custom gym env template instead)
|
||||||
|
required: true
|
||||||
- label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo
|
- label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo
|
||||||
required: true
|
required: true
|
||||||
- label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/)
|
- label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/)
|
||||||
|
|
|
||||||
4
.github/ISSUE_TEMPLATE/custom_env.yml
vendored
4
.github/ISSUE_TEMPLATE/custom_env.yml
vendored
|
|
@ -1,6 +1,6 @@
|
||||||
name: "\U0001F916 Custom Gym Environment Issue"
|
name: "\U0001F916 Custom Gym Environment Issue"
|
||||||
description: How to report an issue when using a custom Gym environment
|
description: If your problem involves a custom gym environment.
|
||||||
labels: ["question", "custom gym env"]
|
labels: ["custom gym env"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
|
|
|
||||||
2
.github/ISSUE_TEMPLATE/documentation.yml
vendored
2
.github/ISSUE_TEMPLATE/documentation.yml
vendored
|
|
@ -1,5 +1,5 @@
|
||||||
name: "\U0001F4DA Documentation"
|
name: "\U0001F4DA Documentation"
|
||||||
description: Report an issue related to Stable-Baselines3 documentation
|
description: If you want to improve the documentation by reporting errors, inconsistencies, or missing information.
|
||||||
labels: ["documentation"]
|
labels: ["documentation"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
|
|
|
||||||
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -1,5 +1,5 @@
|
||||||
name: "\U0001F680 Feature Request"
|
name: "\U0001F680 Feature Request"
|
||||||
description: How to create an issue for requesting a feature
|
description: If you have an idea for a new feature or an improvement.
|
||||||
title: "[Feature Request] request title"
|
title: "[Feature Request] request title"
|
||||||
labels: ["enhancement"]
|
labels: ["enhancement"]
|
||||||
body:
|
body:
|
||||||
|
|
|
||||||
6
.github/ISSUE_TEMPLATE/question.yml
vendored
6
.github/ISSUE_TEMPLATE/question.yml
vendored
|
|
@ -1,5 +1,5 @@
|
||||||
name: "❓ Question"
|
name: "❓ Question"
|
||||||
description: How to ask a question regarding Stable-Baselines3
|
description: If you have a general question about Stable-Baselines3.
|
||||||
title: "[Question] question title"
|
title: "[Question] question title"
|
||||||
labels: ["question"]
|
labels: ["question"]
|
||||||
body:
|
body:
|
||||||
|
|
@ -12,7 +12,9 @@ body:
|
||||||
id: question
|
id: question
|
||||||
attributes:
|
attributes:
|
||||||
label: ❓ Question
|
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.
|
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.
|
||||||
|
**Important Note: If your question is anything like "Why is my code generating this error?", you must [submit a bug report](https://github.com/DLR-RM/stable-baselines3/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D%3A+bug+title) instead.**
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
|
|
|
||||||
2
setup.py
2
setup.py
|
|
@ -131,7 +131,7 @@ setup(
|
||||||
"black",
|
"black",
|
||||||
],
|
],
|
||||||
"docs": [
|
"docs": [
|
||||||
"sphinx",
|
"sphinx>=5.3,<7.0",
|
||||||
"sphinx-autobuild",
|
"sphinx-autobuild",
|
||||||
"sphinx-rtd-theme",
|
"sphinx-rtd-theme",
|
||||||
# For spelling
|
# For spelling
|
||||||
|
|
|
||||||
|
|
@ -179,7 +179,7 @@ class BitFlippingEnv(Env):
|
||||||
else:
|
else:
|
||||||
self.state[action] = 1 - self.state[action]
|
self.state[action] = 1 - self.state[action]
|
||||||
obs = self._get_obs()
|
obs = self._get_obs()
|
||||||
reward = float(self.compute_reward(obs["achieved_goal"], obs["desired_goal"], None))
|
reward = float(self.compute_reward(obs["achieved_goal"], obs["desired_goal"], None).item())
|
||||||
terminated = reward == 0
|
terminated = reward == 0
|
||||||
self.current_step += 1
|
self.current_step += 1
|
||||||
# Episode terminate when we reached the goal or the max number of steps
|
# Episode terminate when we reached the goal or the max number of steps
|
||||||
|
|
|
||||||
|
|
@ -297,7 +297,7 @@ class JSONOutputFormat(KVWriter):
|
||||||
if hasattr(value, "dtype"):
|
if hasattr(value, "dtype"):
|
||||||
if value.shape == () or len(value) == 1:
|
if value.shape == () or len(value) == 1:
|
||||||
# if value is a dimensionless numpy array or of length 1, serialize as a float
|
# if value is a dimensionless numpy array or of length 1, serialize as a float
|
||||||
return float(value)
|
return float(value.item())
|
||||||
else:
|
else:
|
||||||
# otherwise, a value is a numpy array, serialize as a list or nested lists
|
# otherwise, a value is a numpy array, serialize as a list or nested lists
|
||||||
return value.tolist()
|
return value.tolist()
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue