d# d dl mZ d dlmZmZ erddlmZ G d d Z G d de Z G d d
e Z d S ) )Queue)
TYPE_CHECKINGOptional )
AutoTokenizerc e Zd ZdZd Zd ZdS ) BaseStreamerzG
Base class from which `.generate()` streamers should inherit.
c t )z;Function that is called by `.generate()` to push new tokensNotImplementedErrorselfvalues Alib/python3.11/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 H e Zd ZdZddddefdZd Zd Zdd ed
efd Z d Z
d
S ) 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("gpt2")
>>> model = AutoModelForCausalLM.from_pretrained("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,
```
F tokenizerr skip_promptc Z || _ || _ || _ g | _ d| _ d| _ d S )Nr T)r r
decode_kwargs token_cache print_lennext_tokens_are_prompt)r r r r! s r __init__zTextStreamer.__init__H s8 "& * &*###r c Z t |j dk r |j d dk rt d t |j dk r|d }| j r| j r d| _ dS | j | | j j | j fi | j
}| d r || j d }g | _ d| _ nt | dk rU|
t |d r-|| j d }| xj t | z
c_ nB|| j | d dz }| xj t | z
c_ | | dS ) 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.putR s u{ a EKNQ$6$6 FGG G
!
!!HE ; */D ' F
///$t~$T%5LL9KLL == 2 !$."2"2 3N !D DNN
YY]]t 4 4Sb]] C C] !$."2"2 3N NNc. 1 1 1NNN "$.4::c??Q3F"F GN NNc. 1 1 1NN ~.....r c t | j dk r; | j j | j fi | j }|| j d }g | _ d| _ nd}d| _ | |d dS )z;Flushes any remaining cache and prints a newline to stdout.r N T)
stream_end)r+ r" r r0 r! r# r$ r5 )r r6 r7 s r r zTextStreamer.endt s t 1 $ $(4>()9PPT=OPPD !$."2"2 3N !D DNN N&*# ~$ ?????r r6 r: c 2 t |d|sdnd dS )zNPrints the new text to stdout. If the stream is ending, also prints a newline.Tr9 N)flushr )printr r6 r: s r r5 z TextStreamer.on_finalized_text s&
d$j$BBBdCCCCCCr c |dk r|dk sT|dk r|dk sH|dk r|dk s<|dk r|dk s0|d k r|d
k s$|d k r|d k s|d
k r|dk s |dk r|dk rdS dS )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 r2 z TextStreamer._is_chinese_char s 6\\bFllf v g
"--g
"--g
"--g
"--f v g
"--4ur NF) r r r r boolr% r r strr5 r2 r r r r r & s B+ +/ + + + + + / / /D @ @ @ D Dc Dt D D D D r r c ^ e Zd ZdZ ddddedee f fd
Zdd ed
efd Z d Z
d
Z xZ S )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("gpt2")
>>> model = AutoModelForCausalLM.from_pretrained("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,'
```
FNr r r timeoutc t j ||fi | t | _ d | _ || _ d S N)superr% r
text_queue stop_signalrF )r r r rF r! __class__s r r% z TextIteratorStreamer.__init__ sD KAA=AAA '' r r6 r: c | j || j |r(| j | j | j dS dS )z\Put the new text in the queue. If the stream is ending, also put a stop signal in the queue.rF N)rJ r rF rK r> s r r5 z&TextIteratorStreamer.on_finalized_text sZ D$,777 H O 0$, G G G G G H Hr c | S rH r r s r __iter__z TextIteratorStreamer.__iter__ s r c x | j | j }|| j k rt |S )NrN )rJ getrF rK
StopIterationr
s r __next__z TextIteratorStreamer.__next__ s9 ##DL#99 D$ $ $ // !Lr )FNrA )
r r r r rB r floatr% rC r5 rP rT
__classcell__)rL s @r rE rE s + +\ ae ( 7; NVW\o H Hc Ht H H H H r rE N)
queuer typingr r models.autor r r rE r r r rZ s * * * * * * * * ,++++++ $ $ $ $ $ $ $ $ v v v v v< v v vrD D D D D< D D D D Dr