
    Z j\                       S r SSKrSSKrSSKJr  SSKJr  SSKJr  SSKrSSKJ	r	  SSK
Jr  SS	KJr  SS
KJr  SSKJrJr  SSKJr  SSKJr  SSKJrJrJrJrJrJr  SSKJ r J!r!J"r"J#r#J$r$  \RJ                  " \&5      r'Sr(Sr)Sr*\$\"-  \#-  r+\\" SS9 " S S\5      5       5       r,\" SS9\ " S S\5      5       5       r-\\" SS9 " S S\5      5       5       r. " S S\	R^                  5      r0 " S S \	R^                  5      r1 " S! S"\	R^                  5      r2 " S# S$\	R^                  5      r3 " S% S&\	R^                  5      r4 " S' S(\	R^                  5      r5 " S) S*\	R^                  5      r6 " S+ S,\	R^                  5      r7 " S- S.\5      r8 " S/ S0\	R^                  5      r9 " S1 S2\	R^                  5      r:\ " S3 S4\5      5       r;\ " S5 S6\;5      5       r<\ " S7 S8\;5      5       r=\ " S9 S:\;5      5       r>\ " S; S<\;5      5       r? " S= S>\	R^                  5      r@ " S? S@\	R^                  5      rA " SA SB\	R^                  5      rB\" SCS9 " SD SE\;5      5       rC " SF SG\	R^                  5      rD " SH SI\	R^                  5      rE " SJ SK\	R^                  5      rF " SL SM\	R^                  5      rG\" SNS9 " SO SP\;5      5       rH/ SQQrIg)RzPyTorch FLAVA model.    N)OrderedDict)	dataclass)Any)nn   )initialization)ACT2FN)GradientCheckpointingLayer)BaseModelOutputBaseModelOutputWithPooling)PreTrainedModel)Unpack)ModelOutputTransformersKwargsauto_docstringcan_return_tuplelogging	torch_int   )FlavaConfigFlavaImageCodebookConfigFlavaImageConfigFlavaMultimodalConfigFlavaTextConfigzfacebook/flava-image-codebookg$(~k@a  
    Output from FlavaModel containing embeddings and outputs from individual encoders.

    Note that `image_embeddings` and `text_embeddigns` returned are similar to pooled output returned from a
    transformer. If you want embeddings for contrastive loss or retrieval use a FLAVA model's `image_projection` and
    `text_projection` layers on `image_embeddings` and `text_embeddings` respectively.
    )custom_introc                       \ rS rSr% SrSr\R                  S-  \S'   Sr	\
S-  \S'   Sr\R                  S-  \S'   Sr\
S-  \S'   Sr\R                  S-  \S'   Sr\
S-  \S	'   S
\\   4S jrSrg)FlavaModelOutput3   a  
image_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `pixel_values` are present):
    The image embeddings which are basically the pooled output of [`FlavaImageModel`].
image_output (`BaseModelOutputWithPooling`, *optional*, returned when `pixel_values` are present):
    The output of the [`FlavaImageModel`].
text_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `input_ids` are present):
    The text embeddings which are basically the pooled output of [`FlavaTextModel`].
text_output (`BaseModelOutputWithPooling`, *optional*, returned when `input_ids` are present):
    The output of the [`FlavaTextModel`].
multimodal_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `input_ids` and `pixel_values` are present and `skip_multimodal_encoder` is `None` or `False`):
    The multimodal embeddings which are basically the pooled output of [`FlavaTextModel`].
multimodal_output (`BaseModelOutputWithPooling`, returned when `input_ids` and `pixel_values` are present and `skip_multimodal_encoder` is `None` or `False`):
    The output of the [`FlavaMultimodalModel`].
Nimage_embeddingsimage_outputtext_embeddingstext_outputmultimodal_embeddingsmultimodal_outputreturnc                 J   ^  [        U 4S jT R                  5        5       5      $ )Nc              3   n   >#    U  H*  nUS ;  a  TU   O[        TU5      R                  5       v   M,     g7f))r"   r    r$   Ngetattrto_tuple).0kselfs     y/root/GenerationalWealth/GenerationalWealth/venv/lib/python3.13/site-packages/transformers/models/flava/modeling_flava.py	<genexpr>,FlavaModelOutput.to_tuple.<locals>.<genexpr>U   s<      
   TTDGZabfhiZjZsZsZuu s   25tuplekeysr-   s   `r.   r*   FlavaModelOutput.to_tupleT   s#     
YY[
 
 	
     )__name__
__module____qualname____firstlineno____doc__r   torchFloatTensor__annotations__r    r   r!   r"   r#   r$   r2   r   r*   __static_attributes__r7   r6   r.   r   r   3   s     26e''$.56:L,t3:04OU&&-459K+d296:5,,t3:;?1D8?
%* 
r6   r   z@
    Class representing pretraining losses from FLAVA model
    c                      \ rS rSr% SrSr\R                  S-  \S'   Sr	\R                  S-  \S'   Sr
\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S	'   S
\4S jrSrg)FlavaLosses[   as  
mim (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `mim_labels` and `pixel_values` are present, `input_ids_masked` is absent and `mim_weight` > 0.):
    Masked Image Modeling loss as used in BeIT calculated only for unimodal image data.
mlm (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `mlm_labels` and `input_ids_masked` are present, `pixel_values` is absent and `mlm_weight` > 0.):
    Masked Language Modeling loss as used in BERT calculated only for unimodal text data.
itm (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `itm_labels`, `input_ids_masked`, `pixel_values` are present and `itm_weight` > 0.):
    Image Text Matching (ITM) loss calculated for paired image-text data. Note that ITM loss is calculated on
    masked pairs in FLAVA.
global_contrastive (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `input_ids` and `pixel_values` are present and `global_contrastive_weight` > 0.):
    Contrastive loss for image-text similarity similar to CLIP but calculated globally for paired image-text
    data. This is calculated on unmasked images and texts.
mmm_image (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `mim_labels`, `pixel_values` and `input_ids_masked` are present and `mmm_image_weight` > 0.):
    Masked Multimodal Modeling loss's image component calculated on paired image-text data.
mmm_text (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `mlm_labels`, `pixel_values` and `input_ids_masked` are present and `mmm_text_weight` > 0.):
    Masked Multimodal Modeling loss's text component calculated on paired image-text data.
Nmimmlmitmglobal_contrastive	mmm_imagemmm_textr%   c                 H    SnU R                  5        H  nUc  M  Sn  U$    U$ )NTF)values)r-   all_nonevs      r.   rL   FlavaLosses.all_nonez   s0    A} 	  r6   r7   )r8   r9   r:   r;   r<   rD   r=   r>   r?   rE   rF   rG   rH   rI   boolrL   r@   r7   r6   r.   rB   rB   [   s    " %)C		T	!($(C		T	!($(C		T	!(37))D07*.Iu  4'.)-He$&-$ r6   rB   a  
    Output from FlavaForPreTraining containing embeddings, and outputs from individual encoders.

    Note that `image_embeddings` and `text_embeddings` returned are similar to pooled output returned from a
    transformer. If you want embeddings for contrastive loss or retrieval use a FLAVA model's `image_projection` and
    `text_projection` layers on `image_embeddings` and `text_embeddings` respectively.
    c                      \ rS rSr% SrSr\R                  S-  \S'   Sr	\
\S'   Sr\R                  S-  \S'   Sr\S-  \S'   Sr\R                  S-  \S'   Sr\S-  \S	'   Sr\R                  S-  \S
'   Sr\S-  \S'   Sr\R                  S-  \S'   Sr\S-  \S'   Sr\R                  S-  \S'   Sr\S-  \S'   Sr\R                  S-  \S'   Sr\S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   Sr\R                  S-  \S'   S\\    4S jr!Sr"g)FlavaForPreTrainingOutput   a  
loss (`torch.FloatTensor`, *optional*, returned when `return_loss` is True):
    Total loss calculated for this model.
loss_info (`FlavaLosses`):
    Detailed info for FLAVA Pretraining losses. Check `FlavaLosses` class description for the information on
    the keys.
image_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `pixel_values` are present):
    The image embeddings which are basically the pooled output of [`FlavaImageModel`].
image_output (`BaseModelOutputWithPooling`, *optional*, returned when `pixel_values` are present):
    The output of the [`FlavaImageModel`].
text_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `input_ids` are present):
    The text embeddings which are basically the pooled output of [`FlavaTextModel`].
text_output (`BaseModelOutputWithPooling`, *optional*, returned when `input_ids` are present):
    The output of the [`FlavaTextModel`].
multimodal_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `input_ids` and `pixel_values` are present and `skip_unmasked_multimodal_encoder` is `None` or `False`):
    The multimodal embeddings which are basically the pooled output of [`FlavaTextModel`].
multimodal_output (`BaseModelOutputWithPooling`, returned when `input_ids` and `pixel_values` are present and `skip_unmasked_multimodal_encoder` is `None` or `False`):
    The output of the [`FlavaMultimodalModel`].
image_masked_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `pixel_values` are present):
    The image embeddings which are basically the pooled output of [`FlavaImageModel`]. Uses `bool_masked_pos`
    to create masked images.
image_masked_output (`BaseModelOutputWithPooling`, *optional*, returned when `pixel_values` are present):
    The output of the [`FlavaImageModel`]. Uses `bool_masked_pos` to create masked images.
text_masked_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `input_ids_masked` are present):
    The text embeddings which are basically the pooled output of [`FlavaTextModel`].
text_masked_output (`BaseModelOutputWithPooling`, *optional*, returned when `input_ids_masked` are present):
    The output of the [`FlavaTextModel`].
multimodal_masked_embeddings (`torch.FloatTensor` of shape `(batch_size, output_dim)`, *optional*, returned when `input_ids` and `pixel_values` are present):
    The multimodal embeddings which are basically the pooled output of [`FlavaTextModel`].
multimodal_masked_output (`BaseModelOutputWithPooling`, *optional*, returned when `input_ids_masked` and `pixel_values` are present):
    The output of the [`FlavaMultimodalModel`].
mim_logits (`torch.FloatTensor` of shape `(batch_size, num_image_patches, image_vocab_size)` or of shape `(total_masked_patches, image_vocab_size)` , *optional*, returned when `pixel_values` are present and `input_ids_masked` are not):
    The logits for MIM unimodal loss. Uses `book_masked_pos` to get masked patches. The flattened output is
        returned when `bool_masked_pos` has some of the patches masked.
mlm_logits (`torch.FloatTensor` of shape `(batch_size, text_seq_length, text_vocab_size)` or of shape `(total_masked_seq_length, text_vocab_size)`, *optional*, returned when `input_ids_masked` are present and `pixel_values` are not):
    The logits for MLM unimodal loss. The flattened output is returned when `input_ids_masked` has some of
        the tokens masked.
itm_logits (`torch.FloatTensor` of shape `(batch_size, 2)`, *optional*, returned when `input_ids_masked` and `pixel_values` are present):
    The logits for ITM loss. Note that ITM loss is calculated on masked pairs in FLAVA.
contrastive_logits_per_image (`torch.FloatTensor` of shape `(image_batch_size, text_batch_size)`):
    The scaled dot product scores between `image_embeddings` and `text_embeddings` but passed through FLAVA's
    `image_projection` and `text_projection` layers respectively. This represents the image-text similarity
    scores. This is calculated on unmasked images and texts.
contrastive_logits_per_text (`torch.FloatTensor` of shape `(text_batch_size, image_batch_size)`):
    The scaled dot product scores between `text_embeddings` and `image_embeddings` but passed through FLAVA's
    `text_projection` and `image_projection` layers respectively. This is calculated on unmasked images and
    texts.
mmm_image_logits (`torch.FloatTensor` of shape `(batch_size, num_image_patches, image_vocab_size)` or of shape`(total_masked_patches, image_vocab_size)`, *optional*, returned when `pixel_values` and `input_ids_masked` are present):
    The logits for MMM image multimodal loss. Uses `book_masked_pos` to get masked patches. The flattened
        output is returned when `bool_masked_pos` has some of the patches masked.
mmm_text_logits (`torch.FloatTensor` of shape `(batch_size, text_seq_length, text_vocab_size)` or of shape `(`(total_masked_seq_length, text_vocab_size)`), *optional*, returned when `pixel_values` and `input_ids_masked` are present):
    The logits for MMM text multimodal loss. The flattened output is returned when `input_ids_masked` has
        some of the tokens masked.
