From 89807cf7cdc9b40a398f2e74f15cb5a79084df60 Mon Sep 17 00:00:00 2001 From: yangarbiter Date: Wed, 23 Jun 2021 12:30:21 -0700 Subject: [PATCH] Update docs (#1584) --- CONTRIBUTING.md | 10 ++++++++++ test/torchaudio_unittest/README.md | 12 ++++-------- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94526661e0..67ea6caed2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: diff --git a/test/torchaudio_unittest/README.md b/test/torchaudio_unittest/README.md index 69f8498f05..dd6249fb4a 100644 --- a/test/torchaudio_unittest/README.md +++ b/test/torchaudio_unittest/README.md @@ -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}:/src/featbin/" @@ -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)