New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add README for test #566
Add README for test #566
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, good idea to add this.
We could either move it to CONTRIB.md later, or just link to it from there.
test/README.md
Outdated
- [`torchaudio.sox_effects`](test/test_sox_effects.py) | ||
- [`torchaudio.save`, `torchaudio.load`, `torchaudio.info`](test/test_io.py) | ||
|
||
### Others |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Too generic a title? And the absence of description might be more confusing.
Since this test file is specifically to test that sox interacts correctly with data loader, and thus is unlikely to be updated by users, we could also omit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to list all the test modules for the completeness, so that when there is a missing module from the list, we can say that it's our oversight.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Add README that documents how test directory is organized and (briefly) how to add new tests.
OurThis can be incorporated into the actualCONTRIBUTING.md
can point this for the direction to add test.CONTRIBUTING.md
closes #466