Nloss	loss_infor   r    r!   r"   r#   r$   image_masked_embeddingsimage_masked_outputtext_masked_embeddingstext_masked_outputmultimodal_masked_embeddingsmultimodal_masked_output
mim_logits
mlm_logits
itm_logitscontrastive_logits_per_imagecontrastive_logits_per_textmmm_image_logitsmmm_text_logitsr%   c                 V   ^ ^ / SQm[        U U4S jT R                  5        5       5      $ )N)r"   r    r$   rX   rV   rZ   c              3   l   >#    U  H)  oT;  a  TU   O[        TU5      R                  5       v   M+     g 7fNr(   )r+   r,   r-   transformer_outputss     r.   r/   5FlavaForPreTrainingOutput.to_tuple.<locals>.<genexpr>   s4     sgrbc)< <T!W'$PQBRB[B[B]]grs   14r1   )r-   re   s   `@r.   r*   "FlavaForPreTrainingOutput.to_tuple   s(    
 sgkgpgpgrsssr6   r7   )#r8   r9   r:   r;   r<   rS   r=   r>   r?   rT   rB   r   r    r   r!   r"   r#   r$   rU   rV   rW   rX   rY   rZ   r[   r\   r]   r^   r_   r`   ra   r2   r   r*   r@   r7   r6   r.   rQ   rQ      s   5n &*D%

d
")!I{!15e''$.56:L,t3:04OU&&-459K+d296:5,,t3:;?1D8?8<U..5<=A3d:A7;E--4;<@2T9@=A %"3"3d":ABF84?F+/J!!D(/+/J!!D(/+/J!!D(/=A %"3"3d":A<@!2!2T!9@15e''$.504OU&&-4	t%* 	tr6   rQ   c            	          ^  \ rS rSrSrSS\S\SS4U 4S jjjrS\R                  S	\
S
\
S\R                  4S jr  SS\R                  S\R                  S-  S\S\R                  4S jjrSrU =r$ )FlavaImageEmbeddings   zZ
Construct the CLS token, position and patch embeddings. Optionally, also the mask token.
configuse_mask_tokenr%   Nc                   > [         TU ]  5         U=(       d    UR                  n[        R                  " [
        R                  " SSUR                  5      5      U l        U(       a6  [        R                  " [
        R                  " SSUR                  5      5      OS U l        [        UR                  UR                  UR                  UR                  S9U l        U R                  R                  n[        R                  " [
        R                  " SUS-   UR                  5      5      U l        [        R                   " UR"                  5      U l        UR                  U l        Xl        g )Nr   )
image_size
patch_sizenum_channels	embed_dim)super__init__
mask_tokenr   	Parameterr=   zeroshidden_size	cls_tokenPatchEmbeddingsrn   ro   rp   patch_embeddingsnum_patchesposition_embeddingsDropouthidden_dropout_probdropoutrk   )r-   rk   rl   r{   	__class__s       r.   rs   FlavaImageEmbeddings.__init__   s    '<6+<+<ekk!Q8J8J&KLQ_",,u{{1a9K9K'LMei /((((,,((	!
 ++77#%<<A{QPVPbPb0c#d zz&"<"<= ++r6   
embeddingsheightwidthc                    UR                   S   S-
  nU R                  R                   S   S-
  n[        R                  R	                  5       (       d  XE:X  a  X#:X  a  U R                  $ U R                  SS2SS24   nU R                  SS2SS24   nUR                   S   nX R
                  -  n	X0R
                  -  n
[        US-  5      nUR                  SXU5      nUR                  SSSS5      n[        R                  R                  UX4SS	S
9nUR                  SSSS5      R                  SSU5      n[        R                  " Xg4SS9$ )a  
This method allows to interpolate the pre-trained position encodings, to be able to use the model on higher resolution
images. This method is also adapted to support torch.jit tracing.

Adapted from:
- https://github.com/facebookresearch/dino/blob/de9ee3df6cf39fac952ab558447af1fa1365362a/vision_transformer.py#L174-L194, and
- https://github.com/facebookresearch/dinov2/blob/e1277af2ba9496fbadf7aec6eba56e8d882d1e35/dinov2/models/vision_transformer.py#L179-L211
r   Ng      ?r   r      bicubicF)sizemodealign_cornersdim)shaper|   r=   jit
is_tracingro   r   reshapepermuter   
functionalinterpolateviewcat)r-   r   r   r   r{   num_positionsclass_pos_embedpatch_pos_embedr   
new_height	new_widthsqrt_num_positionss               r.   interpolate_pos_encoding-FlavaImageEmbeddings.interpolate_pos_encoding  sS    !&&q)A-0066q9A= yy##%%+*F6?+++221bqb59221ab59r".
__,	&}c'9:)11!5G]`a)11!Q1=--33(	 4 
 *11!Q1=BB1b#Nyy/;CCr6   pixel_valuesbool_masked_posr   c                 F   UR                   u  pEpgU R                  XS9nUR                  5       u  pIn
Ub~  U R                  R	                  XIS5      nUR                  5       S:X  a!  UR                  UR                  S5      S5      nUR                  S5      R                  U5      nUSU-
  -  X-  -   nU R                  R	                  USS5      n[        R                  " X4SS9nU(       a  XR                  XU5      -   nOXR                  -   nU R                  U5      nU$ )N)r   r   r   r   g      ?r   r   )r   rz   r   rt   expandr   r   	unsqueezetype_asrx   r=   r   r   r|   r   )r-   r   r   r   
batch_sizerp   r   r   r   seq_len_mask_tokensmask
cls_tokenss                 r.   forwardFlavaImageEmbeddings.forward)  s    3?2D2D/
&**<*k
!+!2
Q&//00bIK""$)"1"6"67K7KA7NPR"S",,R088ED#sTz2[5GGJ ^^**:r2>
YY
7Q?
 $#&C&CJX]&^^J#&>&>>J\\*-
r6   )rx   rk   r   rt   rz   ro   r|   FNF)r8   r9   r:   r;   r<   r   rO   rs   r=   Tensorintr   
BoolTensorr   r@   __classcell__r   s   @r.   ri   ri      s    /  RV  &&D5<< &D &DUX &D]b]i]i &DV 48).	ll ))D0 #'	
 
 r6   ri   c            	          ^  \ rS rSrSr    SS\\\   -  \\\4   -  S\\\\4   -  S\S\4U 4S jjjrSS\	R                  S	\S
\	R                  4S jjrSrU =r$ )ry   iM  z
Image to Patch Embedding.
rn   ro   rp   rq   c                 X  > [         TU ]  5         [        U[        R                  R
                  5      (       d  X4n[        U[        R                  R
                  5      (       d  X"4nUS   US   -  US   US   -  -  nXl        X l        XPl        [        R                  " X4X"S9U l        g )Nr   r   )kernel_sizestride)rr   rs   
isinstancecollectionsabcIterablern   ro   r{   r   Conv2d
projection)r-   rn   ro   rp   rq   r{   r   s         r.   rs   PatchEmbeddings.__init__R  s     	*koo&>&>??$1J*koo&>&>??$1J!!}
15*Q-:VW=:XY$$&))Lgr6   r   r   r%   c                 >   UR                   u  p4pVU(       dV  XPR                  S   :w  d  X`R                  S   :w  a2  [        SU SU SU R                  S    SU R                  S    S3	5      eU R                  U5      R	                  S5      R                  SS5      nU$ )Nr   r   zInput image size (*z) doesn't match model (z).r   )r   rn   
ValueErrorr   flatten	transpose)r-   r   r   r   rp   r   r   xs           r.   r   PatchEmbeddings.forwarde  s    2>2D2D/
&'++u8J/J (% 9+,Adooa.@-AE  OOL)11!4>>q!Dr6   )rn   r{   ro   r   )      r   i   r   )r8   r9   r:   r;   r<   r   listr2   rs   r=   r   rO   r   r@   r   r   s   @r.   ry   ry   M  s     9<,.h$s)OeCHo5h %S/)h 	h
 h h&	ELL 	D 	]b]i]i 	 	r6   ry   c                      ^  \ rS rSrSrU 4S jr   S
S\R                  S-  S\R                  S-  S\R                  S-  4S jjrS	r	U =r
$ )FlavaTextEmbeddingsiq  zGConstruct the embeddings from word, position and token_type embeddings.c                 
  > [         TU ]  5         [        R                  " UR                  UR
                  UR                  S9U l        [        R                  " UR                  UR
                  5      U l	        [        R                  " UR                  UR
                  5      U l        [        R                  " UR
                  UR                  S9U l        [        R                  " UR                  5      U l        U R#                  S[$        R&                  " UR                  5      R)                  S5      SS9  U R#                  S[$        R*                  " U R,                  R/                  5       [$        R0                  S9SS9  g )	N)padding_idxepsposition_idsr   r   F)
persistenttoken_type_ids)dtype)rr   rs   r   	Embedding
vocab_sizerw   pad_token_idword_embeddingsmax_position_embeddingsr|   type_vocab_sizetoken_type_embeddings	LayerNormlayer_norm_epsr}   r~   r   register_bufferr=   aranger   rv   r   r   longr-   rk   r   s     r.   rs   FlavaTextEmbeddings.__init__t  s   !||F,=,=v?Q?Q_e_r_rs#%<<0N0NPVPbPb#c %'\\&2H2H&J\J\%]"f&8&8f>S>STzz&"<"<=ELL)G)GHOOPWXej 	 	
 	ekk$*;*;*@*@*B%**Ubg 	 	
r6   N	input_idsr   r   c                    UR                  5       nUS   nUc  U R                  S S 2S U24   nUcv  [        U S5      (       a-  U R                  S S 2S U24   nUR	                  US   U5      nUnO8[
        R                  " U[
        R                  U R                  R                  S9nU R                  U5      nU R                  U5      n	X-   n
U R                  U5      nX-  n
U R                  U
5      n
U R                  U
5      n
U
$ )Nr   r   r   )r   device)r   r   hasattrr   r   r=   rv   r   r   r   r   r|   r   r   )r-   r   r   r   input_shape
seq_lengthbuffered_token_type_ids buffered_token_type_ids_expandedinputs_embedsr   r   r|   s               r.   r   FlavaTextEmbeddings.forward  s     nn& ^
,,Q^<L
 !t-..*.*=*=a*n*M'3J3Q3QR]^_R`bl3m0!A!&[

SWSdSdSkSk!l,,Y7 $ : :> J":
"66|D)
^^J/
\\*-
r6   )r   r   r|   r   r   NNN)r8   r9   r:   r;   r<   rs   r=   r   r   r@   r   r   s   @r.   r   r   q  sW    Q
$ *..2,0	 <<$&  t+  llT)	   r6   r   c                      ^  \ rS rSrS\SS4U 4S jjr  SS\R                  S\R                  S-  S\S\	\R                  \R                  4   \	\R                     -  4S	 jjr
S
rU =r$ )FlavaSelfAttentioni  rk   r%   Nc                   > [         TU ]  5         UR                  UR                  -  S:w  a7  [	        US5      (       d&  [        SUR                   SUR                   S35      eUR                  U l        [        UR                  UR                  -  5      U l        U R                  U R                  -  U l        [        R                  " UR                  U R                  UR                  S9U l        [        R                  " UR                  U R                  UR                  S9U l        [        R                  " UR                  U R                  UR                  S9U l        [        R                  " UR                   5      U l        g )Nr   embedding_sizezThe hidden size z4 is not a multiple of the number of attention heads .bias)rr   rs   rw   num_attention_headsr   r   r   attention_head_sizeall_head_sizer   Linearqkv_biasquerykeyvaluer}   attention_probs_dropout_probr   r   s     r.   rs   FlavaSelfAttention.__init__  s1    : ::a?PVXhHiHi"6#5#5"6 7334A7 
 $*#=#= #&v'9'9F<V<V'V#W !558P8PPYYv1143E3EFOO\
99V//1C1C&//ZYYv1143E3EFOO\
zz&"E"EFr6   hidden_statesattention_maskoutput_attentionsc                 V   UR                   S S n/ UQSPU R                  P7nU R                  U5      R                  U5      R	                  SS5      nU R                  U5      R                  U5      R	                  SS5      nU R                  U5      R                  U5      R	                  SS5      n[        R                  " XgR	                  SS5      5      n	U	[        R                  " U R                  5      -  n	Ub  X-   n	[        R                  R                  U	SS9n
U R                  U
5      n
[        R                  " X5      nUR                  SSSS5      R!                  5       nUR#                  5       S S U R$                  4-   nUR                  " U6 nU(       a  X4nU$ U4nU$ )Nr   r   r   r   r   r   )r   r   r   r   r   r   r   r=   matmulmathsqrtr   r   softmaxr   r   
contiguousr   r   )r-   r   r   r   r   hidden_shapequery_layer	key_layervalue_layerattention_scoresattention_probscontext_layernew_context_layer_shapeoutputss                 r.   r   FlavaSelfAttention.forward  s    $))#2.CCbC$*B*BCjj/44\BLLQPQRHH]+00>HHAN	jj/44\BLLQPQR !<<5H5HR5PQ+dii8P8P.QQ%/@ --//0@b/I ,,7_B%--aAq9DDF"/"4"4"6s";t?Q?Q>S"S%**,CD6G=2 O\M]r6   )r   r   r   r   r   r   r   r   r8   r9   r:   r;   FlavaPossibleConfigsrs   r=   r   rO   r2   r   r@   r   r   s   @r.   r   r     s    G3 G G* /3"'	#||# t+#  	#
 
u||U\\)	*U5<<-@	@# #r6   r   c                      ^  \ rS rSrSrS\SS4U 4S jjrS\R                  S\R                  S\R                  4S	 jr	S
r
U =r$ )FlavaSelfOutputi  z
The residual connection is defined in FlavaLayer (same as ViTLayer) instead of here (as is the case with other
models), due to the layernorm applied before each block.
rk   r%   Nc                    > [         TU ]  5         [        R                  " UR                  UR                  5      U l        [        R                  " UR                  5      U l        g rd   )	rr   rs   r   r   rw   denser}   r~   r   r   s     r.   rs   FlavaSelfOutput.__init__  sB    YYv1163E3EF
zz&"<"<=r6   r   input_tensorc                 J    U R                  U5      nU R                  U5      nU$ rd   r  r   r-   r   r  s      r.   r   FlavaSelfOutput.forward  s$    

=1]3r6   r  )r8   r9   r:   r;   r<   r  rs   r=   r   r   r@   r   r   s   @r.   r  r    sJ    
>3 > >
U\\  RWR^R^  r6   r  c                      ^  \ rS rSrS\SS4U 4S jjr  SS\R                  S\R                  S-  S\S\	\R                  \R                  4   \	\R                     -  4S	 jjr
S
rU =r$ )FlavaAttentioni  rk   r%   Nc                 b   > [         TU ]  5         [        U5      U l        [	        U5      U l        g rd   )rr   rs   r   	attentionr  outputr   s     r.   rs   FlavaAttention.__init__  s&    +F3%f-r6   r   r   r   c                 b    U R                  XUS9nU R                  US   U5      nU4USS  -   nU$ N)r   r   r   r   r!  r"  )r-   r   r   r   self_outputsattention_outputr  s          r.   r   FlavaAttention.forward  sM     ~~L] & 
  ;;|AF#%QR(88r6   r&  r   r  r   s   @r.   r  r    s|    .3 . . /3"'	|| t+  	
 
u||U\\)	*U5<<-@	@ r6   r  c                   n   ^  \ rS rSrS\SS4U 4S jjrS\R                  S\R                  4S jrSr	U =r
$ )	FlavaIntermediatei  rk   r%   Nc                   > [         TU ]  5         [        R                  " UR                  UR
                  5      U l        [        UR                  [        5      (       a  [        UR                     U l        g UR                  U l        g rd   )rr   rs   r   r   rw   intermediate_sizer  r   
hidden_actstrr	   intermediate_act_fnr   s     r.   rs   FlavaIntermediate.__init__	  s`    YYv1163K3KL
f''--'-f.?.?'@D$'-'8'8D$r6   r   c                 J    U R                  U5      nU R                  U5      nU$ rd   r  r0  r-   r   s     r.   r   FlavaIntermediate.forward  s&    

=100?r6   r3  r8   r9   r:   r;   r  rs   r=   r   r   r@   r   r   s   @r.   r+  r+    s7    93 9 9U\\ ell  r6   r+  c                      ^  \ rS rSrS\SS4U 4S jjrS\R                  S\R                  S\R                  4S jrS	r	U =r
$ )
FlavaOutputi  rk   r%   Nc                    > [         TU ]  5         [        R                  " UR                  UR
                  5      U l        [        R                  " UR                  5      U l	        g rd   )
rr   rs   r   r   r-  rw   r  r}   r~   r   r   s     r.   rs   FlavaOutput.__init__  sB    YYv779K9KL
zz&"<"<=r6   r   r  c                 R    U R                  U5      nU R                  U5      nX-   nU$ rd   r  r  s      r.   r   FlavaOutput.forward   s,    

=1]3%4r6   r  r6  r   s   @r.   r8  r8    sE    >3 > >U\\  RWR^R^  r6   r8  c                      ^  \ rS rSrSrS\SS4U 4S jjr  SS\R                  S\R                  S-  S	\	S\
\R                  \R                  4   \
\R                     -  4S
 jjrSrU =r$ )
FlavaLayeri)  z?This corresponds to the Block class in the timm implementation.rk   r%   Nc                 j  > [         TU ]  5         UR                  U l        SU l        [	        U5      U l        [        U5      U l        [        U5      U l	        [        R                  " UR                  UR                  S9U l        [        R                  " UR                  UR                  S9U l        g )Nr   r   )rr   rs   chunk_size_feed_forwardseq_len_dimr  r!  r+  intermediater8  r"  r   r   rw   r   layernorm_beforelayernorm_afterr   s     r.   rs   FlavaLayer.__init__,  s    '-'E'E$'/-f5!&) !#V-?-?VEZEZ [!||F,>,>FDYDYZr6   r   r   r   c                     U R                  U R                  U5      UUS9nUS   nUSS  nXQ-   nU R                  U5      nU R                  U5      nU R	                  Xq5      nU4U-   nU$ r%  )r!  rC  rD  rB  r"  )r-   r   r   r   self_attention_outputsr(  r  layer_outputs           r.   r   FlavaLayer.forward8  s     "&!!-0)/ "0 "

 2!4(, )8 ++M:((6 {{<?/G+r6   )r!  r@  rB  rD  rC  r"  rA  r   )r8   r9   r:   r;   r<   r  rs   r=   r   rO   r2   r   r@   r   r   s   @r.   r>  r>  )  s    I
[3 
[ 
[ /3"'	|| t+  	
 
u||U\\)	*U5<<-@	@ r6   r>  c                      ^  \ rS rSrS\SS4U 4S jjr    SS\R                  S\R                  S-  S\S	\S
\S\	\
-  4S jjrSrU =r$ )FlavaEncoderiU  rk   r%   Nc                    > [         TU ]  5         Xl        [        R                  " [        UR                  5       Vs/ s H  n[        U5      PM     sn5      U l        SU l	        g s  snf r   )
rr   rs   rk   r   
ModuleListrangenum_hidden_layersr>  layergradient_checkpointing)r-   rk   r   r   s      r.   rs   FlavaEncoder.__init__V  sR    ]]fF^F^@_#`@_1Jv$6@_#`a
&+# $as   A&r   r   r   output_hidden_statesreturn_dictc                 "   U(       a  SOS nU(       a  SOS n[        U R                  5       H0  u  pU(       a  Xa4-   nU	" XU5      n
U
S   nU(       d  M(  XzS   4-   nM2     U(       a  Xa4-   nU(       d  [        S XU4 5       5      $ [        XUS9$ )Nr7   r   r   c              3   .   #    U  H  oc  M  Uv   M     g 7frd   r7   )r+   rM   s     r.   r/   'FlavaEncoder.forward.<locals>.<genexpr>v  s     m$[q$[   	)last_hidden_stater   
attentions)	enumeraterP  r2   r   )r-   r   r   r   rS  rT  all_hidden_statesall_self_attentionsilayer_modulelayer_outputss              r.   r   FlavaEncoder.forward\  s     #7BD$5b4(4OA#$58H$H!(HYZM)!,M  &91=M<O&O#  5   14D Dm]GZ$[mmm+Yl
 	
r6   )rk   rQ  rP  )NFFT)r8   r9   r:   r;   r   rs   r=   r   rO   r2   r   r   r@   r   r   s   @r.   rK  rK  U  sz    ,{ ,t , /3"'%* 
||
 t+
  	

 #
 
 
	 
 
r6   rK  c                   R   ^  \ rS rSrS\4U 4S jjrS\R                  4S jrSr	U =r
$ )FlavaPooleri|  rk   c                    > [         TU ]  5         [        R                  " UR                  UR                  5      U l        [        R                  " 5       U l        g rd   )rr   rs   r   r   rw   r  Tanh
activationr   s     r.   rs   FlavaPooler.__init__}  s9    YYv1163E3EF
'')r6   r   c                 \    US S 2S4   nU R                  U5      nU R                  U5      nU$ Nr   )r  rf  )r-   r   first_token_tensorpooled_outputs       r.   r   FlavaPooler.forward  s6     +1a40

#566r6   )rf  r  r6  r   s   @r.   rc  rc  |  s%    $3 $
U\\  r6   rc  c                      ^  \ rS rSr% \\S'   SrSrSr\	R                  " 5       S\R                  \R                  -  \R                  -  SS4U 4S	 jj5       rS
rU =r$ )FlavaPreTrainedModeli  rk   flava)imagetextTmoduler%   Nc                   > [         TU ]  U5        [        U[        5      (       a!  [        R
                  " UR                  5        g[        U[        5      (       ao  [        R
                  " UR                  5        [        R
                  " UR                  5        UR                  b!  [        R
                  " UR                  5        gg[        U[        5      (       a|  [        R                  " UR                  [        R                  " UR                  R                   S   5      R#                  S5      5        [        R
                  " UR$                  5        g[        U[&        5      (       a3  UR(                  (       a!  [        R
                  " UR                  5        gg[        U[*        5      (       a6  [        R,                  " UR.                  U R0                  R2                  5        gg)zInitialize the weightsNr   r   )rr   _init_weightsr   FlavaMaskedPredictionHeadinitzeros_r   ri   rx   r|   rt   r   copy_r   r=   r   r   r   r   FlavaMultimodalModeluse_cls_token
FlavaModel	constant_logit_scalerk   logit_scale_init_value)r-   rr  r   s     r.   rt  "FlavaPreTrainedModel._init_weights  s>    	f%f788KK$ 455KK(()KK223  ,F--. - 344JJv**ELL9L9L9R9RSU9V,W,^,^_f,ghKK--. 455##F,,- $
++NN6--t{{/Q/QR ,r6   r7   )r8   r9   r:   r;   r   r?   base_model_prefixinput_modalitiessupports_gradient_checkpointingr=   no_gradr   r   r   r   rt  r@   r   r   s   @r.   rn  rn    s[    (&*#
]]_SBII		$9BLL$H ST S Sr6   rn  c                   F  ^  \ rS rSr% \\S'   SrSrSrSS\S\	4U 4S jjjr
S\R                  4S	 jrS
\R                  4S jr\       SS\R"                  S-  S\R$                  S-  S\	S-  S\R"                  S-  S\	S-  S\	S-  S\	S-  S\\-  4S jj5       rSrU =r$ )FlavaImageModeli  rk   zflava.image_modelr   rp  add_pooling_layerc                   > [         TU ]  U5        Xl        [        U5      U l        [        U5      U l        [        R                  " UR                  UR                  S9U l        U(       a  [        U5      OSU l        U R                  5         g^
add_pooling_layer (bool, *optional*, defaults to `True`):
    Whether to add a pooling layer
r   N)rr   rs   rk   ri   r   rK  encoderr   r   rw   r   	layernormrc  pooler	post_initr-   rk   r  r   s      r.   rs   FlavaImageModel.__init__  sg    
 	 .v6#F+f&8&8f>S>ST->k&)Dr6   r%   c                 .    U R                   R                  $ rd   r   rz   r4   s    r.   get_input_embeddings$FlavaImageModel.get_input_embeddings  s    ///r6   r   c                 $    XR                   l        g rd   r  r-   r   s     r.   set_input_embeddings$FlavaImageModel.set_input_embeddings  s    +0(r6   Nr   r   r   r   rS  rT  c                    Ub  UOU R                   R                  nUb  UOU R                   R                  nUb  UOU R                   R                  nUc  [	        S5      eU R                  XUS9n	U R                  U	UUUUS9n
U
S   nU R                  U5      nU R                  b  U R                  U5      OSnU(       d	  X4U
SS -   $ [        UUU
R                  U
R                  S9$ )z
bool_masked_pos (`torch.BoolTensor` of shape `(batch_size, image_num_patches)`):
    Boolean masked positions. Indicates which patches are masked (1) and which aren't (0).
Nz You have to specify pixel_values)r   r   r   r   rS  rT  r   r   rY  pooler_outputr   rZ  )rk   r   rS  rT  r   r   r  r  r  r   r   rZ  )r-   r   r   r   r   r   rS  rT  kwargsembedding_outputencoder_outputssequence_outputrk  s                r.   r   FlavaImageModel.forward  s     2C1N-TXT_T_TqTq$8$D $++JjJj 	 &1%<k$++BYBY?@@??Tl + 
 ,,)/!5# ' 
 *!,..98<8OO4UY#3oab6III)-')77&11	
 	
r6   rk   r   r  r  r  TNNNNNNN)r8   r9   r:   r;   r   r?   r  main_input_namer  rO   rs   r   Moduler  r  r   r=   r   r   r2   r   r   r@   r   r   s   @r.   r  r    s    +$O!/ D  "0bii 01")) 1  -13704.2)-,0#'/
llT)/
 ))D0/
 #'+	/

 t+/
  $;/
 #Tk/
 D[/
 
+	+/
 /
r6   r  c                   B  ^  \ rS rSr% \\S'   SrSrSS\S\4U 4S jjjr	S\
4S jrS	\R                  4S
 jr\       SS\R"                  S-  S\R"                  S-  S\R"                  S-  S\R"                  S-  S\S-  S\S-  S\S-  S\\-  4S jj5       rSrU =r$ )FlavaTextModeli  rk   zflava.text_model)rq  r  c                   > [         TU ]  U5        Xl        [        U5      U l        [        U5      U l        [        R                  " UR                  UR                  S9U l        U(       a  [        U5      OSU l        U R                  5         gr  )rr   rs   rk   r   r   rK  r  r   r   rw   r   r  rc  r  r  r  s      r.   rs   FlavaTextModel.__init__   sg    
 	 -f5#F+f&8&8f>S>ST->k&)Dr6   r%   c                 .    U R                   R                  $ rd   r   r   r4   s    r.   r  #FlavaTextModel.get_input_embeddings  s    ...r6   r   c                 $    XR                   l        g rd   r  r  s     r.   r  #FlavaTextModel.set_input_embeddings  s    */'r6   Nr   r   r   r   r   rS  rT  c                 Z   Ub  UOU R                   R                  nUb  UOU R                   R                  nUb  UOU R                   R                  nUc  [	        S5      eUR                  5       n	Uc  [        R                  " XR                  S9nU R                  UU	5      n
U R                  UUUS9nU R                  UU
UUUS9nUS   nU R                  U5      nU R                  b  U R                  U5      OSnU(       d	  X4USS -   $ [        UUUR                  UR                   S9$ )	a  
input_ids (`torch.LongTensor` of shape `(batch_size, text_seq_length)`):
    Indices of input sequence tokens in the vocabulary. Indices can be obtained using [`AutoTokenizer`]. See
    [`PreTrainedTokenizer.encode`] and [`PreTrainedTokenizer.__call__`] for details. [What are input
    IDs?](../glossary#input-ids)
token_type_ids (`torch.LongTensor` of shape `(batch_size, text_seq_length)`, *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)
NzYou have to specify input_idsr   )r   r   r   r  r   r   r  )rk   r   rS  rT  r   r   r=   onesr   get_extended_attention_maskr   r  r  r  r   r   rZ  )r-   r   r   r   r   r   rS  rT  r  r   extended_attention_maskr  r  r  rk  s                  r.   r   FlavaTextModel.forward  sU   0 2C1N-TXT_T_TqTq$8$D $++JjJj 	 &1%<k$++BYBY<==nn&!"ZZ<L<LMN040P0P1

  ??)% + 
 ,,2/!5# ' 
 *!,..98<8OO4UY#3oab6III)-')77&11	
 	
r6   r  r  r  )r8   r9   r:   r;   r   r?   r  r  rO   rs   ry   r  r   r  r  r   r=   r   r2   r   r   r@   r   r   s   @r.   r  r    s   *  4   /o /0")) 0  *..2.2,0)-,0#'C
<<$&C
 t+C
 t+	C

 llT)C
  $;C
 #TkC
 D[C
 
+	+C
 C
r6   r  c                      ^  \ rS rSr% \\S'   SrSrSS\4U 4S jjjr\	    SS\
R                  S\
R                  S-  S\S-  S	\S-  S
\S-  S\\-  4S jj5       rSrU =r$ )ry  i]  rk   zflava.multimodal_modelr   c                   > [         TU ]  U5        Xl        U R                  R                  U l        U R                  (       a;  [        R
                  " [        R                  " SSUR                  5      5      U l	        [        U5      U l        [        R                  " UR                  UR                  S9U l        U(       a  [        U5      OSU l        U R#                  5         g)r  r   r   N)rr   rs   rk   rz  r   ru   r=   rv   rw   rx   rK  r  r   r   r  rc  r  r  r  s      r.   rs   FlavaMultimodalModel.__init__d  s    
 	 ![[66\\%++aF<N<N*OPDN#F+f&8&8f>S>ST->k&)Dr6   Nr   r   rS  rT  r%   c                    Ub  UOU R                   R                  nUb  UOU R                   R                  nUb  UOU R                   R                  nUR	                  5       u  pxn	U R
                  (       a8  U R                  R                  USS5      n
[        R                  " X4SS9nUS-  nUc   [        R                  " Xx4UR                  S9nU R                  UXx45      nU R                  UUUUUS9nUS   nU R                  U5      nU R                  b  U R                  U5      OSnU(       d	  X4USS -   $ [!        UUUR"                  UR$                  S9$ )	z
hidden_states (`torch.FloatTensor` of shape `(batch_size, image_num_patches + text_seq_len, hidden_size)`):
    The concatenated hidden states of unimodal encoders.
Nr   r   r   r  r  r   r  )rk   r   rS  rT  r   rz  rx   r   r=   r   r  r   r  r  r  r  r   r   rZ  )r-   r   r   r   rS  rT  r  r   r   r   r   r  r  r  rk  s                  r.   r   FlavaMultimodalModel.forwardv  sp    2C1N-TXT_T_TqTq$8$D $++JjJj 	 &1%<k$++BYBY$1$6$6$8!
..z2rBJ!IIz&AqIM!OJ!"ZZ(@I]I]^N040P0P$1

 ,,2/!5# ' 
 *!,..98<8OO4UY#3oab6III)-')77&11	
 	
r6   )rx   rk   r  r  r  rz  r  )NNNN)r8   r9   r:   r;   r   r?   r  r  rs   r   r=   r   rO   r2   r   r   r@   r   r   s   @r.   ry  ry  ]  s    !!0%O4  $  /3)-,0#'5
||5
 t+5
  $;	5

 #Tk5
 D[5
 
+	+5
 5
r6   ry  c                     ^  \ rS rSr% \\S'   S\4U 4S jjr\\   SS\	R                  S\	R                  S-  S\	R                  S-  S\	R                  S-  S	\\   S
\\-  4S jj5       5       r\\   SS\	R                  S\	R                   S-  S\S-  S\	R                  S-  S	\\   S
\\-  4S jj5       5       r\           SS\	R&                  S-  S\	R(                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R&                  S-  S\	R                  S-  S\S-  S\S-  S\S\S-  S
\\-  4S jj5       rSrU =r$ )r{  i  rk   c                   > [         TU ]  U5        [        UR                  [        5      (       d"  [        S[        UR                  5       S35      e[        UR                  [        5      (       d"  [        S[        UR                  5       S35      e[        UR                  [        5      (       d%  [        SS[        UR                  5       S3-   5      eUR                  nUR                  nUR                  nUR                  U l        UR                  U l        UR                  U l        UR                  U l        [!        U5      U l        [%        U5      U l        [)        U5      U l        [,        R.                  " U R                  U R                  5      U l        [,        R.                  " U R                  U R                  5      U l        [,        R4                  " [6        R8                  " U R:                  R<                  5      5      U l        [,        R.                  " U R                  U R                  5      U l         [,        R.                  " U R                  U R                  5      U l!        U RE                  5         g )NzLconfig.text_config is expected to be of type FlavaTextConfig but is of type r   zNconfig.image_config is expected to be of type FlavaImageConfig but is of type zMconfig.multimodal_config is expected to be of type FlavaMultimodalConfig but zis of type )#rr   rs   r   text_configr   	TypeErrortypeimage_configr   multimodal_configr   projection_dimrw   text_hidden_sizeimage_hidden_sizemm_hidden_sizer  
text_modelr  image_modelry  multimodal_modelr   r   image_projectiontext_projectionru   r=   tensorrk   r~  r}  image_to_mm_projectiontext_to_mm_projectionr  )r-   rk   r  r  r  r   s        r.   rs   FlavaModel.__init__  s    &,,o>>++,-Q0 
 &--/?@@,,-.a1 
 &224IJJ_V%=%= >?qAB 
 ((**"44$33 + 7 7!-!9!9/;;(5*<8 45F G "		$*@*@$BUBU V!yy)>)>@S@ST<<T[[5W5W(XY&(ii0F0FH[H[&\#%'YYt/D/DdFYFY%Z"r6   Nr   r   r   r   r  r%   c           	      z    U R                   " SUUUUSS.UD6nUR                  nU R                  U5      Ul        U$ )aQ  
input_ids (`torch.LongTensor` of shape `(batch_size, text_seq_length)`):
    Indices of input sequence tokens in the vocabulary. Indices can be obtained using [`AutoTokenizer`]. See
    [`PreTrainedTokenizer.encode`] and [`PreTrainedTokenizer.__call__`] for details. [What are input
    IDs?](../glossary#input-ids)
token_type_ids (`torch.LongTensor` of shape `(batch_size, text_seq_length)`, *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)

Examples:

```python
>>> import torch
>>> from transformers import AutoProcessor, FlavaModel

>>> model = FlavaModel.from_pretrained("{0}")
>>> processor = AutoProcessor.from_pretrained("{0}")

>>> inputs = processor(
...     text=["a photo of a cat", "a photo of a dog"], max_length=77, padding="max_length", return_tensors="pt"
... )
>>> with torch.inference_mode():
...     text_features = model.get_text_features(**inputs)
```
T)r   r   r   r   rT  r7   )r  rY  r  r  )r-   r   r   r   r   r  text_outputsrY  s           r.   get_text_featuresFlavaModel.get_text_features  sY    L 48?? 4
))%4
 4
 )::%)%9%9:K%L"r6   r   r   r   c           	      z    U R                   " SUUUUSS.UD6nUR                  nU R                  U5      Ul        U$ )a  
bool_masked_pos (`torch.BoolTensor` of shape `(batch_size, image_num_patches)`):
    Boolean masked positions. Indicates which patches are masked (1) and which aren't (0).

Examples:

```python
>>> import torch
>>> from transformers import AutoProcessor, FlavaModel
>>> from transformers.image_utils import load_image

>>> model = FlavaModel.from_pretrained("{0}")
>>> processor = AutoProcessor.from_pretrained("{0}")

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = load_image(url)

>>> inputs = processor(images=image, return_tensors="pt")

>>> with torch.inference_mode():
...     image_features = model.get_image_features(**inputs)
```
T)r   r   r   r   rT  r7   )r  rY  r  r  )r-   r   r   r   r   r  image_outputsrY  s           r.   get_image_featuresFlavaModel.get_image_features  s[    B 594D4D 5
%+)%=5
 5
 *;;&*&;&;<M&N#r6   image_attention_maskskip_multimodal_encoderr   rS  rT  c           
         Ub  UOU R                   R                  nU
(       d  [        S5      eSnSnSnSnUb1  U R                  UUUU	U
US9nUS   US   pU R	                  US   5      nSnSnSnSnUb3  U R                  UUUUU	U
US9nUS   US   nnU R                  US   5      nSnSnUb  Ub  U(       d  Ubh  UR                  u  nnnU R                  R                  (       a  US-  n[        R                  " UUUR                  S	9n[        R                  " UU/SS
9nOSn[        R                  " UU/SS
9nU R                  UUUS9nUS   nU(       d  UUUUUU4$ [        UUUUUUS9$ )a  
input_ids (`torch.LongTensor` of shape `(batch_size, image_num_patches + text_seq_len)`):
    Indices of input sequence tokens in the vocabulary. Indices can be obtained using [`AutoTokenizer`]. See
    [`PreTrainedTokenizer.encode`] and [`PreTrainedTokenizer.__call__`] for details. [What are input
    IDs?](../glossary#input-ids)
token_type_ids (`torch.LongTensor` of shape `(batch_size, image_num_patches + text_seq_len)`, *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)
bool_masked_pos (`torch.BoolTensor` of shape `(batch_size, image_num_patches)`):
    Boolean masked positions. Indicates which patches are masked (1) and which aren't (0).
image_attention_mask (`torch.Tensor` of shape `(batch_size, image_num_patches)`, *optional*):
    Mask to avoid performing attention on padding pixel values for image inputs. Mask values selected in `[0, 1]`:
    - 1 for pixel values that are real (i.e., **not masked**),
    - 0 for pixel values that are padding (i.e., **masked**).
skip_multimodal_encoder (*bool*, *optional*):
    Skip any calculations for multimodal encoder. Useful if multimodal encoding is not going to be used.

Examples:

```python
>>> from PIL import Image
>>> import httpx
>>> from io import BytesIO
>>> from transformers import AutoProcessor, FlavaModel

>>> model = FlavaModel.from_pretrained("facebook/flava-full")
>>> processor = AutoProcessor.from_pretrained("facebook/flava-full")

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> with httpx.stream("GET", url) as response:
...     image = Image.open(BytesIO(response.read()))

>>> inputs = processor(text=["a photo of a cat"], images=image, return_tensors="pt", padding=True)

>>> outputs = model(**inputs)

>>> image_embeddings = outputs.image_embeddings
>>> text_embeddings = outputs.text_embeddings
>>> multimodal_embeddings = outputs.multimodal_embeddings

>>> outputs.image_embeddings.shape
torch.Size([1, 197, 768])

>>> text_embeddings.shape
torch.Size([1, 7, 768])

>>> multimodal_embeddings.shape
torch.Size([1, 205, 768])
```
NzRFLAVA model requires hidden states to work. Please set `output_hidden_states=True`)r   r   r   r   rS  rT  r   r   r   )r   r   r   r   r   rS  rT  r   r  r   )r   rT  )r   r    r!   r"   r#   r$   )rk   rT  r   r  r  r  r  r   r  rz  r=   r  r   r   r   )r-   r   r   r   r   r   r   r  r  r   rS  rT  r  r   image_statesimage_mm_projectionr    r!   text_statestext_mm_projectionr"   r#   r$   r   r   r   attention_mask_imageattention_multimodalmultimodal_inputs                                r.   r   FlavaModel.forward?  s   L &1%<k$++BYBY#qrr"#++) /3"3%9' , L .:!_l1ol"&"="=l2>N"O! //#-)-"3%9' * K ,7q>;q>[O!%!;!;KO!L $ */A/MVm))<)B)B&
GQ((66qLG',zz*gNaNhNh'i$',yy2F1W]^'_$'+$$yy*=?Q)RXYZ $ 5 5 1ES^ !6 ! %6a$8! %!   -%+#"7/
 	
r6   )r  r  r  r  r}  r  r  r  r  r  r  r  r   )NNNNNNNNNTN)r8   r9   r:   r;   r   r?   rs   r   r   r=   r   r   r   r2   r   r  r   rO   r  
LongTensorr>   r   r   r@   r   r   s   @r.   r{  r{    s?   ){ )V  /3.2,0/<</ t+/ t+	/
 llT)/ +,/ 
+	+/  /b  4804.2*ll* ))D0* #'+	*
 t+* +,* 
+	+*  *X  .215.2.2/30448/3)-%)#'N
##d*N
 ''$.N
 t+	N

 t+N
 ,N
 &&-N
 $llT1N
 "&N
  $;N
 #N
 D[N
 
!	!N
 N
r6   r{  c                   n   ^  \ rS rSrS\S\4U 4S jjrS\R                  S\R                  4S jrSr	U =r
$ )	FlavaImageCodebookResPathi  in_sizeout_sizec                   > [         TU ]  5         US-  n[        5       n[        R                  " 5       US'   [        R
                  " XSSS9US'   [        R                  " 5       US'   [        R
                  " XDSSS9US'   [        R                  " 5       US	'   [        R
                  " XDSSS9US
'   [        R                  " 5       US'   [        R
                  " XBSSS9US'   [        R                  " U5      U l        g )N   relu_1r   r   r   paddingconv_1relu_2conv_2relu_3conv_3relu_4r   conv_4)rr   rs   r   r   ReLUr   
Sequentialpath)r-   r  r  r  hid_sizer  r   s         r.   rs   "FlavaImageCodebookResPath.__init__  s    q=}X7!QOXX81aPXX81aPXX81aPXMM$'	r6   r   r%   c                 $    U R                  U5      $ rd   r  r-   r   s     r.   r   !FlavaImageCodebookResPath.forward  s    yy|r6   r  r8   r9   r:   r;   r   rs   r=   r   r   r@   r   r   s   @r.   r  r    s6    ( (s (  %,,  r6   r  c                   r   ^  \ rS rSrS\S\S\4U 4S jjrS\R                  S\R                  4S jrS	r	U =r
$ )
FlavaImageCodebookBlocki  r  r  
num_layersc                    > [         TU ]  5         SUS-  -  U l        X:w  a  [        R                  " XSSS9U l        O[        R                  " 5       U l        [        X5      U l        g )Nr   r   r   r  )	rr   rs   	post_gainr   r   id_pathIdentityr  res_path)r-   r  r  r  r  r   s        r.   rs    FlavaImageCodebookBlock.__init__  sQ    j!m,99WAqQDL;;=DL1'Dr6   r   r%   c                 b    U R                  U5      U R                  U R                  U5      -  -   $ rd   r  r  r  r  s     r.   r   FlavaImageCodebookBlock.forward  s'    ||A$--2B!BBBr6   r  r  r   s   @r.   r  r    sE    
E 
Es 
E 
EC C%,, C Cr6   r  c                   ~   ^  \ rS rSrSS\S\S\S\S\4
U 4S jjjrS\R                  S	\R                  4S
 jr	Sr
U =r$ )FlavaImageCodebookLayerGroupi  
num_blocksr  r  r  use_poolc                 0  > [         TU ]  5         [        5       n[        U5       H5  nUS:X  a  [	        X4U5      USUS-    3'   M   [	        XDU5      USUS-    3'   M7     U(       a  [
        R                  " SS9US'   [
        R                  " U5      U l        g )Nr   block_r   r   )r   pool)	rr   rs   r   rN  r  r   	MaxPool2dr  group)	r-   r  r  r  r  r  blocksr^  r   s	           r.   rs   %FlavaImageCodebookLayerGroup.__init__  s    z"AAv+B7V`+aAw'(+B8Wa+bAw'(	 # \\a8F6N]]6*
r6   r   r%   c                 $    U R                  U5      $ rd   r  r  s     r.   r   $FlavaImageCodebookLayerGroup.forward  s    zz!}r6   r  r  )r8   r9   r:   r;   r   rO   rs   r=   r   r   r@   r   r   s   @r.   r
  r
    sR    +3 +C +# +QT +`d + + %,,  r6   r
  a"  
    The FLAVA's image codebook model inspired from DALL-E's original encoder. Outputs raw hidden states and can be used
    to generate image tokens for an image based on DALL-E's vocab. Used to generate labels for MIM. Use
    `get_codebook_indices` to get image tokens for an image.
    c                      ^  \ rS rSr% Sr\\S'   SrSrSr	S\S\
4U 4S jjrS\R                  S	\R                  4S
 jrS\R                  S	\R                  4S jrS\R                   S	\R                  4S jrSrU =r$ )FlavaImageCodebooki  modelrk   r   r  Fr  c                   > [         TU ]  U5        Xl        UR                  U l        UR                  U l        UR
                  U l        UR                  U l        UR                  U l        U R                  U R
                  -  n[        5       n[        R                  " 5       US'   [        R                  " SU R                  -  U R                  SSS9US'   [        5       n[        R                  " U R                  SU R                  -  SSS9US	'   [        U R
                  USU R                  -  SU R                  -  5      US
'   [        U R
                  USU R                  -  SU R                  -  5      US'   [        U R
                  USU R                  -  SU R                  -  5      US'   [        U R
                  USU R                  -  SU R                  -  SS9US'   [        R                  " U5      US'   [        R                  " U5      U l        U R                  5         U R                  R                   (       a  U R#                  5        H
  nSUl        M     g g )Nrelu   r   r   r  conv   r   inputgroup_1r   group_2r  group_3F)r  group_4r"  )rr   rs   rk   
num_groupsinput_channelsnum_blocks_per_grouprw   r   r   r   r  r   r
  r  r  r  freeze
parametersrequires_grad)r-   rk   r  r  output_blocksr  paramr   s          r.   rs   FlavaImageCodebook.__init__  s   
 	  ++$33$*$?$?!!-- ++__t'@'@@
# "	f "		!d.>.>*>]^hi jf))D$7$7T=M=M9M[\fghw8%%z1t7G7G3GTM]M]I]
y 9%%z1t7G7G3GTM]M]I]
y 9%%z1t7G7G3GTM]M]I]
y 9%%z1t7G7G3GTM]M]I]hm
y ==7xmmF+;;*&+# + r6   r%   c                 p    S[          S[          S3  U R                  U5      n[        R                  " USS9$ )NaI  
        Args:
            pixel_values (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)`):
                Pixel values. Codebook pixel values can be obtained using [`AutoImageProcessor`] by passing
                `return_codebook_pixels=True`. See [`FlavaImageProcessor.__call__`] for details.

        Examples:
        ```python
        >>> from PIL import Image
        >>> import httpx
        >>> from io import BytesIO
        >>> from transformers import AutoImageProcessor, FlavaImageCodebook

        >>> model = FlavaImageCodebook.from_pretrained("E")
        >>> image_processor = AutoImageProcessor.from_pretrained("a  ")

        >>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
        >>> with httpx.stream("GET", url) as response:
        ...     image = Image.open(BytesIO(response.read()))

        >>> inputs = image_processor([image], return_codebook_pixels=True, return_tensors="pt")
        >>> inputs = dict(pixel_values=inputs.codebook_pixel_values)

        >>> outputs = model.get_codebook_indices(**inputs)
        ```
        r   )axis)_CHECKPOINT_FOR_CODEBOOK_DOCr  r=   argmaxr-   r   z_logitss      r.   get_codebook_indices'FlavaImageCodebook.get_codebook_indicesE  sI    9 :V8V WCC_B` a		4 ;;|,||H1--r6   c                 X    U R                  U5      n[        R                  " SS9" U5      $ )Nr   r   )r  r   Softmaxr2  s      r.   get_codebook_probs%FlavaImageCodebook.get_codebook_probsc  s$    ;;|,zza **r6   c                 4   S[          S[          S3  [        UR                  5      S:w  a  [        SUR                   S35      eUR                  S   U R                  :w  a(  [        SUR                  S    S	U R                   35      eU R                  U5      $ )
NaJ  
        Args:
            pixel_values (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)`):
                Pixel values. Codebook pixel values can be obtained using [`AutoImageProcessor`] by passing
                `return_codebook_pixels=True`. See [`FlavaImageProcessor.__call__`] for details.

        Examples:

        ```python
        >>> from PIL import Image
        >>> import httpx
        >>> from io import BytesIO
        >>> from transformers import AutoImageProcessor, FlavaImageCodebook

        >>> model = FlavaImageCodebook.from_pretrained("r.  a  ")

        >>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
        >>> with httpx.stream("GET", url) as response:
        ...     image = Image.open(BytesIO(response.read()))

        >>> inputs = image_processor([image], return_codebook_pixels=True, return_tensors="pt")
        >>> inputs = dict(pixel_values=inputs.codebook_pixel_values)

        >>> outputs = model(**inputs)
        >>> print(outputs.shape)
        (1, 196)
        ```
        r  zinput shape z
 is not 4dr   z
input has z channels but model built for )r0  lenr   r   r%  r  )r-   r   r  s      r.   r   FlavaImageCodebook.forwardg  s    9 :V8V WCC_B` a		: |!!"a'|L,>,>+?zJKKa D$7$77z,*<*<Q*?)@@^_c_r_r^stuu{{<((r6   )r  rk   rw   r%  r&  r$  r   )r8   r9   r:   r;   r  r   r?   r  r  r  r   rs   r=   r   r4  r8  r>   r   r@   r   r   s   @r.   r  r    s      $$$O!&+#*,(*, *,X. .%,, .<+u|| + +")E$5$5 ")ELL ") ")r6   r  c                   .   ^  \ rS rSrU 4S jrS rSrU =r$ )FlavaPredictionHeadTransformi  c                 p  > [         TU ]  5         [        R                  " UR                  UR                  5      U l        [        UR                  [        5      (       a  [        UR                     U l
        OUR                  U l
        [        R                  " UR                  UR                  S9U l        g )Nr   )rr   rs   r   r   rw   r  r   r.  r/  r	   transform_act_fnr   r   r   s     r.   rs   %FlavaPredictionHeadTransform.__init__  s~    YYv1163E3EF
f''--$*6+<+<$=D!$*$5$5D!f&8&8f>S>STr6   c                 l    U R                  U5      nU R                  U5      nU R                  U5      nU$ rd   )r  r@  r   r4  s     r.   r   $FlavaPredictionHeadTransform.forward  s4    

=1--m<}5r6   )r   r  r@  r8   r9   r:   r;   rs   r   r@   r   r   s   @r.   r>  r>    s    U r6   r>  c                   2   ^  \ rS rSrSU 4S jjrS rSrU =r$ )ru  i  c                 F  > [         TU ]  5         Xl        [        U5      U l        [
        R                  " UR                  UR                  SS9U l	        [
        R                  " [        R                  " UR                  5      5      U l        Ub  X R                  l        g g )NTr   )rr   rs   rk   r>  	transformr   r   rw   r   decoderru   r=   rv   r   weight)r-   rk   rI  r   s      r.   rs   "FlavaMaskedPredictionHead.__init__  ss    5f=yy!3!3V5F5FTRLLV->->!?@	"(LL r6   c                 J    U R                  U5      nU R                  U5      nU$ rd   )rG  rH  r  s     r.   r   !FlavaMaskedPredictionHead.forward  s"    NN1LLOr6   )r   rk   rH  rG  rd   rD  r   s   @r.   ru  ru    s    ) r6   ru  c                   .   ^  \ rS rSrU 4S jrS rSrU =r$ )FlavaITMHeadi  c                    > [         TU ]  5         Xl        [        U5      U l        [
        R                  " UR                  S5      U l        g )Nr   )	rr   rs   rk   rc  r  r   r   rw   seq_relationshipr   s     r.   rs   FlavaITMHead.__init__  s8    !&) "		&*<*<a @r6   c                 J    U R                  U5      nU R                  U5      nU$ rd   )r  rP  r  s     r.   r   FlavaITMHead.forward  s$    KKN!!!$r6   )rk   r  rP  rD  r   s   @r.   rN  rN    s    A r6   rN  c                   .   ^  \ rS rSrU 4S jrS rSrU =r$ )FlavaGlobalContrastiveHeadi  c                 P   > [         TU ]  5         Xl        UR                  U l        g rd   )rr   rs   rk   global_backprop_contrastiver   s     r.   rs   #FlavaGlobalContrastiveHead.__init__  s!    +1+M+M(r6   c                 D   [         R                  " U5      n[         R                  R                  5       (       a#  [         R                  R	                  5       (       d6  [         R
                  " UR                  S5      UR                  S9nU/nU/nGOUR                  S5      n[         R                  R                  5       n	U R                  (       ag  [         R                  R                  R                  R                  U5      n[         R                  R                  R                  R                  U5      nO[        U	5       V
s/ s H  n
[         R                  " U5      PM     nn
[        U	5       V
s/ s H  n
[         R                  " U5      PM     nn
[         R                  R                  Xa5        [         R                  R                  Xr5        U[         R                  R                  5       -  [         R
                  " XR                  S9-   n[         R                   " U5      n[         R                   " U5      n[         R"                  " XR%                  SS5      5      U-  n[         R"                  " X&R%                  SS5      5      U-  nXU4$ s  sn
f s  sn
f )Nr   r  r   )r=   expdistributedis_availableis_initializedr   r   r   get_world_sizerW  r   r   
all_gatherrN  
zeros_likeget_rankr   r  r   )r-   r   r!   r}  temperaturelabelsimage_embeddings_alltext_embeddings_alllocal_batch_size
world_sizer   logits_per_imagelogits_per_texts                r.   r   "FlavaGlobalContrastiveHead.forward  s   ii,  --//u7H7H7W7W7Y7Y\\"2"7"7":CSCZCZ[F$4#5 #2"3/44Q7**99;J// (-'8'8';';'F'F'Q'QRb'c$&+&7&7&:&:&E&E&P&PQ`&a#SXYcSd'eSda(8(8(ISd$'eSXYcSd&eSdau'7'78H'ISd#&e!!,,-AT!!,,-@R%(9(9(B(B(DDu|| )@)@H F  %yy)=>#ii(;< <<(8:W:WXY[\:]^all,,8V8VWXZ[8\]`kk&88 (f&es    J6 J)rk   rW  rD  r   s   @r.   rU  rU    s    N
9 9r6   rU  zk
    The FLAVA model for pretraining which outputs losses, embeddings, logits and transformer outputs.
    c            '       t  ^  \ rS rSrSSSSS.rS!S\S	\R                  S-  4U 4S
 jjjrS\	R                  4S jr\                 S"S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\S-  S\	R                  S-  S\	R                  S-  S\	R                  S-  S\S-  S\S\S-  S\S-  S\\	R                     \-  4$S jj5       rS rU =r$ )#FlavaForPreTrainingi  zmmm_text_head.decoder.biaszmim_head.decoder.biaszmlm_head.decoder.biaszmmm_image_head.decoder.bias)zmmm_text_head.biaszmim_head.biaszmlm_head.biaszmmm_image_head.biasNrk   image_codebookc                 l  > [         TU ]  U5        [        U5      U l        X l        U R                  c+  UR
                  (       a  [        UR                  5      U l        [        UR                  5      U l
        [        UR                  5      U l        [        U5      U l        [        UR                  5      U l        [        UR                  5      U l        [#        U5      U l        UR                  R&                  U l        UR                  R&                  U l        UR,                  U l        UR.                  U l        UR0                  U l        UR2                  U l        UR4                  U l        UR6                  U l        UR8                  U l        UR:                  U l        U R=                  5         g)z
image_codebook ([`nn.Module`]):
    If passed, the image codebook will be set to this. Otherwise, it will be initialized using the
    image_codebook_config defined in the config first as the first parameter.
N)rr   rs   r{  ro  rm  init_codebookr  image_codebook_configru  r  mim_headr  mlm_headrN  itm_headmmm_image_headmmm_text_headrU  global_contrastive_headr   image_vocab_sizetext_vocab_size
mlm_weight
mim_weightglobal_contrastive_weightce_ignore_index
itm_weightmmm_image_weightmmm_text_weight skip_unmasked_multimodal_encoderr  )r-   rk   rm  r   s      r.   rs   FlavaForPreTraining.__init__  sO    	 '
,&6+?+?"4V5Q5Q"RD 2&2E2EF1&2D2DE$V,78K8KL6v7I7IJ'A&'I$ & 3 3 > >%11<< ++ ++)/)I)I&%55 ++ & 7 7%55060W0W-r6   r   c                 p    UR                  5       S:  a!  UR                  UR                  S5      S5      nU$ )Nr   r   r   )r   r   r   r  s     r.   _resize_to_2d!FlavaForPreTraining._resize_to_2d  s,    557Q;qvvay"%Ar6   r   input_ids_maskedr   codebook_pixel_valuesr   r   r   r   r  r  
mlm_labels
mim_labels
itm_labelsr   rS  rT  return_lossr%   c                    Ub  UOU R                   R                  nUb  UOU R                   R                  nU
b  U
OU R                  n
Uc  Ub  [        R                  S5        UnU R                  UUUUUU	U
UUSS9
nU R                  UUUUU	UUUSS9	nSnUR                  nUR                  nUR                  nUR                  nUR                  nS=n=n=n=n=n=n n!S=n"=n#=n$n%S=n&=n'n(Uc  UbK  UcH  U(       aA  U R                  c  [        S5      eUc  [        S5      eU R                  R                  U5      nU R                  S:  Ga  UGb  UGc  Un)Ub  U R                  U5      nU R                  U5      nU R                   XR#                  S5      '   U)SS2UR%                  S	5      * S2SS24   n)UR#                  U R                   5      n*UU*   n+U)U*SS24   n)U R'                  U)5      n"U(       aX  [(        R*                  R-                  U"R/                  S
U R0                  5      U+R/                  S
5      5      nUU R                  -  nOU R'                  U)5      n"U R2                  S:  a  Ub  Uc  Un,Ub  U R                  U5      nU,SS2UR%                  S	5      * S2SS24   n,UR#                  U R                   5      n*UU*   n-U,U*SS24   n,U R5                  U,5      n#U(       aX  [(        R*                  R-                  U#R/                  S
U R6                  5      U-R/                  S
5      5      nUU R2                  -  nOU R5                  U,5      n#U R8                  S:  a  Ub  U R;                  U5      n&Ub  UR#                  S5      n.[<        R>                  " U.RA                  5       U.U.RC                  S/5      5      nU(       a/  [(        R*                  R-                  U&U5      n!U!U R8                  -  n!Ub  UU   nUb  UU   nUb
  UU   nUU   nUGb%  U RD                  S:  Ga  Un)UR%                  S	5      S	-
  n/U)SS2SSU/-   2SS24   n)Ub  U R                  U5      nU R                  U5      nU R                   XR#                  S5      '   UR#                  U R                   5      n*UU*   n+U)U*SS24   n)U RG                  U)5      n%U(       aX  [(        R*                  R-                  U%R/                  S
U R0                  5      U+R/                  S
5      5      nUU RD                  -  nOU RG                  U)5      n%Ub  U RH                  S:  a  Un,U,SS2UR%                  S	5      * S2SS24   n,Ub  U R                  U5      nUR#                  U R                   5      n*UU*   n-U,U*SS24   n,U RK                  U,5      n$U(       aX  [(        R*                  R-                  U$R/                  S
U R6                  5      U-R/                  S
5      5      nUU RH                  -  nOU RK                  U,5      n$UGb  UGb{  U RL                  S:  Gaj  U R                  RO                  USS2SSS24   5      n0[(        R*                  RQ                  U0S
S9n0U R                  RS                  USS2SSS24   5      n1[(        R*                  RQ                  U1S
S9n1U RT                  (       a8  U R                  RV                  RX                  R[                  [\        [^        5        U Ra                  U1U0U R                  RV                  5      u  n'n(n2Ub  U'U   n'U(U   n(U2U   n2U(       aW  [(        R*                  R-                  U'U25      n3[(        R*                  R-                  U(U25      n4U3U4-   S-  n U U RL                  -  n [c        UUU!U UUS9n5U(       a5  U5Re                  5       (       d   [g        S U5Ri                  5        5       5      nU(       Gd>  UURj                  b  URj                  Rm                  5       OSUURn                  b  URn                  Rm                  5       OSUR                  URp                  b  URp                  Rm                  5       OSUURj                  b  URj                  Rm                  5       OSUURn                  b  URn                  Rm                  5       OSUURp                  b  URp                  Rm                  5       OSU"U#U&U'U'U%U$4n6U(       a  U5Re                  5       (       d  UU54U6-   n6[s        S U6 5       5      $ [u        S%0 SU_SU5_SU_SURj                  _SU_SURn                  _SUR                  _SURp                  _SU_SURj                  _SU_SURn                  _SU_SURp                  _SU"_SU#_S U&_S!U'_S"U(_S#U%_S$U$_6$ )&a  
input_ids (`torch.LongTensor` of shape `(batch_size, text_seq_len)`):
    Indices of input sequence tokens in the vocabulary. Indices can be obtained using [`AutoTokenizer`]. See
    [`PreTrainedTokenizer.encode`] and [`PreTrainedTokenizer.__call__`] for details. [What are input
    IDs?](../glossary#input-ids)
input_ids_masked (`torch.LongTensor` of shape `(batch_size, text_seq_len)`):
    Indices of input sequence tokens in the vocabulary. These ones are the masked version of the original task
    to be used with MLM. Indices can be obtained using [`AutoTokenizer`] along with
    [`DataCollatorForMaskedLanguageModeling`]. See [`PreTrainedTokenizer.encode`] and
    [`PreTrainedTokenizer.__call__`] for details. [What are input IDs?](../glossary#input-ids)
codebook_pixel_values (`torch.FloatTensor` of shape `(batch_size, num_image_patches, patch_size, patch_size, 3)`, *optional*):
    Pixel values for image patches that are used to compute the image codebook labels for masked image modeling.
token_type_ids (`torch.LongTensor` of shape `(batch_size, text_seq_len)`, *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)
bool_masked_pos (`torch.BoolTensor` of shape `(batch_size, image_num_patches)`):
    Boolean masked positions. Indicates which patches are masked (1) and which aren't (0).
image_attention_mask (`torch.FloatTensor` of shape `(batch_size, image_num_patches)`, *optional*):
    Mask to avoid performing attention on padding token indices specifically for images. 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)
skip_unmasked_multimodal_encoder (*bool*, *optional*):
    Skip any calculations for multimodal encoder for unmasked inputs. FLAVA pretraining doesn't need unmasked
    multimodal embeddings or outputs as of now.
mlm_labels (`torch.LongTensor` of shape `(batch_size, text_seq_len)`, *optional*):
    Labels for computing the left-to-right language and multimodal masked modeling loss (next word prediction).
    Indices should be in `[-100, 0, ..., text_config.vocab_size - 1]` (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,
    ..., text_config.vocab_size - 1]`.
mim_labels (`torch.LongTensor` of shape `(batch_size, image_num_patches)`, *optional*):
    Labels for computing the image and multimodal masked modeling loss. Indices should be in `[-100, 0, ...,
    image_config.vocab_size - 1]`. Tokens with indices set to `-100` are ignored (masked), the loss is only
    computed for the tokens with labels in `[0, ..., image_config.vocab_size - 1]`. If not passed, they are
    generated automatically using the image codebook assigned to the model. By default, it uses
    [`FlavaImageCodebook`]. See [`FlavaImageCodebook`] to understand how to generate mim_labels.
itm_labels (`torch.LongTensor` of shape `(batch_size, 1)`, *optional*):
    Labels for computing the image-text matching loss. 0 means the pairs don't match and 1 means they match.
    The pairs with 0 will be skipped for calculation of MMM and global contrastive losses as well.
return_loss (`bool`, *optional*, default to None):
    Whether to return calculated loss or not.

Examples:
```python
>>> from PIL import Image
>>> import httpx
>>> from io import BytesIO
>>> from transformers import FlavaForPreTraining, AutoProcessor

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> with httpx.stream("GET", url) as response:
...     image = Image.open(BytesIO(response.read()))

>>> model = FlavaForPreTraining.from_pretrained("facebook/flava-full")
>>> processor = AutoProcessor.from_pretrained("facebook/flava-full")

>>> text = ["a photo of a cat"]

>>> inputs = processor(
...     images=[image],
...     text=text,
...     return_masks=True,
...     return_codebook_pixels=True,
...     padding=True,
...     max_length=77,
...     return_tensors="pt",
... )


>>> output = model(**inputs)
```
Nz`input_ids_masked` isn't passed which means MLM loss won't be calculated correctlySetting it to `input_ids` so that model can work. Please pass it if this is unintentional. This is usually OKAY if you are doing inference on unmasked text...T)
r   r   r   r   r   r  r  r   rS  rT  )	r   r   r   r   r  r   r   rS  rT  z`return_loss` is set to True but the image codebook is not initialized and no `mim_labels`  have been passed. Reinstantiate the model with `init_codebook` set to True or pass in your custom `mim_labels`z`codebook_pixel_value` are required to generate `mim_labels` if loss is expected. Call `AutoProcessor` with `return_codebook_pixels` set to Truer   r   r   r   r   )rD   rE   rF   rG   rH   rI   c              3   .   #    U  H  ob  UOSv   M     g 7fri  r7   )r+   rS   s     r.   r/   .FlavaForPreTraining.forward.<locals>.<genexpr>O  s     _I^%5T1<I^s   c              3   .   #    U  H  ob  M  Uv   M     g 7frd   r7   )r+   r   s     r.   r/   r  p  s     8FqFrX  rS   rT   r   r    r!   r"   r#   r$   rU   rV   rW   rX   rY   rZ   r[   r\   r]   r^   r_   r`   ra   r7   );rk   rT  r  r  loggerwarningro  r   r!   r#   rm  RuntimeErrorr   r4  rz  r  r|  ner   rq  r   r   cross_entropyr   rw  ry  rr  rx  r}  rs  r=   whereanynewr~  rt  r  ru  r{  r  	normalizer  trainingr}  dataclamp_LOGIT_SCALE_CLAMP_MINLOGIT_SCALE_CLAMP_MAXrv  rB   rL   sumrK   r    r*   r"   r$   r2   rQ   )7r-   r   r  r   r  r   r   r   r   r  r  r  r  r  r   rS  rT  r  r  flava_outputflava_masked_outputpos_maskr   r!   rU   rW   rY   
total_lossmim_lossmlm_lossmmm_text_lossmmm_image_lossgc_lossitm_lossr[   r\   ra   r`   r]   rh  ri  sequence_for_imagemasked_tokensmim_labels_filteredsequence_for_textmlm_labels_filtered	pos_pairs	end_indextext_embeddingimage_embedding	gc_labelsgc_loss_imagegc_loss_textflava_lossesr"  s7                                                          r.   r   FlavaForPreTraining.forward  s
   D &1%<k$++BYBY%0%<k$++BYBY 0; -66 	) #	(=NN?
  )zz%))%!5 %E/!5 " 
  #jj&%))!5+/!5 ) 

 '88&66"5"F"F!4!D!D':'P'P$aee
eXee=e>eGV^GKK
KZK/4D:>>
>% #.2N2Z!k&&.&; 
 )0$Y  "00EEF[\
 ??Q#:#FKgKo!8%!//
;
"&"4"4_"E7;7K7K
--d34%7JOOA<N;N;PRS8S%T" *d.B.B C&0&?#%7q8H%I"!]]+=>
!}}::"D,A,ABDWD\D\]_D` H /H!]]+=>
 ??Q#9#EJfJn 6%!//
;
$5a*//!:L9L9NPQ6Q$R! *d.B.B C&0&?#$5mQ6F$G!!]]+<=
!}}::"D,@,@ACVC[C[\^C_ H /H!]]+<=
 ??Q#?#K'CDJ%&MM!,	 ;;y}}	9==RVQWCXY!}}:::zRH/H/;3OPX3Y0)!+H!5J)!+H!5J&5h&?O (38M8MPQ8Q!=/44Q7!;I!3Aq1y=7H!4K!L%!//
;
"&"4"4_"E7;7K7K
--d34 *d.B.B C&0&?#%7q8H%I"#'#6#67I#J %']]%@%@(--b$2G2GHJ]JbJbceJf&N #d&;&;;N#'#6#67I#J  (38L8Lq8P < 1!6L6Q6QRS6T5T5VXY2Y Z%!//
;
 *d.B.B C&0&?#$5mQ6F$G!"&"4"45F"G$&MM$?$?',,R1E1EFH[H`H`acHd%M "T%9%99M"&"4"45F"G 'O,GDLjLjmnLn!ZZ771a8PQN]]44^4LN"jj99:J1aQR7:STO mm55o25NO}}

&&++223HJ_`;?;W;W1G1G<8oy
 ##3H#= "1(";%h/	 " ; ;<Li X!}}::?IV(<71<4999"&$"
 |4466_I\I\I^__J 8D8Q8Q8]))224cg7C7O7O7[((113ae22=I=[=[=g..779mq'?R?_?_?k#0099;qu&>Q>]>]>i#//88:os,&88D $55>>@   +F. <#8#8#:#:   8F888( 

"
 .
 &22	

 ,
 %00
 #/"D"D
 +<<
 %<
 !4 @ @
 $:
  3>>
 *F
 &9%J%J
 "
  "!
" "#
$ *:%
& )8'
( .)
* ,+
 	
r6   )r|  ro  rv  r{  rm  rw  rs  r}  rq  rz  rr  ry  rt  r~  ru  r  r  rx  rd   )NNNNNNNNNNNNNNTNN)r8   r9   r:   r;   _tied_weights_keysr   r   r  rs   r=   r   r  r   r  r>   rO   r2   rQ   r   r@   r   r   s   @r.   rl  rl    s    ;00<	!{ !BII<L ! !Fu|| 
  .24815:>.2.2/304488<*.*.*.)-%)#'#'%o
##d*o
  **T1o
 ''$.	o

  %0047o
 t+o
 t+o
 ,o
 &&-o
 $llT1o
 +/+o
 LL4'o
 LL4'o
 LL4'o
  $;o
  #!o
" D[#o
$ D[%o
( 
u||	8	8)o
 o
r6   rl  )rl  r  r  r{  ry  rn  r  )Jr<   r   r  r   dataclassesr   typingr   r=   r    r   rv  activationsr	   modeling_layersr
   modeling_outputsr   r   modeling_utilsr   processing_utilsr   utilsr   r   r   r   r   r   configuration_flavar   r   r   r   r   
get_loggerr8   r  r0  r  r  r  r   rB   rQ   r  ri   ry   r   r   r  r  r+  r8  r>  rK  rc  rn  r  r  ry  r{  r  r  r
  r  r>  ru  rN  rU  rl  __all__r7   r6   r.   <module>r     s)      # !    & ! 9 K - & j j  
		H	%>   &)99<QQ  
{ 
 
< 
 +  D Wt Wt Wtx_299 _H!bii !H3")) 3l6 6rbii $RYY ,		 ""))  )+ )X$
299 $
N"))  S? S S6 N
* N
 N
b `
) `
 `
F N
/ N
 N
b ^
% ^
 ^
B			 *Cbii C"299 ( w)- w)w)t299 "		  
299 
%9 %9P 
a
. a

a
Hr6   