Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Summary: Pull Request resolved: fairinternal/detectron2#321

Differential Revision: D18371157

Pulled By: ppwwyyxx

fbshipit-source-id: 8b1c29717a23a051d272aac6271030f14a4bd344
  • Loading branch information
ppwwyyxx authored and facebook-github-bot committed Nov 7, 2019
1 parent 6a42271 commit b98cd55
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
18 changes: 10 additions & 8 deletions .github/ISSUE_TEMPLATE/unexpected-problems-bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,23 @@ about: Report unexpected problems or bugs in detectron2
If you do not know the root cause of the problem / bug, and wish someone to help you, please
include:

<!-- A clear and concise description of what the bug is. -->
## How To Reproduce the Issue

## To Reproduce

1. what changes you made / what code you wrote
2. what command you run
3. what you observed (full logs are preferred)
1. what changes you made (`git diff`) or what code you wrote
2. what exact command you run
3. what you observed (including the full logs):
```
<put logs in a formatted block>
```

## Expected behavior

If there are no obvious error in "what you observed" provided above,
please tell us the expected behavior.

If you expect the model to work better, only in one of the two conditions we will help with it:
(1) You're unable to reproduce the results documented in detectron2 model zoo.
If you expect the model to work better, note that we do not help you train your model.
Only in one of the two conditions we will help with it:
(1) You're unable to reproduce the results in detectron2 model zoo.
(2) It indicates a detectron2 bug.

## Environment
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ RUN pip install 'git+https://github.com/cocodataset/cocoapi.git#subdirectory=Pyt
# install detectron2
RUN git clone https://github.com/facebookresearch/detectron2 /detectron2_repo
ENV FORCE_CUDA="1"
ENV TORCH_CUDA_ARCH_LIST="Maxwell;Maxwell+Tegra;Pascal;Volta;Turing"
ENV TORCH_CUDA_ARCH_LIST="Kepler;Kepler+Tesla;Maxwell;Maxwell+Tegra;Pascal;Volta;Turing"
RUN pip install -e /detectron2_repo

WORKDIR /detectron2_repo
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The dict may contain the following keys:
* "image": `Tensor` in (C, H, W) format.
* "instances": an `Instances` object, with the following fields:
+ "gt_boxes": `Boxes` object storing N boxes, one for each instance.
+ "gt_classes": `Tensor`, a vector of N labels, in range [0, num_categories).
+ "gt_classes": `Tensor` of long type, a vector of N labels, in range [0, num_categories).
+ "gt_masks": a `PolygonMasks` object storing N masks, one for each instance.
+ "gt_keypoints": a `Keypoints` object storing N keypoint sets, one for each instance.
* "proposals": an `Instances` object used in Fast R-CNN style models, with the following fields:
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorials/write-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ See [densepose in detectron2](https://github.com/facebookresearch/detectron2/tre
for an example that implements new ROIHeads.

Other registries can be found in [API documentation](../modules/modeling.html#model-registries).
You can register components in these registries to customize different parts of a model, or the
entire model.

0 comments on commit b98cd55

Please sign in to comment.