S^(h2 d dl mZ d dlZd dlmZ d dlmZmZ erddlm Z G d d Z
G d d
e
Z G d d e Z G d
de Z
y) ) annotationsN)Queue)
TYPE_CHECKINGOptional )
AutoTokenizerc e Zd ZdZd Zd Zy) BaseStreamerzG
Base class from which `.generate()` streamers should inherit.
c t )z;Function that is called by `.generate()` to push new tokensNotImplementedErrorselfvalues _/var/www/skyplay_api_hub/venv/lib/python3.12/site-packages/transformers/generation/streamers.pyputzBaseStreamer.put !## c t )zHFunction that is called by `.generate()` to signal the end of generationr r s r endzBaseStreamer.end$ r r N)__name__
__module__ __qualname____doc__r r r r r
r
s $$r r
c 6 e Zd ZdZdd dZd Zd Zdd
dZd Zy) TextStreamera)
Simple text streamer that prints the token(s) to stdout as soon as entire words are formed.
The API for the streamer classes is still under development and may change in the future.
Parameters:
tokenizer (`AutoTokenizer`):
The tokenized used to decode the tokens.
skip_prompt (`bool`, *optional*, defaults to `False`):
Whether to skip the prompt to `.generate()` or not. Useful e.g. for chatbots.
decode_kwargs (`dict`, *optional*):
Additional keyword arguments to pass to the tokenizer's `decode` method.
Examples:
```python
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
>>> tok = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = AutoModelForCausalLM.from_pretrained("openai-community/gpt2")
>>> inputs = tok(["An increasing sequence: one,"], return_tensors="pt")
>>> streamer = TextStreamer(tok)
>>> # Despite returning the usual output, the streamer will also print the generated text to stdout.
>>> _ = model.generate(**inputs, streamer=streamer, max_new_tokens=20)
An increasing sequence: one, two, three, four, five, six, seven, eight, nine, ten, eleven,
```
c X || _ || _ || _ g | _ d| _ d| _ y )Nr T) tokenizer skip_prompt
decode_kwargs token_cache print_lennext_tokens_are_prompt)r r r! r" s r __init__zTextStreamer.__init__K s2 "& * &*#r c L t |j dkD r |j d dkD r t d t |j dkD r|d }| j r| j rd| _ y| j
j
|j | j j | j
fi | j }|j d r || j d }g | _ d| _ nt | dkD rK| j t |d r.|| j d }| xj t | z
c_ n?|| j |j d dz }| xj t | z
c_ | j! | y) zm
Receives tokens, decodes them, and prints them to stdout as soon as they form entire words.
r z'TextStreamer only supports batch size 1FN
)lenshape
ValueErrorr! r% r# extendtolistr decoder" endswithr$ _is_chinese_charordrfindon_finalized_text)r r textprintable_texts r r zTextStreamer.putU s[ u{{ a EKKNQ$6 FG G
!!HE ; ;*/D '
/$t~~$$T%5%5L9K9KL == !$.."2 3N !D DN
Y]t 4 4Sb] C !$.."2 3N NNc. 1 1N "$..4::c?Q3F GN NNc. 1 1N ~.r c
t | j dkD rO | j j | j fi | j }|| j
d }g | _ d| _ nd}d| _ | j |d y)z;Flushes any remaining cache and prints a newline to stdout.r N T)
stream_end)r, r# r r1 r" r$ r% r6 )r r7 r8 s r r zTextStreamer.endw s~ t 1 $(4>>(()9)9PT=O=OPD !$.."2 3N !D DN N&*# ~$ ?r c 4 t |d|sd yd y)zNPrints the new text to stdout. If the stream is ending, also prints a newline.Tr: N)flushr )printr r7 r; s r r6 z TextStreamer.on_finalized_text s
d$jBCdCr c |dk\ r|dk sF|dk\ r|dk s<|dk\ r|dk s2|dk\ r|dk s(|d k\ r|d
k s |d k\ r|d k s|d
k\ r|dk s
|dk\ r|dk ryy)z6Checks whether CP is the codepoint of a CJK character.i N i i 4 iM i iߦ i i? i@ i i i i i i i TFr )r cps r r3 z TextStreamer._is_chinese_char sr 6\bFlf v g
"-g
"-g
"-g
"-f v g
"-r NF)r 'AutoTokenizer'r! boolr7 strr; rD ) r r r r r& r r r6 r3 r r r r r ) s$ B+ /D @ Dr r c H e Zd ZdZ d d fd
Zdd dZd Zd Z xZS )
TextIteratorStreamera
Streamer that stores print-ready text in a queue, to be used by a downstream application as an iterator. This is
useful for applications that benefit from acessing the generated text in a non-blocking way (e.g. in an interactive
Gradio demo).
The API for the streamer classes is still under development and may change in the future.
Parameters:
tokenizer (`AutoTokenizer`):
The tokenized used to decode the tokens.
skip_prompt (`bool`, *optional*, defaults to `False`):
Whether to skip the prompt to `.generate()` or not. Useful e.g. for chatbots.
timeout (`float`, *optional*):
The timeout for the text queue. If `None`, the queue will block indefinitely. Useful to handle exceptions
in `.generate()`, when it is called in a separate thread.
decode_kwargs (`dict`, *optional*):
Additional keyword arguments to pass to the tokenizer's `decode` method.
Examples:
```python
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, TextIteratorStreamer
>>> from threading import Thread
>>> tok = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = AutoModelForCausalLM.from_pretrained("openai-community/gpt2")
>>> inputs = tok(["An increasing sequence: one,"], return_tensors="pt")
>>> streamer = TextIteratorStreamer(tok)
>>> # Run the generation in a separate thread, so that we can fetch the generated text in a non-blocking way.
>>> generation_kwargs = dict(inputs, streamer=streamer, max_new_tokens=20)
>>> thread = Thread(target=model.generate, kwargs=generation_kwargs)
>>> thread.start()
>>> generated_text = ""
>>> for new_text in streamer:
... generated_text += new_text
>>> generated_text
'An increasing sequence: one, two, three, four, five, six, seven, eight, nine, ten, eleven,'
```
c b t | ||fi | t | _ d | _ || _ y N)superr& r
text_queue stop_signaltimeoutr r r! rN r" __class__s r r& z TextIteratorStreamer.__init__ s1 KA=A ' r c | j j || j |r2| j j | j | j yy)\Put the new text in the queue. If the stream is ending, also put a stop signal in the queue.rN N)rL r rN rM r? s r r6 z&TextIteratorStreamer.on_finalized_text sF D$,,7 OO 0 0$,, G r c | S rJ r r s r __iter__z TextIteratorStreamer.__iter__ r c | j j | j }|| j k( r
t |S NrS )rL getrN rM
StopIterationr s r __next__z TextIteratorStreamer.__next__ s8 ##DLL#9 D$$ $ / !Lr FNr rC r! rD rN zOptional[float]rB rE ) r r r r r& r6 rU r[
__classcell__rP s @r rH rH s= +\ ae ( 7; N] H r rH c H e Zd ZdZ d d fd
Zdd dZd Zd Z xZS )
AsyncTextIteratorStreamera&
Streamer that stores print-ready text in a queue, to be used by a downstream application as an async iterator.
This is useful for applications that benefit from acessing the generated text asynchronously (e.g. in an
interactive Gradio demo).
The API for the streamer classes is still under development and may change in the future.
Parameters:
tokenizer (`AutoTokenizer`):
The tokenized used to decode the tokens.
skip_prompt (`bool`, *optional*, defaults to `False`):
Whether to skip the prompt to `.generate()` or not. Useful e.g. for chatbots.
timeout (`float`, *optional*):
The timeout for the text queue. If `None`, the queue will block indefinitely. Useful to handle exceptions
in `.generate()`, when it is called in a separate thread.
decode_kwargs (`dict`, *optional*):
Additional keyword arguments to pass to the tokenizer's `decode` method.
Raises:
TimeoutError: If token generation time exceeds timeout value.
Examples:
```python
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, AsyncTextIteratorStreamer
>>> from threading import Thread
>>> import asyncio
>>> tok = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = AutoModelForCausalLM.from_pretrained("openai-community/gpt2")
>>> inputs = tok(["An increasing sequence: one,"], return_tensors="pt")
>>> # Run the generation in a separate thread, so that we can fetch the generated text in a non-blocking way.
>>> async def main():
... # Important: AsyncTextIteratorStreamer must be initialized inside a coroutine!
... streamer = AsyncTextIteratorStreamer(tok)
... generation_kwargs = dict(inputs, streamer=streamer, max_new_tokens=20)
... thread = Thread(target=model.generate, kwargs=generation_kwargs)
... thread.start()
... generated_text = ""
... async for new_text in streamer:
... generated_text += new_text
>>> print(generated_text)
>>> asyncio.run(main())
An increasing sequence: one, two, three, four, five, six, seven, eight, nine, ten, eleven,
```
c t | ||fi | t j | _ d | _ || _ t j | _ t t d | _
y )NrN ) rK r& asyncior rL rM rN get_running_looploophasattrhas_asyncio_timeoutrO s r r& z"AsyncTextIteratorStreamer.__init__ sT KA=A!--/ ,,. #*7I#> r c | j j | j j | |r;| j j | j j | j yy)rR N)re call_soon_threadsaferL
put_nowaitrM r? s r r6 z+AsyncTextIteratorStreamer.on_finalized_text( sL &&t'A'A4H II * *4??+E+EtGWGW X r c | S rJ r r s r __aiter__z#AsyncTextIteratorStreamer.__aiter__. rV r c K | j r[t j | j 4 d { | j j d { }d d d d { nAt j
| j j | j d { }| j k( r
t |S 7 7 s7 e# 1 d { 7 sw Y 3xY w7 :# t j $ r t w xY wwrX ) rg rc rN rL rY wait_forrM StopAsyncIteration TimeoutErrorr s r __anext__z#AsyncTextIteratorStreamer.__anext__1 s ''"??4<<8 8 8"&//"5"5"7 7E8 8 8 & . .t/B/B/Ddll [[ ((((** 8 78 8 8 8 \## ! . !s D/C$ CC$ C
C C
C$ %C &AC$ 'C"(C$ ,DC$ C
C$
C C C C$ $ DDr\ r] rB rE ) r r r r r& r6 rl rq r^ r_ s @r ra ra s= 2j ae?(?7;?N]?Y
r ra )
__future__r rc queuer typingr r models.autor r
r rH ra r r r rv sQ # * + $ $ v< vrD< DNU U r