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

Update the installation and testing instructions. #1584

Merged
merged 4 commits into from
Jun 23, 2021
Merged

Update the installation and testing instructions. #1584

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f15d5a1
Update document for unittest and CONTRIBUTING.md
yangarbiter Jun 18, 2021
e2eeb8c
Direct people to CONTRIBUTION.md for installing related package in th…
yangarbiter Jun 18, 2021
b84f48c
remove 'git submodule sync' from CONTRIBUTING.md
yangarbiter Jun 21, 2021
f6bdca7
list optional packages instead of a pip install command
yangarbiter Jun 21, 2021
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ The following dependencies are also needed for testing:
pip install typing pytest scipy numpy parameterized
```

Optional packages to install if you want to run related tests:

```bash
pip install librosa requests soundfile kaldi_io transformers
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Installation of librosa is sometimes tricky.

audio/.circleci/unittest/linux/scripts/install.sh

Line 55 in 380800c

# Note: installing librosa via pip fail because it will try to compile numba.

Instead of giving the instruction with pip install, can you just simply list these libraries?
Something like

  • librosa
  • requests
  • soundfile
  • kaldi_io
  • transformers
  • fairseq (it has to be newer than 0.10.2, so you will need to install from source. Commit e6eddd80 is known to work.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added these here

```

## Development Process

If you plan to modify the code or documentation, please follow the steps below:
Expand Down
12 changes: 4 additions & 8 deletions test/torchaudio_unittest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,10 @@
You can use `pytest` to run `torchaudio`'s test suites. See
https://docs.pytest.org/ for the detail of how to use `pytest` command.

For testing, the following packages are needed:
For testing, please refer to [contributing guide](../../CONTRIBUTING.md) for
the installation of the required and optional packages.

```bash
pip install typing pytest scipy numpy parameterized
```

Make sure to follow the installation instruction in the [contributing
guide](../../CONTRIBUTING.md) first. For running `kaldi`-related tests:
For running `kaldi`-related tests:

```bash
export PATH="${PATH}:<path_to_kaldi>/src/featbin/"
Expand Down Expand Up @@ -73,7 +69,7 @@ The following test modules are defined for corresponding `torchaudio` module/fun
- [`torchaudio.compliance.kaldi`](./compliance_kaldi_test.py)
- [`torchaudio.kaldi_io`](./kaldi_io_test.py)
- [`torchaudio.sox_effects`](./sox_effect)
- [`torchaudio.save`, `torchaudio.load`, `torchaudio.info`](./io_test.py)
- [`torchaudio.backend`](./backend)

### Test modules that do not fall into the above categories
- [test_dataloader.py](./dataloader_test.py)
Expand Down