Skip to content

Commit 0cfa6a1

Browse files
nikhilaravifacebook-github-bot
authored andcommitted
README updates
Summary: Some updates to the issue templates, readme and install.md Creating an FAQ for installation similar to: https://github.com/facebookresearch/detectron2/blob/master/INSTALL.md#common-installation-issues Reviewed By: gkioxari Differential Revision: D21117899 fbshipit-source-id: d287c3a7a99c2e425b4e0cffca55a7b225d79e11
1 parent cf84dac commit 0cfa6a1

File tree

5 files changed

+26
-2
lines changed

5 files changed

+26
-2
lines changed

.github/ISSUE_TEMPLATE/bugs.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ post according to this template:
1010
## 🐛 Bugs / Unexpected behaviors
1111
<!-- A clear and concise description of the issue -->
1212

13+
NOTE: Please look at the existing list of Issues tagged with the label ['bug`](https://github.com/facebookresearch/pytorch3d/issues?q=label%3Abug). **Only open a new issue if this bug has not already been reported. If an issue already exists, please comment there instead.**.
14+
1315
## Instructions To Reproduce the Issue:
1416

1517
Please include the following (depending on what the issue is):

.github/ISSUE_TEMPLATE/feature_request.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ about: Submit a proposal/request for a new PyTorch3D feature
77
## 🚀 Feature
88
<!-- A clear and concise description of the feature proposal -->
99

10+
NOTE: Please look at the existing list of Issues tagged with the label ['enhancement`](https://github.com/facebookresearch/pytorch3d/issues?q=label%3Aenhancement). **Only open a new issue if you do not see your feature request there**.
11+
1012
## Motivation
1113

1214
<!-- Please outline the motivation for the proposal.

.github/ISSUE_TEMPLATE/questions-help.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ about: How do I do X with PyTorch3D? How does PyTorch3D do X?
88

99
<!-- A clear and concise description of the question you need help with. -->
1010

11-
NOTE:
11+
12+
NOTE: Please look at the existing list of Issues tagged with the label ['question`](https://github.com/facebookresearch/pytorch3d/issues?q=label%3Aquestion) or ['how-to`](https://github.com/facebookresearch/pytorch3d/issues?q=label%3A%22how+to%22). **Only open a new issue if you cannot find an answer there**.
13+
14+
Also note the following:
1215

1316
1. If you encountered any errors or unexpected issues while using PyTorch3D and need help resolving them,
1417
please use the "Bugs / Unexpected behaviors" issue template.

INSTALL.md

+6
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,9 @@ After installing, verify whether all unit tests have passed
128128
cd tests
129129
python3 -m unittest discover -p *.py
130130
```
131+
132+
# FAQ
133+
134+
### Can I use Docker?
135+
136+
We don't provide a docker file but see [#113](https://github.com/facebookresearch/pytorch3d/issues/113) for a docker file shared by a user (NOTE: this has not been tested by the PyTorch3D team).

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ We also have deep dive notes on several API components:
5757

5858
We welcome new contributions to PyTorch3D and we will be actively maintaining this library! Please refer to [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for full instructions on how to run the code, tests and linter, and submit your pull requests.
5959

60-
6160
## Contributors
6261

6362
PyTorch3D is written and maintained by the Facebook AI Research Computer Vision Team.
@@ -75,3 +74,15 @@ If you find PyTorch3D useful in your research, please cite:
7574
year = {2020}
7675
}
7776
```
77+
78+
## News
79+
80+
Please see below for a timeline of the codebase updates in reverse chronological order. We are sharing updates on the releases as well as research projects which are built with PyTorch3D. The changelogs for the releases are available under [`Releases`](https://github.com/facebookresearch/pytorch3d/releases), and the builds can be installed using `conda` as per the instructions in [INSTALL.md](INSTALL.md).
81+
82+
**[April 24th 2020]:** PyTorch3D v0.2 released
83+
84+
**[March 25th 2020]:** [SynSin](https://arxiv.org/abs/1912.08804) codebase released using PyTorch3D: https://github.com/facebookresearch/synsin
85+
86+
**[March 8th 2020]:** PyTorch3D v0.1.1 bug fix release
87+
88+
**[Jan 23rd 2020]:** PyTorch3D v0.1 released. [Mesh R-CNN](https://arxiv.org/abs/1906.02739) codebase released: https://github.com/facebookresearch/meshrcnn

0 commit comments

Comments
 (0)