Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated doc to add dependencies for testing #8198

Merged
merged 2 commits into from
Jan 5, 2024
Merged

Updated doc to add dependencies for testing #8198

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29d7bc5
Updated doc to add deps.
ahmadsharif1 Jan 4, 2024
ac36864
Fixed pip install command
ahmadsharif1 Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down