Skip to content

Commit

Permalink
Update docs (#1584)
Browse files Browse the repository at this point in the history
  • Loading branch information
yangarbiter authored Jun 23, 2021
1 parent be0a61e commit 89807cf
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ 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:

- `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.)

## 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
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

0 comments on commit 89807cf

Please sign in to comment.