Enforce all objects in the main init are documented #9014
Merged
Conversation
This file contains 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
LysandreJik
approved these changes
Dec 9, 2020
Comment on lines
+374
to
+391
| SHOULD_HAVE_THEIR_OWN_PAGE = [ | ||
| # bert-japanese | ||
| "BertJapaneseTokenizer", | ||
| "CharacterTokenizer", | ||
| "MecabTokenizer", | ||
| # Bertweet | ||
| "BertweetTokenizer", | ||
| # Herbert | ||
| "HerbertTokenizer", | ||
| "HerbertTokenizerFast", | ||
| # Phoebus | ||
| "PhobertTokenizer", | ||
| # Benchmarks | ||
| "PyTorchBenchmark", | ||
| "PyTorchBenchmarkArguments", | ||
| "TensorFlowBenchmark", | ||
| "TensorFlowBenchmarkArguments", | ||
| ] |
There was a problem hiding this comment.
These are the ones we should work on then?
There was a problem hiding this comment.
Yes! Will open issues once this PR is merged.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Some objects added by contributors or the team are regularly forgotten. This PR changes the script that inspects whether or not models are documented to encompass all objects in the main init (and adds documentation for multiple forgotten objects).