74 lines
3.1 KiB
YAML
74 lines
3.1 KiB
YAML
name: "\U0001F41B Bug Report"
|
|
description: If you encounter an unexpected behavior, software crash, or other bug.
|
|
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 ...
|
|
from sb3_contrib import ...
|
|
|
|
```
|
|
|
|
- type: textarea
|
|
id: traceback
|
|
attributes:
|
|
label: Relevant log output / Error message
|
|
description: Please copy and paste any relevant log output / error message. This will be automatically formatted into code, so no need for backticks.
|
|
placeholder: "Traceback (most recent call last): File ..."
|
|
render: shell
|
|
|
|
- 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, ...)
|
|
* Stable-Baselines3 and sb3-contrib versions
|
|
* GPU models and configuration
|
|
* Python version
|
|
* PyTorch version
|
|
* Gymnasium version
|
|
* (if installed) OpenAI Gym version
|
|
* Versions of any other relevant libraries
|
|
|
|
You can use `sb3.get_system_info()` to print relevant packages info:
|
|
```sh
|
|
python -c '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/Stable-Baselines-Team/stable-baselines3-contrib/issues) in the repo
|
|
required: true
|
|
- label: I have read the [documentation](https://sb3-contrib.readthedocs.io/en/master/)
|
|
required: true
|
|
- label: I have provided a [minimal and working](https://github.com/DLR-RM/stable-baselines3/issues/982#issuecomment-1197044014) 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
|