[WIP, but please review] Enforce doc coverage, clean torch.* namespace#15980
Closed
zasdfgbnm wants to merge 5 commits intopytorch:masterfrom
Closed
[WIP, but please review] Enforce doc coverage, clean torch.* namespace#15980zasdfgbnm wants to merge 5 commits intopytorch:masterfrom
zasdfgbnm wants to merge 5 commits intopytorch:masterfrom
Conversation
Contributor
|
This seems... reasonable, I guess? What about things in torch.nn? |
Collaborator
Author
|
@ezyang I think we should do the same thing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
People (PR authors, reviewers) keep forgetting to add docs for new ops to
torch.rst, and sometimes they add things that should be intorch.nn.functionalmistakenly totorch.*namespace.So I write a
test_docs_coverage.py, that assert everything intorchshould also be intorch.rstvice versa, unless explicitly whitelisted intest_docs_coverage.py.This work is currently in progress, but since there are big API changes, before moving on, I'd like to hear comments from PyTorch people to know if this is a good idea.