[Doctests] Fix all T5 doc tests #16646
Merged
Conversation
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
This was referenced Apr 7, 2022
Closed
|
The documentation is not available anymore as the PR was closed or merged. |
sgugger
approved these changes
Apr 7, 2022
docs/source/en/model_doc/byt5.mdx
Outdated
Comment on lines
56
to
61
| >>> input_ids = ( | ||
| ... torch.tensor([list("Life is like a box of chocolates.".encode("utf-8"))]) + 3 | ||
| >>> ) # add 3 for special tokens | ||
| >>> labels = ( | ||
| ... torch.tensor([list("La vie est comme une boîte de chocolat.".encode("utf-8"))]) + 3 | ||
| >>> ) # add 3 for special tokens |
There was a problem hiding this comment.
Can the comment go once above to avoid the formatting on several lines? And also maybe be more helpful because I have no idea what "add 3 for special tokens" means.
docs/source/en/model_doc/byt5.mdx
Outdated
Comment on lines
104
to
108
| >>> # Now Mask | ||
| >>> # Note that we can add "{extra_id_...}" to the string directly | ||
| >>> # as the Byte tokenizer would incorrectly merge the tokens | ||
| >>> # We need to work on the character level directly here | ||
| >>> # => mask to "The dog [258]a ball [257]park." |
There was a problem hiding this comment.
We can or we can't? I don't understand this comment and why it results in using 258 and 257.
There was a problem hiding this comment.
Good point - Added more explanation!
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
…platen/transformers into correct_t5_model_docs
elusenji
pushed a commit
to elusenji/transformers
that referenced
this pull request
Jun 12, 2022
* [Doctests] Fix all T5 doc tests * make style * Update docs/source/en/model_doc/t5.mdx Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> * Apply Sylvains comments * Apply suggestions from code review Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
What does this PR do?
Corrects T5 model docs and adds them to doc tests
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.