[Doc] Fix 'tokenized' -> 'tokenizer' typo in streamer docstrings#45508
Open
avasis-ai wants to merge 1 commit intohuggingface:mainfrom
Open
[Doc] Fix 'tokenized' -> 'tokenizer' typo in streamer docstrings#45508avasis-ai wants to merge 1 commit intohuggingface:mainfrom
avasis-ai wants to merge 1 commit intohuggingface:mainfrom
Conversation
All three streamer classes (TextStreamer, TextIteratorStreamer, AsyncTextIteratorStreamer) had 'The tokenized used to decode the tokens' in their docstrings, which should be 'The tokenizer used to decode the tokens'.
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.
Summary
Fixes a systematic docstring typo in all three streamer classes in
src/transformers/generation/streamers.py:TextStreamerTextIteratorStreamerAsyncTextIteratorStreamerEach had
"The tokenized used to decode the tokens."in thetokenizerparameter description. This should be"The tokenizer used to decode the tokens."— the parameter accepts a tokenizer object, not a tokenized output.Why this is not a duplicate
No existing PR addresses this specific documentation error across all three streamer classes.
AI assistance disclosure
This PR was prepared with AI assistance. The submitting human has reviewed every changed line and confirms the fix is correct.
Co-authored-by: opencode