Commit 5b9c4664 authored by Yuxin Wu's avatar Yuxin Wu Committed by GitHub

Update unexpected-problems---bugs.md

parent fb9c4fdf
......@@ -4,16 +4,31 @@ about: Report unexpected problems about Tensorpack or its examples.
title: Please read & provide the following information
labels: ''
assignees: ''
issue_body: true
inputs:
- type: description
attributes:
value: Please fill out this form as completely as possible, unless you already find out the root cause to your issue.
- type: textarea
attributes:
label: Your observation
description: Provide __full__ logs of the observation, incomplete logs are less helpful. Please also provide other relevant observations if not in logs. If needed, images can be provided in the issue body below
required: true
- type: textarea
attributes:
label: Expected Behavior
description: If there are no obvious failures, provide a clear and concise description of what you expected to happen.
required: false
- type: textarea
attributes:
label: Your Environment
description: provide the output of `python -m tensorpack.tfutils.collect_env`. If this fails, provide the logs and tell us how you install TensorFlow/tensorpack.
required: true
---
If you're asking about an unexpected problem which you do not know the root cause,
use this template. __PLEASE DO NOT DELETE THIS TEMPLATE, FILL IT__:
If you already know the root cause to your problem,
feel free to delete everything in this template.
### 1. What you did:
### How to reproduce the issue:
(1) **If you're using examples, what's the command you run:**
......@@ -26,46 +41,6 @@ feel free to delete everything in this template.
Please try to provide enough information to let others __reproduce__ your issues.
Without reproducing the issue, we may not be able to investigate it.
### 2. What you observed:
(1) **Include the ENTIRE logs here:**
```
<paste logs here>
```
It's always better to copy-paste what you observed instead of describing them.
It's always better to paste **as much as possible**, although sometimes a partial log is OK.
Tensorpack typically saves stdout to its training log.
If stderr is relevant, you can run a command with `my_command 2>&1 | tee logs.txt`
to save both stdout and stderr to one file.
(2) **Other observations, if any:**
For example, CPU/GPU utilization, output images, tensorboard curves, if relevant to your issue.
### 3. What you expected, if not obvious.
If you expect higher speed, please read
http://tensorpack.readthedocs.io/tutorial/performance-tuning.html
before posting.
If you expect the model to converge / work better, note that we do not help you on how to improve a model.
Only in one of the two conditions can we help with it:
(1) You're unable to reproduce the results documented in tensorpack examples.
(2) It indicates a tensorpack bug.
### 4. Your environment:
Paste the output of this command: `python -m tensorpack.tfutils.collect_env`
If this command failed, also tell us your version of Python/TF/tensorpack.
Note that:
+ You can install tensorpack master by `pip install -U git+https://github.com/tensorpack/tensorpack.git`
and see if your issue is already solved.
+ If you're not using tensorpack under a normal command line shell (e.g.,
using an IDE or jupyter notebook), please retry under a normal command line shell.
### Other Information:
You may often want to provide extra information related to your issue, but
at the minimum please try to provide the above information __accurately__ to save effort in the investigation.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment