Unverified Commit 89807cf7 authored by yangarbiter's avatar yangarbiter Committed by GitHub
Browse files

Update docs (#1584)

parent be0a61e6
...@@ -78,6 +78,16 @@ The following dependencies are also needed for testing: ...@@ -78,6 +78,16 @@ The following dependencies are also needed for testing:
pip install typing pytest scipy numpy parameterized 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 ## Development Process
If you plan to modify the code or documentation, please follow the steps below: If you plan to modify the code or documentation, please follow the steps below:
......
...@@ -5,14 +5,10 @@ ...@@ -5,14 +5,10 @@
You can use `pytest` to run `torchaudio`'s test suites. See You can use `pytest` to run `torchaudio`'s test suites. See
https://docs.pytest.org/ for the detail of how to use `pytest` command. 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 For running `kaldi`-related tests:
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:
```bash ```bash
export PATH="${PATH}:<path_to_kaldi>/src/featbin/" export PATH="${PATH}:<path_to_kaldi>/src/featbin/"
...@@ -73,7 +69,7 @@ The following test modules are defined for corresponding `torchaudio` module/fun ...@@ -73,7 +69,7 @@ The following test modules are defined for corresponding `torchaudio` module/fun
- [`torchaudio.compliance.kaldi`](./compliance_kaldi_test.py) - [`torchaudio.compliance.kaldi`](./compliance_kaldi_test.py)
- [`torchaudio.kaldi_io`](./kaldi_io_test.py) - [`torchaudio.kaldi_io`](./kaldi_io_test.py)
- [`torchaudio.sox_effects`](./sox_effect) - [`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 modules that do not fall into the above categories
- [test_dataloader.py](./dataloader_test.py) - [test_dataloader.py](./dataloader_test.py)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment