diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d98076fb..6ae828ac 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,32 +11,52 @@ assignees: '' 1. Tensorboard not showing in Jupyter-notebook see [issue 79](https://github.com/williamFalcon/pytorch-lightning/issues/79). 2. PyTorch 1.1.0 vs 1.2.0 support [see FAQ](https://github.com/williamFalcon/pytorch-lightning#faq) -### Describe the bug -A clear and concise description of what the bug is. +## 🐛 Bug + + + +### To Reproduce -#### To Reproduce Steps to reproduce the behavior: + 1. Go to '...' 2. Run '....' 3. Scroll down to '....' 4. See error + + + #### Code sample -Ideally attach a minimal code sample to reproduce the decried issue. -[Minimal means having the shortest code but still preserving the bug] + -#### Expected behavior -A clear and concise description of what you expected to happen. +### Expected behavior -#### Screenshots -If applicable, add screenshots to help explain your problem. + -### Environment information +### Environment -Desktop (please complete the following information): - - OS: [e.g. iOS, Linux, Win] - - Packaging [e.g. pip, conda] - - Version [e.g. 0.5.2.1] +Please copy and paste the output from our +[environment collection script](https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py) +(or fill out the checklist below manually). + +You can get the script and run it with: +``` +wget https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py +# For security purposes, please check the contents of collect_env.py before running it. +python collect_env.py +``` + + - PyTorch Version (e.g., 1.0): + - OS (e.g., Linux): + - How you installed PyTorch (`conda`, `pip`, source): + - Build command you used (if compiling from source): + - Python version: + - CUDA/cuDNN version: + - GPU models and configuration: + - Any other relevant information: ### Additional context -Add any other context about the problem here. + + diff --git a/.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md b/.github/ISSUE_TEMPLATE/documentation.md similarity index 89% rename from .github/ISSUE_TEMPLATE/typos-and-doc-fixes.md rename to .github/ISSUE_TEMPLATE/documentation.md index b9b61ef4..1162def1 100644 --- a/.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -7,7 +7,7 @@ assignees: '' --- -## Typos and docs fixes +## 📚 Documentation For typos and doc fixes, please go ahead and: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index dcb4a88a..3350917a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,21 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## 🚀 Feature + -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +### Motivation -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + -**Additional context** -Add any other context or screenshots about the feature request here. +### Pitch + + + +### Alternatives + + + +### Additional context + + diff --git a/.github/ISSUE_TEMPLATE/how-to-question.md b/.github/ISSUE_TEMPLATE/how-to-question.md index f18f0a6a..87e0f3ec 100644 --- a/.github/ISSUE_TEMPLATE/how-to-question.md +++ b/.github/ISSUE_TEMPLATE/how-to-question.md @@ -7,20 +7,24 @@ assignees: '' --- +## ❓ Questions and Help + ### Before asking: 1. search the issues. 2. search the docs. -If you still can't find what you need: -#### What is your question? + -#### Code -Please paste a code snippet if your question requires it! +#### What is your question? -#### What have you tried? +#### Code -#### What's your environment? -- conda version (no venv) -- PyTorch version -- Lightning version -- Test-tube version + + +#### What have you tried? + +#### What's your environment? + + - OS: [e.g. iOS, Linux, Win] + - Packaging [e.g. pip, conda] + - Version [e.g. 0.5.2.1]