From 0cfa6a122b77f7da018772cba18ea63b94c1d048 Mon Sep 17 00:00:00 2001 From: Nikhila Ravi Date: Fri, 24 Apr 2020 17:17:22 -0700 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE/bugs.md | 2 ++ .github/ISSUE_TEMPLATE/feature_request.md | 2 ++ .github/ISSUE_TEMPLATE/questions-help.md | 5 ++++- INSTALL.md | 6 ++++++ README.md | 13 ++++++++++++- 5 files changed, 26 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md index 0f2d20f7..beb4d621 100644 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -10,6 +10,8 @@ post according to this template: ## 🐛 Bugs / Unexpected behaviors +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): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 7a478a0c..6eaf025d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,6 +7,8 @@ about: Submit a proposal/request for a new PyTorch3D feature ## 🚀 Feature +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 -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. diff --git a/INSTALL.md b/INSTALL.md index 784b3e28..181aa088 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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). diff --git a/README.md b/README.md index 11a3282a..f2b4c92e 100644 --- a/README.md +++ b/README.md @@ -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