Skip to content

Commit fc3a8a4

Browse files
committed
Update document for unittest and CONTRIBUTING.md
1 parent 7deea25 commit fc3a8a4

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,16 @@ conda install pytorch -c pytorch-nightly
5555
pip install cmake ninja
5656
```
5757

58+
### Install other requirements
59+
60+
```bash
61+
pip install -r requirements.txt
62+
```
63+
5864
```bash
5965
git clone https://github.com/pytorch/audio.git
6066
cd audio
67+
git submodule sync
6168
git submodule update --init --recursive
6269
BUILD_SOX=1 python setup.py develop
6370
# or, for OSX

test/torchaudio_unittest/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ For testing, the following packages are needed:
99

1010
```bash
1111
pip install typing pytest scipy numpy parameterized
12+
pip install -r requirements.txt
1213
```
1314

1415
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
7374
- [`torchaudio.compliance.kaldi`](./compliance_kaldi_test.py)
7475
- [`torchaudio.kaldi_io`](./kaldi_io_test.py)
7576
- [`torchaudio.sox_effects`](./sox_effect)
76-
- [`torchaudio.save`, `torchaudio.load`, `torchaudio.info`](./io_test.py)
77+
- [`torchaudio.save`, `torchaudio.load`, `torchaudio.info`]
78+
- soundfile backend [[save](./backend/soundfile/save_test.py), [load](./backend/soundfile/load_test.py), [info](./backend/soundfile/info_test.py)]
79+
- SoX backend [[save](./backend/sox_io/save_test.py), [load](./backend/sox_io/load_test.py), [info](./backend/sox_io/info_test.py)]
7780

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

0 commit comments

Comments
 (0)