Skip to content

Commit

Permalink
[Doc] minor updates for clarity in reporting bugs and PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
fedebotu committed Mar 3, 2024
1 parent a3e67a1 commit 416bf38
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@ Traceback (most recent call last):
Report the characteristics of your environment such as how the library was installed (pip or source), Python version, and version of other relevant libraries.

> [!TIP]
> You can use the script below to report relevant versions
> You can use the script below to report relevant versions. Just make sure you are using the same Python environment where the bug occurred!
```python
import rl4co, torch, lightning, torchrl, tensordict, numpy, sys
print("RL4CO:", rl4co.__version__, "\nPyTorch:", torch.__version__, "\nPyTorch Lightning", lightning.__version__, \
"\nTorchRL:", torchrl.__version__, "\nTensorDict:", tensordict.__version__, \
"\nNumpy:", numpy.__version__, "\nPython:", sys.version, "\nPlatform:", sys.platform)
```bash
python -c "import rl4co, torch, lightning, torchrl, tensordict, numpy, sys; print('RL4CO:', \
rl4co.__version__, '\nPyTorch:', torch.__version__, '\nPyTorch Lightning:', \
lightning.__version__, '\nTorchRL:', torchrl.__version__, '\nTensorDict:',\
tensordict.__version__, '\nNumpy:', numpy.__version__, '\nPython:', \
sys.version, '\nPlatform:', sys.platform)"
```

## Additional context
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax `close #15213` if this solves the issue #15213

- [ ] I have raised an issue to propose this change ([required](https://github.com/Daewoong-AI/DABA6-article-crawler/issues) for new features and bug fixes)
- [ ] I have raised an issue to propose this change ([required](https://github.com/ai4co/rl4co/issues) for new features and bug fixes)

## Types of changes

Expand Down

0 comments on commit 416bf38

Please sign in to comment.