Skip to content
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

Merged
merged 3 commits into from May 1, 2020
Merged

Add README for test #566

merged 3 commits into from May 1, 2020

Conversation

mthrok
Copy link
Collaborator

@mthrok mthrok commented Apr 20, 2020

Add README that documents how test directory is organized and (briefly) how to add new tests.
Our CONTRIBUTING.md can point this for the direction to add test. This can be incorporated into the actual CONTRIBUTING.md

closes #466

Copy link
Contributor

@vincentqb vincentqb left a 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 Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated
- [`torchaudio.sox_effects`](test/test_sox_effects.py)
- [`torchaudio.save`, `torchaudio.load`, `torchaudio.info`](test/test_io.py)

### Others
Copy link
Contributor

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?

Copy link
Collaborator Author

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.

test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
test/README.md Outdated Show resolved Hide resolved
@mthrok mthrok requested a review from vincentqb May 1, 2020 16:26
Copy link
Contributor

@vincentqb vincentqb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vincentqb vincentqb merged commit ff1c653 into pytorch:master May 1, 2020
@mthrok mthrok deleted the add-test-md branch May 1, 2020 21:45
@vincentqb vincentqb mentioned this pull request Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor tests into small test suits
2 participants