From 78046ac6df46591d355b6f7431e2f4f6cbeb6af6 Mon Sep 17 00:00:00 2001 From: Yao-Yuan Yang Date: Thu, 17 Jun 2021 17:23:56 -0700 Subject: [PATCH] Update document for unittest and CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ test/torchaudio_unittest/README.md | 5 ++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94526661e06..087453ab655 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,9 +55,16 @@ conda install pytorch -c pytorch-nightly pip install cmake ninja ``` +### Install other requirements + +```bash +pip install -r requirements.txt +``` + ```bash git clone https://github.com/pytorch/audio.git cd audio +git submodule sync git submodule update --init --recursive BUILD_SOX=1 python setup.py develop # or, for OSX diff --git a/test/torchaudio_unittest/README.md b/test/torchaudio_unittest/README.md index 69f8498f051..98dd4f6016f 100644 --- a/test/torchaudio_unittest/README.md +++ b/test/torchaudio_unittest/README.md @@ -9,6 +9,7 @@ For testing, the following packages are needed: ```bash pip install typing pytest scipy numpy parameterized +pip install -r requirements.txt ``` Make sure to follow the installation instruction in the [contributing @@ -73,7 +74,9 @@ 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.save`, `torchaudio.load`, `torchaudio.info`] + - soundfile backend: [[save](./backend/soundfile/save_test.py), [load](./backend/soundfile/load_test.py), [info](./backend/soundfile/info_test.py)] + - SoX backend: [[save](./backend/sox_io/save_test.py), [load](./backend/sox_io/load_test.py), [info](./backend/sox_io/info_test.py)] ### Test modules that do not fall into the above categories - [test_dataloader.py](./dataloader_test.py)