Map model_type and doc pages names #14944
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
|
very neat! |
patrickvonplaten
approved these changes
Dec 27, 2021
|
Sounds good to me. Will resolve conflicts and merge. |
LysandreJik
force-pushed
the
doc_nodel_type
branch
from
3fbe36b
to
b2d0c13
Compare
LysandreJik
reviewed
Jan 3, 2022
|
|
||
| errors = [] | ||
| for m in model_docs: | ||
| if m not in model_types and m != "auto": |
There was a problem hiding this comment.
@sgugger I've added this m != "auto" clause as otherwise the script would complain that auto was not in the MODEL_NAMES_MAPPING. I don't think adding auto there makes sense so I've added this workaround here.
Will merge like this to prevent further conflicts, but open to discussion if you think another solution should have been implemented.
There was a problem hiding this comment.
Sounds good, thanks for fixing!
stevhliu
pushed a commit
to stevhliu/transformers
that referenced
this pull request
Jan 6, 2022
* Map model_type and doc pages names * Add script * Fix typo * Quality * Manual check for Auto Co-authored-by: Lysandre <lysandre.debut@reseau.eseo.fr>
Albertobegue
pushed a commit
to Albertobegue/transformers
that referenced
this pull request
Jan 27, 2022
* Map model_type and doc pages names * Add script * Fix typo * Quality * Manual check for Auto Co-authored-by: Lysandre <lysandre.debut@reseau.eseo.fr>
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?
As discussed on moon-landing, it's not possible to automatically generate the link to the documentation from the configuration of a model, due to multiple inconsistencies between model type and doc page name.
This PR fixes that and adds a script to make sure we have a model type for every documented model (for instance currently we have a mising model type for models having a tokenizer only, like Wav2Vec2-Phoeneme and they don't appear on the AutoTokenizer doc as a result) and that the doc page name matches the model type.
It breaks some links to the doc, but we (I and Julien) think this is acceptable.