Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
Torchaudio
Commits
89807cf7
Unverified
Commit
89807cf7
authored
Jun 23, 2021
by
yangarbiter
Committed by
GitHub
Jun 23, 2021
Browse files
Update docs (#1584)
parent
be0a61e6
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
14 additions
and
8 deletions
+14
-8
CONTRIBUTING.md
CONTRIBUTING.md
+10
-0
test/torchaudio_unittest/README.md
test/torchaudio_unittest/README.md
+4
-8
No files found.
CONTRIBUTING.md
View file @
89807cf7
...
...
@@ -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:
...
...
test/torchaudio_unittest/README.md
View file @
89807cf7
...
...
@@ -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/"
...
...
@@ -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
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment