T^(hLdZddlmZddlZddlZddlmZmZmZm Z ddl Z ddl Z ddlmZddlmZmZmZmZmZmZddlmZmZmZmZmZmZmZmZm Z m!Z!dd l"m#Z#m$Z$m%Z%dd l&m'Z'm(Z(m)Z)m*Z*d d l+m,Z,e)jZe.Z/d Z0GddejbjdZ3GddejbjdZ4GddejbjdZ5GddejbjdZ6GddejbjdZ7GddejbjdZ8GddejbjdZ9GddejbjdZ:GddejbjdZ;Gd d!ejbjdZ<Gd"d#ejbjdZ=Gd$d%ejbjdZ>e Gd&d'ejbjdZ?Gd(d)eZ@d*ZAd+ZBe'd,eAGd-d.e@ZCe'd/eAGd0d1e@eZDe'd2eAGd3d4e@eZEe'd5eAGd6d7e@eZFe'd8eAGd9d:e@eZGgd;ZHy)rSzTFLayoutLMEmbeddings.buildGs  ]], - //{{--t/?/?@+D,B,BC*DK ]]2 3 )-!{{22D4D4DE+D,B,BC*9*D & ]]0 1 '+!33T5E5EF+D,B,BC(7(D $ ]]2 3 )-!668H8HI+D,B,BC*9*D & ]]2 3 )-!668H8HI+D,B,BC*9*D & ]]2 3 )-!668H8HI+D,B,BC*9*D & ]]2 3 )-!668H8HI+D,B,BC*9*D &  ::  4d + 7t~~223 L$$dD$++2I2I%JK L L 8i               L LsfA L<A M *AM AM#*AM0 AM=*AN ?3N<M MM #M-0M:=N NNcR||J|At||jjtj|j |}t |dd}|tj|d}|/tjtjd|dd}|/tjtjd|dd}|tj|dgzd x}} tj|j|dddddf}tj|j|ddddd f} tj|j|ddddd f} tj|j|ddddd f} tj|j|ddddd f|ddddd fz } tj|j|ddddd f|dddddfz }tj|j|}tj|j |}||z|z|z| z| z| z| z|z}|j#|}|j%||}|S#t$r} td | d} ~ wwxYw)z Applies embedding based on inputs tensor. Returns: final_embeddings (`tf.Tensor`): output embedding tensor. N)paramsindicesrdimsvalue)startlimitaxis)r\r!rz:The `bbox`coordinate values should be within 0-1000 range.inputsrdtraining)rr/rOrLgatherrBrfill expand_dimsrangerHrI IndexErrorrJrKrGrEr&r9)r; input_idsbbox position_idstoken_type_ids inputs_embedsrfrUleft_position_embeddingsupper_position_embeddingsright_position_embeddingslower_position_embeddingserJrKposition_embedstoken_type_embedsfinal_embeddingss r>callzTFLayoutLMEmbeddings.calls%-*?@@  *9dkk6L6L MIIT[[)LM /4  !WW+Q?N  >>"((+b/*RYZ  >>"((+b/*RYZ <''+"31= =D4 b')yy1K1KTRSUVXYRY]'[ $(* $2L2LdSTVWYZSZm(\ %(* $2L2LdSTVWYZSZm(\ %(* $2L2LdSTVWYZSZm(\ %!# $*D*Dd1aQR7mVZ[\^_ab[bVcFc d " $*D*Dd1aQR7mVZ[\^_ab[bVcFc d))4+C+C\ZIIT-G-GQ_`   ' '(  ( (  ( (  ($ $$ $  >>1A>B<r$r$9spQ M7Lv*.$(,0.2-1< &< "< * < , < + < <  < r?r$c^eZdZdfd ZddZ d ddZd dZxZS) TFLayoutLMSelfAttentionc t|d i||j|jzdk7r&t d|jd|jd|j|_t |j|jz |_|j|j z|_tj|j |_ tjj|jt|jd|_tjj|jt|jd|_tjj|jt|jd|_tjj'|j( |_|j,|_||_y) NrzThe hidden size (z6) is not a multiple of the number of attention heads ()queryunitskernel_initializerr)keyr\r*r,)r-r.r0num_attention_heads ValueErrorintattention_head_size all_head_sizemathsqrtsqrt_att_head_sizerr4Denserr3rrr\r7attention_probs_dropout_probr9 is_decoderr/r:s r>r.z TFLayoutLMSelfAttention.__init__s "6"    : : :a ?#F$6$6#78''-'A'A&B!E  $*#=#= #&v'9'9Ftranspose_for_scoresz,TFLayoutLMSelfAttention.transpose_for_scoress;6*b$BZBZ\`\t\t1uv||F66r?c t|d} |j|} |du} | r||d} |d} |}n | rG|j|j|| } |j|j || } |}n|}|j|j|| } |j|j || } t j |d| gd} t j |d| gd} nD|j|j|| } |j|j || } |j| | }|jr| | f}t j|| d}t j|j|j}t j||}|t j||}t|d }|j|| }|t j ||}t j|| }t j"|gd  }t j$|| d |j&f}|r||fn|f}|jr||fz}|S)Nrrcr!rbr_T) transpose_bdtyperY)logitsr`rerrr)rrrrr\rLconcatrmatmulcastrrdivideaddrr9multiplyrrr)r; hidden_statesattention_mask head_maskencoder_hidden_statesencoder_attention_maskpast_key_valueoutput_attentionsrfrmixed_query_layeris_cross_attention key_layer value_layer query_layerattention_scoresdkattention_probsattention_outputoutputss r>ryzTFLayoutLMSelfAttention.callsy .q1  JJmJ< 3$> ."<&q)I(+K3N 11$((BW(2XZdeI33DJJF[J4\^hiK3N  '11$((-(2PR\]I33DJJmJ4TV`aK >!#4i"@qII))^A%6 $D1MK11$((-(2PR\]I33DJJmJ4TV`aK//0A:N ??(5N99[)N WWT,,4D4J4J K99%5r:  %!vv&6G )0@rJ,,o,Q   kk/9EO99_kB<<(8|L::-=jRTVZVhVhEij9J#_5QaPc ?? 11Gr?c|jryd|_t|dddtj|jj 5|jj dd|jjgdddt|dddtj|jj 5|jj dd|jjgdddt|ddetj|jj 5|jj dd|jjgdddyy#1swYxYw#1swYxYw#1swYyxYw)NTrrr\) rQrRrLrMrr)rSr/r0rr\rTs r>rSzTFLayoutLMSelfAttention.build5s9 ::  4$ ' 3tzz/ H   $dkk.E.E!FG H 4 % 1txx}}- FdDKK,C,CDE F 4$ ' 3tzz/ H   $dkk.E.E!FG H H 4  H H F F H Hs$ 3E*<3E6-3F*E36E?F rz)rrrrr~rF)rrrrrrrrrrrTuple[tf.Tensor]rr}rfr}r~rr{)rrrr.rryrSrrs@r>rrs87 O O"O O ) O !* O)O OO Ob Hr?rc2eZdZdfd ZdddZddZxZS)TFLayoutLMSelfOutputc xt|di|tjj |j t |jd|_tjj|jd|_ tjj|j|_||_yNdenserr&r'r*r,r-r.rr4rr0rr3rr5r6r&r7r8r9r/r:s r>r.zTFLayoutLMSelfOutput.__init__F "6"\\''$$IaIa9bip(  88AVAV]h8i||++1K1K+L  r?cz|j|}|j||}|j||z}|SNrcrerr9r&r;r input_tensorrfs r>ryzTFLayoutLMSelfOutput.callP? - 8  MH M ml.JK r?c"|jryd|_t|dddtj|jj 5|jj dd|jjgdddt|ddetj|jj 5|jj dd|jjgdddyy#1swY|xYw#1swYyxYwNTrr& rQrRrLrMrr)rSr/r0r&rTs r>rSzTFLayoutLMSelfOutput.buildW ::  4$ ' 3tzz/ H   $dkk.E.E!FG H 4d + 7t~~223 L$$dD$++2I2I%JK L L 8 H H L L 3C9<3D9DDrzrrrrrrfr}r~rr{rrrr.ryrSrrs@r>rrE Lr?rc\eZdZdfd ZdZ d ddZddZxZS) TFLayoutLMAttentionc lt|di|t|d|_t |d|_y)Nr;r)outputr,)r-r.rself_attentionr dense_outputr:s r>r.zTFLayoutLMAttention.__init__es1 "6"5f6J0hGr?ctr{NotImplementedError)r;headss r> prune_headszTFLayoutLMAttention.prune_headsks!!r?c x|j||||||||} |j| d||} | f| ddz} | S)Nrrrrrrrrfrrrrfr!)rr) r;rrrrrrrrf self_outputsrrs r>ryzTFLayoutLMAttention.callnso**&)"7#9)/+   ,,&q/ x- $% QR(88r?c|jryd|_t|ddMtj|jj 5|jj ddddt|ddNtj|jj 5|jj ddddyy#1swYexYw#1swYyxYw)NTrr)rQrRrLrMrr)rSrrTs r>rSzTFLayoutLMAttention.builds ::  4)4 0 <t22778 0##))$/ 0 4 . :t00556 .!!''- . . ; 0 0 . . C %C CC rzr)rrrrrrrrrrrrrr}rfr}r~rr{)rrrr.rryrSrrs@r>rrdsuH ""  )  !* )  : .r?rc0eZdZdfd ZddZddZxZS)TFLayoutLMIntermediatec Tt|di|tjj |j t |jd|_t|jtr"t|j|_ ||_y|j|_ ||_y)Nrrr,)r-r.rr4rintermediate_sizerr3r isinstance hidden_actstrr intermediate_act_fnr/r:s r>r.zTFLayoutLMIntermediate.__init__s "6"\\''**vOgOg?hov(   f'' -'89J9J'KD $ (.'8'8D $ r?cL|j|}|j|}|SNrc)rrr;rs r>ryzTFLayoutLMIntermediate.calls( - 8 00? r?c(|jryd|_t|ddetj|jj 5|jj dd|jjgdddyy#1swYyxYwNTr rQrRrLrMrr)rSr/r0rTs r>rSzTFLayoutLMIntermediate.build} ::  4$ ' 3tzz/ H   $dkk.E.E!FG H H 4 H H 3BBrzrrr~rr{rrs@r>rrs  Hr?rc2eZdZdfd ZdddZddZxZS)TFLayoutLMOutputc xt|di|tjj |j t |jd|_tjj|jd|_ tjj|j|_||_yrrr:s r>r.zTFLayoutLMOutput.__init__rr?cz|j|}|j||}|j||z}|Srrrs r>ryzTFLayoutLMOutput.callrr?c"|jryd|_t|dddtj|jj 5|jj dd|jjgdddt|ddetj|jj 5|jj dd|jjgdddyy#1swY|xYw#1swYyxYwr) rQrRrLrMrr)rSr/rr&r0rTs r>rSzTFLayoutLMOutput.builds ::  4$ ' 3tzz/ N   $dkk.K.K!LM N 4d + 7t~~223 L$$dD$++2I2I%JK L L 8 N N L Lrrzrrr{rrs@r>rrrr?rcVeZdZdfd Z d ddZddZxZS)TFLayoutLMLayerc Dt|di|t|d|_|j|_|j |_|j r,|jst |dt|d|_t|d|_ t|d|_ y)N attentionrz> should be used as a decoder model if cross attention is addedcrossattention intermediaterr,) r-r.rrradd_cross_attentionrrrrr bert_outputr:s r>r.zTFLayoutLMLayer.__init__s "6",V+F ++#)#=#=  # #?? D6)g!hii"5fCS"TD 26O+FBr?c ||ddnd} |j|||dd| ||} | d} |jr | dd} | d} n| dd} d}|jrV|Tt|dstd|d||d dnd}|j | |||||||}|d} | |ddz} |d} |z} |j | }|j || | }|f| z} |jr|  fz} | S) Nrb)rrrrrrrrfrr!rYrz'If `encoder_hidden_states` are passed, z` has to be instantiated with cross-attention layers by setting `config.add_cross_attention=True`rr)rrhasattrrrrr)r;rrrrrrrrfself_attn_past_key_valueself_attention_outputsrrpresent_key_valuecross_attn_present_key_valuecross_attn_past_key_valuecross_attention_outputsintermediate_output layer_outputs r>ryzTFLayoutLMLayer.calls:H9S>"1#5Y] !%&)"&#'3/"0 " 2!4 ??,Qr2G 6r : ,QR0G'+$ ??4@4!12 =dVDDD @N?Yrs(;_c %&*&9&9--#&;'=8"3!': ' # 7q9  7" ==G,C2+F ( 14P P "//>N/O''-rSzTFLayoutLMLayer.build*sZ ::  4d + 7t~~223 +$$T* + 4 . :t00556 .!!''- . 4 - 9t//445 -  &&t, - 4)4 0 <t22778 0##))$/ 0 0 = + + . . - - 0 0s0 E?%F ?FF$?F  FF!$F-rzr)rrrrrrrtf.Tensor | NonerrrzTuple[tf.Tensor] | Nonerr}rfr}r~rr{rrs@r>rrs{ C,E E"E E 0 E !1 E0E EE EN0r?rcbeZdZdfd Z d ddZddZxZS)TFLayoutLMEncoderc t|di|||_t|jDcgc]}t |d|c}|_ycc}w)Nzlayer_._rr,)r-r.r/rjnum_hidden_layersrlayer)r;r/r<ir=s r>r.zTFLayoutLMEncoder.__init__>sH "6" LQRXRjRjLklqofXaS>Bl lsAc | rdnd} |rdnd} |r|jjrdnd}|rdnd}t|jD]h\}}| r| |fz} |||nd}|||||||||| }|d}|r ||dfz }|s=| |dfz} |jjs]|`||dfz}j| r| |fz} | st d|| | |fDSt ||| | |S) Nr,rrrYr!rbc3&K|] }|| ywr{r,).0vs r> z)TFLayoutLMEncoder.call..usghgts)last_hidden_statepast_key_valuesr attentionscross_attentions)r/r enumeratertupler )r;rrrrrr" use_cacheroutput_hidden_states return_dictrfall_hidden_statesall_attentionsall_cross_attentionsnext_decoder_cacher layer_moduler layer_outputss r>ryzTFLayoutLMEncoder.callCsV#7BD0d%64;;;Z;Zr`d#,R$(4 VOA|#$58H$H!3B3N_Q/TXN(+-#A,&;'=-"3! M*!,M"}R'8&::" !/=3C2E!E;;227L7X+?=QRCSBU+U(1 V6 1]4D D )+rSzTFLayoutLMEncoder.buildsp ::  4$ ' 3 &]]5::.&KK%&& & 4&&s A..A7 rzr)rrrrrrrrrrr"zTuple[Tuple[tf.Tensor]] | Noner'Optional[bool]rr}r(r}r)r}rfr}r~zDUnion[TFBaseModelOutputWithPastAndCrossAttentions, Tuple[tf.Tensor]]r{rrs@r>rr=sm"<  < "<  < 0 < !1 < 8< "<  < #< < <  N< |&r?rc0eZdZdfd ZddZddZxZS)TFLayoutLMPoolerc t|di|tjj |j t |jdd|_||_ y)Ntanhr)rr activationr)r,) r-r.rr4rr0rr3rr/r:s r>r.zTFLayoutLMPooler.__init__sT "6"\\''$$.v/G/GH (   r?c<|dddf}|j|}|S)Nrrc)r)r;rfirst_token_tensor pooled_outputs r>ryzTFLayoutLMPooler.calls*+1a40 *< = r?c(|jryd|_t|ddetj|jj 5|jj dd|jjgdddyy#1swYyxYwrrrTs r>rSzTFLayoutLMPooler.buildrrrzrr{rrs@r>r3r3s Hr?r3c0eZdZdfd ZddZddZxZS)!TFLayoutLMPredictionHeadTransformc t|di|tjj |j t |jd|_t|jtrt|j|_ n|j|_ tjj|jd|_||_y)Nrrr&r'r,)r-r.rr4rr0rr3rrrrr transform_act_fnr5r6r&r/r:s r>r.z*TFLayoutLMPredictionHeadTransform.__init__s "6"\\''$$.v/G/GH(  f'' -$5f6G6G$HD !$*$5$5D !88AVAV]h8i r?cp|j|}|j|}|j|}|Sr)rr>r&rs r>ryz&TFLayoutLMPredictionHeadTransform.calls8 - 8 --m< m< r?c"|jryd|_t|dddtj|jj 5|jj dd|jjgdddt|ddetj|jj 5|jj dd|jjgdddyy#1swY|xYw#1swYyxYwrrrTs r>rSz'TFLayoutLMPredictionHeadTransform.buildrrrzrr{rrs@r>r<r<s" Lr?r<cPeZdZdfd Zd dZd dZd dZd dZd dZd dZ xZ S)TFLayoutLMLMPredictionHeadc t|di|||_|j|_t |d|_||_y)N transformrr,)r-r.r/r0r<rDinput_embeddingsr;r/rEr<r=s r>r.z#TFLayoutLMLMPredictionHead.__init__s@ "6" !--:6 T!1r?cX|j|jjfddd|_|jryd|_t |ddNt j|jj5|jjddddyy#1swYyxYw)NzerosTbias)rCrD trainabler)rD) rNr/rOrIrQrRrLrMrDr)rSrTs r>rSz TFLayoutLMLMPredictionHead.buildsOO4;;+A+A*CQXdhouOv ::  4d + 7t~~223 +$$T* + + 8 + +s :B  B)c|jSr{)rEr;s r>get_output_embeddingsz0TFLayoutLMLMPredictionHead.get_output_embeddingss$$$r?c`||j_t|d|j_yNr)rErBrrOr;r\s r>set_output_embeddingsz0TFLayoutLMLMPredictionHead.set_output_embeddingss(',$+5e+get_biasz#TFLayoutLMLMPredictionHead.get_biass ""r?cX|d|_t|dd|j_y)NrIr)rIrr/rOrPs r>set_biasz#TFLayoutLMLMPredictionHead.set_biass'&M !+E&M!:1!= r?c|j|}t|d}tj|d|jg}tj ||j jd}tj|d||jjg}tjj||j}|S)Nr r!rYrT)abr)r\rI) rDrrLrr0rrErBr/rOnnbias_addrI)r;r seq_lengths r>ryzTFLayoutLMLMPredictionHead.calls]C  .q1  -DDTDT?UV  MT5J5J5Q5Q_cd  -JPTP[P[PfPf?gh ]K r?r/r"rEkeras.layers.Layerr{r~r]r\z tf.Variable)r~zDict[str, tf.Variable]r) rrrr.rSrMrQrSrUryrrs@r>rBrBs' 1+%@#>r?rBc0eZdZdfd ZddZddZxZS)TFLayoutLMMLMHeadc Jt|di|t||d|_y)N predictionsrr,)r-r.rBrcrFs r>r.zTFLayoutLMMLMHead.__init__s& "6"5f>NUbcr?c*|j|}|S)Nr )rc)r;sequence_outputprediction_scoress r>ryzTFLayoutLMMLMHead.calls ,,?,K  r?c|jryd|_t|ddNtj|jj 5|jj ddddyy#1swYyxYw)NTrc)rQrRrLrMrcr)rSrTs r>rSzTFLayoutLMMLMHead.build sm ::  4 - 9t//445 -  &&t, - - : - - A11A:r\)rerr~rr{rrs@r>rarasd ! -r?raceZdZeZddfd Zd dZd dZdZe d d dZ d dZ xZ S)TFLayoutLMMainLayerc t|di|||_t|d|_t |d|_|rt|d|_yd|_y)NrFrencoderpoolerr,) r-r.r/r$rFrrlr3rm)r;r/add_pooling_layerr<r=s r>r.zTFLayoutLMMainLayer.__init__sN "6" .vLI(i@ AR&vH= X\ r?c|jSr{)rFrLs r>get_input_embeddingsz(TFLayoutLMMainLayer.get_input_embeddings"s r?c`||j_t|d|j_yrO)rFrBrrOrPs r>set_input_embeddingsz(TFLayoutLMMainLayer.set_input_embeddings%s$!&%/%6q%9"r?ct)z Prunes heads of the model. heads_to_prune: dict of {layer_num: list of heads to prune in this layer} See base class PreTrainedModel r)r;heads_to_prunes r> _prune_headsz TFLayoutLMMainLayer._prune_heads)s "!r?c | | td| t|}n|t|dd}n td|tj|d}|tj|d}|tj|dgzd}|j |||||| }tj ||ddd|df}tj ||j }tjd |j }tjd |j }tjtj|||}|tdg|jjz}|j||||ddd | | | | }|d}|j|j|nd}| s ||f|ddzSt!|||j"|j$|j&S)NzDYou cannot specify both input_ids and inputs_embeds at the same timerYz5You have to specify either input_ids or inputs_embedsr!rZrra)rlrmrnrorprfrg?gF) rrrrrr"r'rr(r)rfr )r! pooler_outputrr#r$)rrrLrhrFrrrconstantrsubtractrr/rrlrmr rr#r$)r;rlrmrrornrrprrrr(r)rfrUembedding_outputextended_attention_maskone_cstten_thousand_cstencoder_outputsrer9s r>ryzTFLayoutLMMainLayer.call0s "  ]%>cd d  "$Y/K  &$]3CR8KTU U  !WW+Q?N  !WW+Q?N <77 qc 1;D??%)' + #%**^k!naQRT_`aTb=c"d#%''*AIYI_I_"`++c)9)?)?@;;x7G7M7MN"$++bkk'CZ.[]m"n  % %!>!>>I,,*2"7#' /!5#'  *!,FJkkF] / Bcg  #$ $ >-')77&11,==   r?c|jryd|_t|ddMtj|jj 5|jj ddddt|ddMtj|jj 5|jj ddddt|ddNtj|jj 5|jj ddddyy#1swYxYw#1swYqxYw#1swYyxYw)NTrFrlrm) rQrRrLrMrFr)rSrlrmrTs r>rSzTFLayoutLMMainLayer.builds ::  4t , 8t334 ,%%d+ , 4D ) 5t||001 ) ""4( ) 44 ( 4t{{//0 ( !!$' ( ( 5  , , ) ) ( (s$ D%%D1?D=%D.1D:=E)T)r/r"rnr}r^r_ NNNNNNNNNNNNF)rlTFModelInputType | Nonermnp.ndarray | tf.Tensor | Nonerrrorrnrrrrprrrrrrr1r(r1r)r1rfr}r~GUnion[TFBaseModelOutputWithPoolingAndCrossAttentions, Tuple[tf.Tensor]]r{) rrrr" config_classr.rprrrurryrSrrs@r>rjrjs!L]:".2.28<8<6:377;?C@D,0/3&*c *c ,c 6 c 6 c 4 c 1c 5c  =c !>c *c -c $c c  Qc c J (r?rjc4eZdZdZeZdZefdZxZ S)TFLayoutLMPreTrainedModelz An abstract class to handle weights initialization and a simple interface for downloading and loading pretrained models. layoutlmcnt|}tjdtjd|d<|S)N)NNrarm)rCrr))r-input_signaturerL TensorSpecint32)r; signaturer=s r>rz)TFLayoutLMPreTrainedModel.input_signatures/G+ MMrxxV\] &r?) rrrrr"rbase_model_prefixpropertyrrrs@r>rrs' "L" r?raz This model inherits from [`TFPreTrainedModel`]. Check the superclass documentation for the generic methods the library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads etc.) This model is also a [keras.Model](https://www.tensorflow.org/api_docs/python/tf/keras/Model) subclass. Use it as a regular TF 2.0 Keras Model and refer to the TF 2.0 documentation for all matter related to general usage and behavior. TensorFlow models and layers in `transformers` accept two formats as input: - having all inputs as keyword arguments (like PyTorch models), or - having all inputs as a list, tuple or dict in the first positional argument. The reason the second format is supported is that Keras methods prefer this format when passing inputs to models and layers. Because of this support, when using methods like `model.fit()` things should "just work" for you - just pass your inputs and labels in any format that `model.fit()` supports! If, however, you want to use the second format outside of Keras methods like `fit()` and `predict()`, such as when creating your own layers or models with the Keras `Functional` API, there are three possibilities you can use to gather all the input Tensors in the first positional argument: - a single Tensor with `input_ids` only and nothing else: `model(input_ids)` - a list of varying length with one or several input Tensors IN THE ORDER given in the docstring: `model([input_ids, attention_mask])` or `model([input_ids, attention_mask, token_type_ids])` - a dictionary with one or several input Tensors associated to the input names given in the docstring: `model({"input_ids": input_ids, "token_type_ids": token_type_ids})` Note that when creating models and layers with [subclassing](https://keras.io/guides/making_new_layers_and_models_via_subclassing/) then you don't need to worry about any of this, as you can just pass inputs like you would to any other Python function! Args: config ([`LayoutLMConfig`]): Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the [`~TFPreTrainedModel.from_pretrained`] method to load the model weights. a Args: input_ids (`Numpy array` or `tf.Tensor` of shape `({0})`): Indices of input sequence tokens in the vocabulary. Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.__call__`] and [`PreTrainedTokenizer.encode`] for details. [What are input IDs?](../glossary#input-ids) bbox (`Numpy array` or `tf.Tensor` of shape `({0}, 4)`, *optional*): Bounding Boxes of each input sequence tokens. Selected in the range `[0, config.max_2d_position_embeddings- 1]`. attention_mask (`Numpy array` or `tf.Tensor` of shape `({0})`, *optional*): Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`: - 1 for tokens that are **not masked**, - 0 for tokens that are **masked**. [What are attention masks?](../glossary#attention-mask) token_type_ids (`Numpy array` or `tf.Tensor` of shape `({0})`, *optional*): Segment token indices to indicate first and second portions of the inputs. Indices are selected in `[0, 1]`: - 0 corresponds to a *sentence A* token, - 1 corresponds to a *sentence B* token. [What are token type IDs?](../glossary#token-type-ids) position_ids (`Numpy array` or `tf.Tensor` of shape `({0})`, *optional*): Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0, config.max_position_embeddings - 1]`. [What are position IDs?](../glossary#position-ids) head_mask (`Numpy array` or `tf.Tensor` of shape `(num_heads,)` or `(num_layers, num_heads)`, *optional*): Mask to nullify selected heads of the self-attention modules. Mask values selected in `[0, 1]`: - 1 indicates the head is **not masked**, - 0 indicates the head is **masked**. inputs_embeds (`tf.Tensor` of shape `({0}, hidden_size)`, *optional*): Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This is useful if you want more control over how to convert `input_ids` indices into associated vectors than the model's internal embedding lookup matrix. output_attentions (`bool`, *optional*): Whether or not to return the attentions tensors of all attention layers. See `attentions` under returned tensors for more detail. output_hidden_states (`bool`, *optional*): Whether or not to return the hidden states of all layers. See `hidden_states` under returned tensors for more detail. return_dict (`bool`, *optional*): Whether or not to return a [`~utils.ModelOutput`] instead of a plain tuple. training (`bool`, *optional*, defaults to `False`): Whether or not to use the model in training mode (some modules like dropout modules have different behaviors between training and evaluation). zbThe bare LayoutLM Model transformer outputting raw hidden-states without any specific head on top.ceZdZdfd Zeeejdee e  d ddZ d dZ xZ S) TFLayoutLMModelcPt||g|i|t|d|_y)Nrr)r-r.rjrr;r/rdr<r=s r>r.zTFLayoutLMModel.__init__s( 3&3F3+FD r?batch_size, sequence_length output_typerc >|j|||||||| | | |  }|S)a  Returns: Examples: ```python >>> from transformers import AutoTokenizer, TFLayoutLMModel >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("microsoft/layoutlm-base-uncased") >>> model = TFLayoutLMModel.from_pretrained("microsoft/layoutlm-base-uncased") >>> words = ["Hello", "world"] >>> normalized_word_boxes = [637, 773, 693, 782], [698, 773, 733, 782] >>> token_boxes = [] >>> for word, box in zip(words, normalized_word_boxes): ... word_tokens = tokenizer.tokenize(word) ... token_boxes.extend([box] * len(word_tokens)) >>> # add bounding boxes of cls + sep tokens >>> token_boxes = [[0, 0, 0, 0]] + token_boxes + [[1000, 1000, 1000, 1000]] >>> encoding = tokenizer(" ".join(words), return_tensors="tf") >>> input_ids = encoding["input_ids"] >>> attention_mask = encoding["attention_mask"] >>> token_type_ids = encoding["token_type_ids"] >>> bbox = tf.convert_to_tensor([token_boxes]) >>> outputs = model( ... input_ids=input_ids, bbox=bbox, attention_mask=attention_mask, token_type_ids=token_type_ids ... ) >>> last_hidden_states = outputs.last_hidden_state ``` rlrmrrornrrprr(r)rf)r)r;rlrmrrornrrprrrr(r)rfrs r>ryzTFLayoutLMModel.call!s@n--))%'/!5#  r?c|jryd|_t|ddNtj|jj 5|jj ddddyy#1swYyxYw)NTr)rQrRrLrMrr)rSrTs r>rSzTFLayoutLMModel.buildhsi ::  4T * 6t}}112 * ##D) * * 7 * *rhrzr)rlrrmrrrrorrnrrrrprrrrrrr1r(r1r)r1rfr1r~rr{)rrrr.rrLAYOUTLM_INPUTS_DOCSTRINGformatr r _CONFIG_FOR_DOCryrSrrs@r>rrs E *+D+K+KLi+jkBQ` .2.28<8<6:377;?C@D,0/3&*#(@*@,@6 @ 6 @ 4 @1@5@ =@!>@*@-@$@!@ Q@l @D*r?rz6LayoutLM Model with a `language modeling` head on top.ceZdZgdZd fd Zd dZd dZeee jde e e  d d dZddZxZS)TFLayoutLMForMaskedLM)rmcls.seq_relationshipzcls.predictions.decoder.weight nsp___clsct||g|i||jrtj dt |dd|_t||j jd|_ y)NzqIf you want to use `TFLayoutLMForMaskedLM` make sure `config.is_decoder=False` for bi-directional self-attention.Trrnr) mlm___cls)rEr)) r-r.rloggerwarningrjrrarFmlmrs r>r.zTFLayoutLMForMaskedLM.__init__{sb 3&3F3    NN1  ,FdQ[\ $Vdmm>V>V]hir?c.|jjSr{)rrcrLs r> get_lm_headz!TFLayoutLMForMaskedLM.get_lm_headsxx###r?ctjdt|jdz|jjzdz|jj jzS)NzMThe method get_prefix_bias_name is deprecated. Please use `get_bias` instead./)warningswarn FutureWarningr)rrcrLs r>get_prefix_bias_namez*TFLayoutLMForMaskedLM.get_prefix_bias_namesG egtuyy3.4txx7K7K7P7PPPr?rrc |j||||||||| | |  } | d}|j|| }| dn|j| |}| s|f| ddz}||f|zS|St||| j| j S)aV labels (`tf.Tensor` or `np.ndarray` of shape `(batch_size, sequence_length)`, *optional*): Labels for computing the masked language modeling loss. Indices should be in `[-100, 0, ..., config.vocab_size]` (see `input_ids` docstring) Tokens with indices set to `-100` are ignored (masked), the loss is only computed for the tokens with labels in `[0, ..., config.vocab_size]` Returns: Examples: ```python >>> from transformers import AutoTokenizer, TFLayoutLMForMaskedLM >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("microsoft/layoutlm-base-uncased") >>> model = TFLayoutLMForMaskedLM.from_pretrained("microsoft/layoutlm-base-uncased") >>> words = ["Hello", "[MASK]"] >>> normalized_word_boxes = [637, 773, 693, 782], [698, 773, 733, 782] >>> token_boxes = [] >>> for word, box in zip(words, normalized_word_boxes): ... word_tokens = tokenizer.tokenize(word) ... token_boxes.extend([box] * len(word_tokens)) >>> # add bounding boxes of cls + sep tokens >>> token_boxes = [[0, 0, 0, 0]] + token_boxes + [[1000, 1000, 1000, 1000]] >>> encoding = tokenizer(" ".join(words), return_tensors="tf") >>> input_ids = encoding["input_ids"] >>> attention_mask = encoding["attention_mask"] >>> token_type_ids = encoding["token_type_ids"] >>> bbox = tf.convert_to_tensor([token_boxes]) >>> labels = tokenizer("Hello world", return_tensors="tf")["input_ids"] >>> outputs = model( ... input_ids=input_ids, ... bbox=bbox, ... attention_mask=attention_mask, ... token_type_ids=token_type_ids, ... labels=labels, ... ) >>> loss = outputs.loss ```rr)rerfNlabelsrrblossrrr#)rrhf_compute_lossr rr#)r;rlrmrrornrrprr(r)rrfrrerfrrs r>ryzTFLayoutLMForMaskedLM.calls~--))%'/!5#  "!* HH_xHX~t4+?+?vVg+?+h')GABK7F)-)9TGf$ Ev E$!//))   r?c|jryd|_t|ddMtj|jj 5|jj ddddt|ddNtj|jj 5|jj ddddyy#1swYexYw#1swYyxYw)NTrr)rQrRrLrMrr)rSrrTs r>rSzTFLayoutLMForMaskedLM.builds ::  4T * 6t}}112 * ##D) * 4 % 1txx}}- %t$ % % 2 * * % %rrzr^)r~r NNNNNNNNNNNF)rlrrmrrrrorrnrrrrprrr1r(r1r)r1rrrfr1r~z)Union[TFMaskedLMOutput, Tuple[tf.Tensor]]r{)rrr"_keys_to_ignore_on_load_unexpectedr.rrrrrrr r rryrSrrs@r>rrqs*& j$Q*+D+K+KLi+jk+;/Z.2.28<8<6:377;,0/3&*04#(V *V ,V 6 V 6 V 4 V 1V 5V *V -V $V .V !V  3V [lV p %r?rz LayoutLM Model transformer with a sequence classification/regression head on top (a linear layer on top of the pooled output) e.g. for GLUE tasks. ceZdZgdZdgZdfd Zeeejde e e  d d dZ d dZxZS) #TFLayoutLMForSequenceClassification)rrcls.predictionsrr9cft||g|i||j|_t|d|_t j j|j|_ t j j|jt|jd|_ ||_y)Nrrr* classifierrr-r. num_labelsrjrrr4r7r8r9rrr3rr/rs r>r.z,TFLayoutLMForSequenceClassification.__init__s 3&3F3 +++FD ||++1K1K+L ,,,,##.v/G/GH-   r?rrc ,|j||||||||| | |  } | d}|j|| }|j|}| dn|j| |}| s|f| ddz}||f|zS|St ||| j | j S) an labels (`tf.Tensor` or `np.ndarray` of shape `(batch_size,)`, *optional*): Labels for computing the sequence classification/regression loss. Indices should be in `[0, ..., config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If `config.num_labels > 1` a classification loss is computed (Cross-Entropy). Returns: Examples: ```python >>> from transformers import AutoTokenizer, TFLayoutLMForSequenceClassification >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("microsoft/layoutlm-base-uncased") >>> model = TFLayoutLMForSequenceClassification.from_pretrained("microsoft/layoutlm-base-uncased") >>> words = ["Hello", "world"] >>> normalized_word_boxes = [637, 773, 693, 782], [698, 773, 733, 782] >>> token_boxes = [] >>> for word, box in zip(words, normalized_word_boxes): ... word_tokens = tokenizer.tokenize(word) ... token_boxes.extend([box] * len(word_tokens)) >>> # add bounding boxes of cls + sep tokens >>> token_boxes = [[0, 0, 0, 0]] + token_boxes + [[1000, 1000, 1000, 1000]] >>> encoding = tokenizer(" ".join(words), return_tensors="tf") >>> input_ids = encoding["input_ids"] >>> attention_mask = encoding["attention_mask"] >>> token_type_ids = encoding["token_type_ids"] >>> bbox = tf.convert_to_tensor([token_boxes]) >>> sequence_label = tf.convert_to_tensor([1]) >>> outputs = model( ... input_ids=input_ids, ... bbox=bbox, ... attention_mask=attention_mask, ... token_type_ids=token_type_ids, ... labels=sequence_label, ... ) >>> loss = outputs.loss >>> logits = outputs.logits ```rr!rercNrrbr)rr9rrrrr#)r;rlrmrrornrrprr(r)rrfrr9rrrs r>ryz(TFLayoutLMForSequenceClassification.calls~--))%'/!5#     MH M  6~t4+?+?vV\+?+]Y,F)-)9TGf$ Ev E)!//))   r?c|jryd|_t|ddMtj|jj 5|jj ddddt|ddetj|jj 5|jj dd|jjgdddyy#1swY|xYw#1swYyxYwNTrr rQrRrLrMrr)rSrr/r0rTs r>rSz)TFLayoutLMForSequenceClassification.buildk ::  4T * 6t}}112 * ##D) * 4t , 8t334 M%%tT4;;3J3J&KL M M 9 * * M M C"%3C."C+.C7rzr)rlrrmrrrrorrnrrrrprrr1r(r1r)r1rrrfr1r~z3Union[TFSequenceClassifierOutput, Tuple[tf.Tensor]]r{)rrrr_keys_to_ignore_on_load_missingr.rrrrr rrryrSrrs@r>rrs*s&'1l# *+D+K+KLi+jk+ETcd.2.28<8<6:377;,0/3&*04#(W *W ,W 6 W 6 W 4 W 1W 5W *W -W $W .W !W  =W elW r Mr?rz LayoutLM Model with a token classification head on top (a linear layer on top of the hidden-states output) e.g. for Named-Entity-Recognition (NER) tasks. ceZdZgdZdgZdfd Zeeejde e e  d d dZ d dZxZS) TFLayoutLMForTokenClassificationrmrrrrr9cht||g|i||j|_t|dd|_t j j|j|_ t j j|jt|jd|_ ||_y)NTrrr*rrrrs r>r.z)TFLayoutLMForTokenClassification.__init__s 3&3F3 +++FdQ[\ ||++1K1K+L ,,,,##.v/G/GH-   r?rrc ,|j||||||||| | |  } | d}|j|| }|j|}| dn|j| |}| s|f| ddz}||f|zS|St ||| j | j S) a labels (`tf.Tensor` or `np.ndarray` of shape `(batch_size, sequence_length)`, *optional*): Labels for computing the token classification loss. Indices should be in `[0, ..., config.num_labels - 1]`. Returns: Examples: ```python >>> import tensorflow as tf >>> from transformers import AutoTokenizer, TFLayoutLMForTokenClassification >>> tokenizer = AutoTokenizer.from_pretrained("microsoft/layoutlm-base-uncased") >>> model = TFLayoutLMForTokenClassification.from_pretrained("microsoft/layoutlm-base-uncased") >>> words = ["Hello", "world"] >>> normalized_word_boxes = [637, 773, 693, 782], [698, 773, 733, 782] >>> token_boxes = [] >>> for word, box in zip(words, normalized_word_boxes): ... word_tokens = tokenizer.tokenize(word) ... token_boxes.extend([box] * len(word_tokens)) >>> # add bounding boxes of cls + sep tokens >>> token_boxes = [[0, 0, 0, 0]] + token_boxes + [[1000, 1000, 1000, 1000]] >>> encoding = tokenizer(" ".join(words), return_tensors="tf") >>> input_ids = encoding["input_ids"] >>> attention_mask = encoding["attention_mask"] >>> token_type_ids = encoding["token_type_ids"] >>> bbox = tf.convert_to_tensor([token_boxes]) >>> token_labels = tf.convert_to_tensor([1, 1, 0, 0]) >>> outputs = model( ... input_ids=input_ids, ... bbox=bbox, ... attention_mask=attention_mask, ... token_type_ids=token_type_ids, ... labels=token_labels, ... ) >>> loss = outputs.loss >>> logits = outputs.logits ```rrrercNrrbr)rr9rrrrr#)r;rlrmrrornrrprr(r)rrfrrerrrs r>ryz%TFLayoutLMForTokenClassification.callsz--))%'/!5#  "!*,,o,Q8~t4+?+?vV\+?+]Y,F)-)9TGf$ Ev E&!//))   r?c|jryd|_t|ddMtj|jj 5|jj ddddt|ddetj|jj 5|jj dd|jjgdddyy#1swY|xYw#1swYyxYwrrrTs r>rSz&TFLayoutLMForTokenClassification.buildrrrzr)rlrrmrrrrorrnrrrrprrr1r(r1r)r1rrrfr1r~z0Union[TFTokenClassifierOutput, Tuple[tf.Tensor]]r{)rrrrrr.rrrrr rrryrSrrs@r>rrws*&(2l# *+D+K+KLi+jk+BQ`a.2.28<8<6:377;,0/3&*04#(U *U ,U 6 U 6 U 4 U 1U 5U *U -U $U .U !U  :U blU n Mr?ra LayoutLM Model with a span classification head on top for extractive question-answering tasks such as [DocVQA](https://rrc.cvc.uab.es/?ch=17) (a linear layer on top of the final hidden-states output to compute `span start logits` and `span end logits`). ceZdZgdZdfd Zeeejde e e  d d dZ d dZ xZS) TFLayoutLMForQuestionAnsweringrc t||g|i||j|_t|dd|_t j j|jt|jd|_ ||_ y)NTrr qa_outputsr) r-r.rrjrrr4rrr3rr/rs r>r.z'TFLayoutLMForQuestionAnswering.__init__sv 3&3F3 +++FdQ[\ ,,,,##.v/G/GH-   r?rrc |j||||||||| | |  }|d}|j|}tj|dd\}}tj|d}tj|d}d}| | d | i}| |d <|j |||f }| s||f|ddz}||f|zS|St ||||j|j S) a start_positions (`tf.Tensor` or `np.ndarray` of shape `(batch_size,)`, *optional*): Labels for position (index) of the start of the labelled span for computing the token classification loss. Positions are clamped to the length of the sequence (`sequence_length`). Position outside of the sequence are not taken into account for computing the loss. end_positions (`tf.Tensor` or `np.ndarray` of shape `(batch_size,)`, *optional*): Labels for position (index) of the end of the labelled span for computing the token classification loss. Positions are clamped to the length of the sequence (`sequence_length`). Position outside of the sequence are not taken into account for computing the loss. Returns: Examples: ```python >>> import tensorflow as tf >>> from transformers import AutoTokenizer, TFLayoutLMForQuestionAnswering >>> from datasets import load_dataset >>> tokenizer = AutoTokenizer.from_pretrained("impira/layoutlm-document-qa", add_prefix_space=True) >>> model = TFLayoutLMForQuestionAnswering.from_pretrained("impira/layoutlm-document-qa", revision="1e3ebac") >>> dataset = load_dataset("nielsr/funsd", split="train", trust_remote_code=True) >>> example = dataset[0] >>> question = "what's his name?" >>> words = example["words"] >>> boxes = example["bboxes"] >>> encoding = tokenizer( ... question.split(), words, is_split_into_words=True, return_token_type_ids=True, return_tensors="tf" ... ) >>> bbox = [] >>> for i, s, w in zip(encoding.input_ids[0], encoding.sequence_ids(0), encoding.word_ids(0)): ... if s == 1: ... bbox.append(boxes[w]) ... elif i == tokenizer.sep_token_id: ... bbox.append([1000] * 4) ... else: ... bbox.append([0] * 4) >>> encoding["bbox"] = tf.convert_to_tensor([bbox]) >>> word_ids = encoding.word_ids(0) >>> outputs = model(**encoding) >>> loss = outputs.loss >>> start_scores = outputs.start_logits >>> end_scores = outputs.end_logits >>> start, end = word_ids[tf.math.argmax(start_scores, -1)[0]], word_ids[tf.math.argmax(end_scores, -1)[0]] >>> print(" ".join(words[start : end + 1])) M. Hamann P. Harper, P. Martinez ```rrrcrbrY)r\num_or_size_splitsr`)inputr`Nstart_position end_positionr)r start_logits end_logitsrr#) rrrLsplitsqueezerr rr#)r;rlrmrrornrrprr(r)start_positions end_positionsrfrrerrrrrrs r>ryz#TFLayoutLMForQuestionAnswering.calls!L--))%'/!5#  "!*8#%88&QUW#X jzz 2> ZZjr:   &=+D&8F%2F> "''v|Z>X'YD"J/'!"+=F)-)9TGf$ Ev E-%!!//))   r?c|jryd|_t|ddMtj|jj 5|jj ddddt|ddetj|jj 5|jj dd|jjgdddyy#1swY|xYw#1swYyxYw)NTrr) rQrRrLrMrr)rSrr/r0rTs r>rSz$TFLayoutLMForQuestionAnswering.buildrrrzr)rlrrmrrrrorrnrrrrprrr1r(r1r)r1rrrrrfr1r~z7Union[TFQuestionAnsweringModelOutput, Tuple[tf.Tensor]]r{)rrrrr.rrrrr r rryrSrrs@r>rrs*& *+D+K+KLi+jk+IXgh.2.28<8<6:377;,0/3&*9=7;#(h *h ,h 6 h 6 h 4 h 1h 5h *h -h $h 7h 5h !h  Ah ilh T Mr?r)rrrrrjrr)Ir __future__rrrtypingrrrrnumpynp tensorflowrLactivations_tfr modeling_tf_outputsr r r r rrmodeling_tf_utilsrrrrrrrrrrtf_utilsrrrutilsrrrr configuration_layoutlmr" get_loggerrrrr4Layerr$rrrrrrrr3r<rBrarjrLAYOUTLM_START_DOCSTRINGrrrrrr__all__r,r?r>rs" ///   SRtt2   H %"C 5<<--C NAHell00AHJL5<<--L>0.%,,,,0.hHU\\//H<Lu||))L>d0ell((d0PK& **K&^Hu||))H<"L (:(:"LL-!3!3-b- **-(L(%,,,,L(L(^  1  (T5phS*/S* S*lRTlm@%57S@%n@%F xM*CEaxMxMv |M'@B[|M|M~  LM%>@WLMLM^ r?