423A35C7/pytorch3d
1
0
Fork 0
mirror of https://github.com/facebookresearch/pytorch3d.git synced 2025-08-02 03:42:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

README updates

Browse Source 
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
This commit is contained in:
Nikhila Ravi 2020-04-24 17:17:22 -07:00 committed by Facebook GitHub Bot
parent cf84dacf2e
commit 0cfa6a122b
5 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bugs.md vendored
View File

@ -10,6 +10,8 @@ post according to this template:
## 🐛 Bugs / Unexpected behaviors
<!-- A clear and concise description of the issue -->
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.**.
## Instructions To Reproduce the Issue:
Please include the following (depending on what the issue is):

2
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -7,6 +7,8 @@ about: Submit a proposal/request for a new PyTorch3D feature
## 🚀 Feature
<!-- A clear and concise description of the feature proposal -->
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**.
## Motivation
<!-- Please outline the motivation for the proposal.

5
.github/ISSUE_TEMPLATE/questions-help.md vendored
View File

@ -8,7 +8,10 @@ about: How do I do X with PyTorch3D? How does PyTorch3D do X?
<!-- A clear and concise description of the question you need help with. -->
NOTE:
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**.
Also note the following:
1. If you encountered any errors or unexpected issues while using PyTorch3D and need help resolving them,
please use the "Bugs / Unexpected behaviors" issue template.

6
INSTALL.md
View File

@ -128,3 +128,9 @@ After installing, verify whether all unit tests have passed
cd tests
python3 -m unittest discover -p *.py
```
# FAQ
### Can I use Docker?
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).

13
README.md
View File

@ -57,7 +57,6 @@ We also have deep dive notes on several API components:
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.
## Contributors
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:
year = {2020}
}
```
## News
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).
**[April 24th 2020]:** PyTorch3D v0.2 released
**[March 25th 2020]:** [SynSin](https://arxiv.org/abs/1912.08804) codebase released using PyTorch3D: https://github.com/facebookresearch/synsin
**[March 8th 2020]:** PyTorch3D v0.1.1 bug fix release
**[Jan 23rd 2020]:** PyTorch3D v0.1 released. [Mesh R-CNN](https://arxiv.org/abs/1906.02739) codebase released: https://github.com/facebookresearch/meshrcnn