riaz.somc/transformers
1
0
Fork 0
mirror of https://github.com/huggingface/transformers.git synced 2025-07-04 05:10:06 +06:00
Code Issues Actions 20 Packages Projects Releases Wiki Activity

Generate: add API warning to streamers (#22659)

Browse Source 
add API warning
This commit is contained in:
Joao Gante 2023-04-07 19:15:20 +01:00 committed by GitHub
parent f33419261a
commit 3f96e0b4e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/en/generation_strategies.mdx
View File

@ -145,6 +145,12 @@ The `generate()` supports streaming, through its `streamer` input. The `streamer
from a class that has the following methods: `put()` and `end()`. Internally, `put()` is used to push new tokens and from a class that has the following methods: `put()` and `end()`. Internally, `put()` is used to push new tokens and
`end()` is used to flag the end of text generation. `end()` is used to flag the end of text generation.
<Tip warning={true}>
The API for the streamer classes is still under development and may change in the future.
</Tip>
In practice, you can craft your own streaming class for all sorts of purposes! We also have basic streaming classes In practice, you can craft your own streaming class for all sorts of purposes! We also have basic streaming classes
ready for you to use. For example, you can use the [`TextStreamer`] class to stream the output of `generate()` into ready for you to use. For example, you can use the [`TextStreamer`] class to stream the output of `generate()` into
your screen, one word at a time: your screen, one word at a time:

12
src/transformers/generation/streamers.py
View File

@ -39,6 +39,12 @@ class TextStreamer(BaseStreamer):
""" """
Simple text streamer that prints the token(s) to stdout as soon as entire words are formed. Simple text streamer that prints the token(s) to stdout as soon as entire words are formed.
<Tip warning={true}>
The API for the streamer classes is still under development and may change in the future.
</Tip>
Parameters: Parameters:
tokenizer (`AutoTokenizer`): tokenizer (`AutoTokenizer`):
The tokenized used to decode the tokens. The tokenized used to decode the tokens.
@ -128,6 +134,12 @@ class TextIteratorStreamer(TextStreamer):
useful for applications that benefit from acessing the generated text in a non-blocking way (e.g. in an interactive useful for applications that benefit from acessing the generated text in a non-blocking way (e.g. in an interactive
Gradio demo). Gradio demo).
<Tip warning={true}>
The API for the streamer classes is still under development and may change in the future.
</Tip>
Parameters: Parameters:
tokenizer (`AutoTokenizer`): tokenizer (`AutoTokenizer`):
The tokenized used to decode the tokens. The tokenized used to decode the tokens.