From 29d7bc5efab8bc53584061e35a36dde923fb438c Mon Sep 17 00:00:00 2001 From: Ahmad Sharif Date: Thu, 4 Jan 2024 13:42:49 -0800 Subject: [PATCH 1/2] Updated doc to add deps. --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32a89df7792..24340476a09 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,9 @@ clear and has sufficient instructions to be able to reproduce the issue. ### Dependencies Start by installing the **nightly** build of PyTorch following the [official -instructions](https://pytorch.org/get-started/locally/). +instructions](https://pytorch.org/get-started/locally/). Note that the official +instructions may ask you to install torchvision itself. If you are doing development +on torchvision, you should not install prebuilt torchvision packages. **Optionally**, install `libpng` and `libjpeg-turbo` if you want to enable support for @@ -69,10 +71,10 @@ building GPU support by setting `FORCE_CUDA=1` environment variable, which is us We don't officially support building from source using `pip`, but _if_ you do, you'll need to use the `--no-build-isolation` flag. -Other development dependencies include: +#### Other development dependencies (some of these are needed to run tests): ``` -pip install flake8 typing mypy pytest pytest-mock scipy +pip expecttest install flake8 typing mypy pytest pytest-mock scipy ``` ## Development Process @@ -145,6 +147,8 @@ mypy --config-file mypy.ini ### Unit tests +Before running tests make sure to install [test dependencies](#other-development-dependencies-some-of-these-are-needed-to-run-tests). + If you have modified the code by adding a new feature or a bug-fix, please add unit tests for that. To run a specific test: ```bash From ac368644c6a4368960ecea35a9ac0b6360c1ae8a Mon Sep 17 00:00:00 2001 From: Ahmad Sharif Date: Fri, 5 Jan 2024 08:09:37 -0800 Subject: [PATCH 2/2] Fixed pip install command --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24340476a09..9f724b20f87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,7 @@ We don't officially support building from source using `pip`, but _if_ you do, y #### Other development dependencies (some of these are needed to run tests): ``` -pip expecttest install flake8 typing mypy pytest pytest-mock scipy +pip install expecttest flake8 typing mypy pytest pytest-mock scipy ``` ## Development Process