modular_t5gemma.py 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239
  1. # coding=utf-8
  2. # Copyright 2025 Google Inc. HuggingFace Inc. team. All rights reserved.
  3. #
  4. #
  5. # Licensed under the Apache License, Version 2.0 (the "License");
  6. # you may not use this file except in compliance with the License.
  7. # You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. from typing import Any, Callable, Optional, Union
  17. import torch
  18. import torch.nn as nn
  19. from ...cache_utils import Cache, DynamicCache, EncoderDecoderCache
  20. from ...configuration_utils import PretrainedConfig
  21. from ...generation import GenerationMixin
  22. from ...modeling_flash_attention_utils import FlashAttentionKwargs
  23. from ...modeling_layers import GradientCheckpointingLayer
  24. from ...modeling_outputs import (
  25. BaseModelOutput,
  26. BaseModelOutputWithPastAndCrossAttentions,
  27. Seq2SeqLMOutput,
  28. Seq2SeqModelOutput,
  29. SequenceClassifierOutput,
  30. TokenClassifierOutput,
  31. )
  32. from ...modeling_utils import ALL_ATTENTION_FUNCTIONS, PreTrainedModel
  33. from ...processing_utils import Unpack
  34. from ...utils import (
  35. TransformersKwargs,
  36. auto_docstring,
  37. can_return_tuple,
  38. logging,
  39. )
  40. from ...utils.deprecation import deprecate_kwarg
  41. from ...utils.generic import OutputRecorder, check_model_inputs
  42. from ..gemma2.configuration_gemma2 import Gemma2Config
  43. from ..gemma2.modeling_gemma2 import (
  44. Gemma2Attention,
  45. Gemma2MLP,
  46. Gemma2PreTrainedModel,
  47. Gemma2RMSNorm,
  48. Gemma2RotaryEmbedding,
  49. create_causal_mask,
  50. create_sliding_window_causal_mask,
  51. eager_attention_forward,
  52. )
  53. _CHECKPOINT_FOR_DOC = "google/t5gemma-2b-2b-prefixlm-it"
  54. logger = logging.get_logger(__name__)
  55. class T5GemmaModuleConfig(Gemma2Config):
  56. pass
  57. class T5GemmaConfig(PretrainedConfig):
  58. r"""
  59. This is the configuration class to store the configuration of a [`T5GemmaModel`]. It is used to instantiate an T5Gemma
  60. model according to the specified arguments, defining the model architecture. Instantiating a configuration with the
  61. defaults will yield a similar configuration to a hypothetical balanced Gemma2 encoder-decoder model.
  62. e.g. [google/t5gemma-2b-2b-prefixlm-it](https://huggingface.co/google/t5gemma-2b-2b-prefixlm-it)
  63. ```python
  64. >>> from transformers import T5GemmaConfig, T5GemmaModel
  65. >>> t5gemma_config = T5GemmaConfig.from_pretrained("google/t5gemma-2b-2b-prefixlm-it")
  66. >>> model = T5GemmaModel(t5gemma_config)
  67. ```
  68. Configuration objects inherit from [PretrainedConfig] and can be used to control the model outputs. Read the
  69. documentation from [PretrainedConfig] for more information.
  70. Args:
  71. encoder (`Union[T5GemmaModuleConfig, dict]`, optional, *optional*):
  72. Configuration for the encoder.
  73. decoder (`Union[T5GemmaModuleConfig, dict]`, optional, *optional*):
  74. Configuration for the decoder.
  75. is_encoder_decoder (bool, optional, *optional*, defaults to `True`):
  76. Whether the model is used as an encoder/decoder or not.
  77. dropout_rate (`float`, *optional*, defaults to 0.0):
  78. The ratio for all dropout layers (following T5).
  79. classifier_dropout_rate (`float`, *optional*, defaults to 0.0):
  80. The dropout ratio for classifier (following T5).
  81. attention_dropout (`float`, *optional*, defaults to 0.0):
  82. The dropout ratio for attention.
  83. tie_word_embeddings (`bool`, *optional*, defaults to `True`):
  84. Whether tie input and output embeddings.
  85. vocab_size (`int`, *optional*, defaults to 256000):
  86. Vocabulary size of the T5Gemma model (the same as Gemma 2).
  87. kwargs (additional keyword arguments, optional, *optional*):
  88. Will be passed to the PretrainedConfig base class.
  89. """
  90. model_type = "t5gemma"
  91. keys_to_ignore_at_inference = ["past_key_values"]
  92. base_model_tp_plan = {
  93. # encoder
  94. "encoder.layers.*.self_attn.q_proj": "colwise",
  95. "encoder.layers.*.self_attn.k_proj": "colwise",
  96. "encoder.layers.*.self_attn.v_proj": "colwise",
  97. "encoder.layers.*.self_attn.o_proj": "rowwise",
  98. "encoder.layers.*.mlp.gate_proj": "colwise",
  99. "encoder.layers.*.mlp.up_proj": "colwise",
  100. "encoder.layers.*.mlp.down_proj": "rowwise",
  101. # decoder
  102. "decoder.layers.*.self_attn.q_proj": "colwise",
  103. "decoder.layers.*.self_attn.k_proj": "colwise",
  104. "decoder.layers.*.self_attn.v_proj": "colwise",
  105. "decoder.layers.*.self_attn.o_proj": "rowwise",
  106. "decoder.layers.*.cross_attn.q_proj": "colwise",
  107. "decoder.layers.*.cross_attn.k_proj": "colwise",
  108. "decoder.layers.*.cross_attn.v_proj": "colwise",
  109. "decoder.layers.*.cross_attn.o_proj": "rowwise",
  110. "decoder.layers.*.mlp.gate_proj": "colwise",
  111. "decoder.layers.*.mlp.up_proj": "colwise",
  112. "decoder.layers.*.mlp.down_proj": "rowwise",
  113. }
  114. base_model_pp_plan = {
  115. # encoder
  116. "encoder.embed_tokens": (["input_ids"], ["inputs_embeds"]),
  117. "encoder.layers": (["hidden_states", "attention_mask"], ["hidden_states"]),
  118. "encoder.norm": (["hidden_states"], ["hidden_states"]),
  119. # decoder
  120. "decoder.embed_tokens": (["input_ids"], ["inputs_embeds"]),
  121. "decoder.layers": (["hidden_states", "attention_mask"], ["hidden_states"]),
  122. "decoder.norm": (["hidden_states"], ["hidden_states"]),
  123. }
  124. def __init__(
  125. self,
  126. encoder: Optional[Union[T5GemmaModuleConfig, dict[Any, Any]]] = None,
  127. decoder: Optional[Union[T5GemmaModuleConfig, dict[Any, Any]]] = None,
  128. is_encoder_decoder: bool = True,
  129. dropout_rate: float = 0.0,
  130. classifier_dropout_rate: float = 0.0,
  131. attention_dropout: float = 0.0,
  132. tie_word_embeddings: bool = True,
  133. vocab_size: int = 256000,
  134. **kwargs,
  135. ):
  136. if isinstance(encoder, dict):
  137. encoder = T5GemmaModuleConfig(**encoder)
  138. elif encoder is None:
  139. encoder = T5GemmaModuleConfig()
  140. else:
  141. assert isinstance(encoder, T5GemmaModuleConfig), f"{type(encoder)} is not supported."
  142. if isinstance(decoder, dict):
  143. decoder = T5GemmaModuleConfig(**decoder)
  144. elif decoder is None:
  145. decoder = encoder
  146. else:
  147. assert isinstance(decoder, T5GemmaModuleConfig), f"{type(decoder)} is not supported."
  148. encoder = T5GemmaModuleConfig(**encoder.to_dict())
  149. decoder = T5GemmaModuleConfig(**decoder.to_dict())
  150. encoder.is_decoder = False
  151. encoder.dropout_rate = dropout_rate
  152. encoder.attention_dropout = attention_dropout
  153. self.encoder = encoder
  154. decoder.is_decoder = True
  155. decoder.use_cache = True
  156. decoder.dropout_rate = dropout_rate
  157. decoder.attention_dropout = attention_dropout
  158. decoder.cross_attention_hidden_size = encoder.hidden_size
  159. self.decoder = decoder
  160. for special_token_key in ["bos_token_id", "pad_token_id", "eos_token_id"]:
  161. if special_token_key not in kwargs:
  162. kwargs[special_token_key] = getattr(decoder, special_token_key)
  163. super().__init__(**kwargs)
  164. self.is_encoder_decoder = is_encoder_decoder
  165. self.use_cache = kwargs.get("use_cache", decoder.use_cache)
  166. self.initializer_range = kwargs.get("initializer_range", decoder.initializer_range)
  167. self.dropout_rate = dropout_rate
  168. self.attention_dropout = attention_dropout
  169. self.classifier_dropout_rate = classifier_dropout_rate
  170. self.tie_word_embeddings = tie_word_embeddings
  171. # Used in pipeline generation.
  172. self.vocab_size = vocab_size
  173. def __setattr__(self, key, value):
  174. shared_attr_with_submodules = [
  175. "output_hidden_states",
  176. "output_attentions",
  177. "_attn_implementation",
  178. "dropout_rate",
  179. "attention_dropout",
  180. "vocab_size",
  181. ]
  182. if key in shared_attr_with_submodules:
  183. setattr(self.encoder, key, value)
  184. setattr(self.decoder, key, value)
  185. super().__setattr__(key, value)
  186. class T5GemmaRMSNorm(Gemma2RMSNorm):
  187. pass
  188. class T5GemmaMLP(Gemma2MLP):
  189. def __init__(self, config):
  190. super().__init__(config)
  191. self.dropout = nn.Dropout(config.dropout_rate)
  192. def forward(self, x):
  193. hidden_states = self.act_fn(self.gate_proj(x)) * self.up_proj(x)
  194. hidden_states = self.dropout(hidden_states)
  195. down_proj = self.down_proj(hidden_states)
  196. return down_proj
  197. class T5GemmaRotaryEmbedding(Gemma2RotaryEmbedding):
  198. def __init__(self, config, device=None):
  199. super().__init__(config, device)
  200. class T5GemmaSelfAttention(Gemma2Attention):
  201. def __init__(self, config: T5GemmaModuleConfig, layer_idx: int):
  202. super().__init__(config, layer_idx)
  203. # Required by flash attention: encoder selfattention is non-causal
  204. self.is_causal = config.is_decoder
  205. class T5GemmaCrossAttention(Gemma2Attention):
  206. def __init__(self, config: T5GemmaModuleConfig, layer_idx: int):
  207. super().__init__(config, layer_idx)
  208. del self.sliding_window
  209. self.is_causal = False
  210. if config.cross_attention_hidden_size is None:
  211. raise ValueError("Cross-attention needs cross_attention_hidden_size to be specified.")
  212. self.k_proj = nn.Linear(
  213. config.cross_attention_hidden_size, config.num_key_value_heads * self.head_dim, bias=config.attention_bias
  214. )
  215. self.v_proj = nn.Linear(
  216. config.cross_attention_hidden_size, config.num_key_value_heads * self.head_dim, bias=config.attention_bias
  217. )
  218. @deprecate_kwarg("past_key_value", new_name="past_key_values", version="4.58")
  219. def forward(
  220. self,
  221. hidden_states: torch.Tensor,
  222. attention_mask: Optional[torch.Tensor],
  223. encoder_hidden_states: Optional[torch.Tensor],
  224. past_key_values: Optional[Cache] = None,
  225. **kwargs: Unpack[FlashAttentionKwargs],
  226. ) -> tuple[torch.Tensor, Optional[torch.Tensor], Optional[tuple[torch.Tensor]]]:
  227. if encoder_hidden_states is None:
  228. raise ValueError("Encoder hidden state is required for cross attention.")
  229. input_shape = hidden_states.shape[:-1]
  230. hidden_shape = (*input_shape, -1, self.head_dim)
  231. query_states = self.q_proj(hidden_states).view(hidden_shape).transpose(1, 2)
  232. if past_key_values is not None:
  233. is_updated = past_key_values.is_updated.get(self.layer_idx)
  234. curr_past_key_value = past_key_values.cross_attention_cache
  235. if past_key_values is None or not is_updated:
  236. encoder_input_shape = encoder_hidden_states.shape[:-1]
  237. encoder_hidden_shape = (*encoder_input_shape, -1, self.head_dim)
  238. key_states = self.k_proj(encoder_hidden_states).view(encoder_hidden_shape).transpose(1, 2)
  239. value_states = self.v_proj(encoder_hidden_states).view(encoder_hidden_shape).transpose(1, 2)
  240. if past_key_values is not None:
  241. key_states, value_states = curr_past_key_value.update(key_states, value_states, self.layer_idx)
  242. past_key_values.is_updated[self.layer_idx] = True
  243. else:
  244. key_states = curr_past_key_value.layers[self.layer_idx].keys
  245. value_states = curr_past_key_value.layers[self.layer_idx].values
  246. attention_interface: Callable = eager_attention_forward
  247. if self.config._attn_implementation != "eager":
  248. attention_interface = ALL_ATTENTION_FUNCTIONS[self.config._attn_implementation]
  249. attn_output, attn_weights = attention_interface(
  250. self,
  251. query_states,
  252. key_states,
  253. value_states,
  254. attention_mask,
  255. dropout=self.attention_dropout if self.training else 0.0,
  256. scaling=self.scaling,
  257. sliding_window=None,
  258. softcap=self.attn_logit_softcapping,
  259. **kwargs,
  260. )
  261. attn_output = attn_output.reshape(*input_shape, -1).contiguous()
  262. attn_output = self.o_proj(attn_output)
  263. return attn_output, attn_weights
  264. def bidirectional_mask_function(attention_mask: Optional[torch.Tensor]) -> Callable:
  265. """
  266. This creates bidirectional attention mask.
  267. """
  268. def inner_mask(batch_idx: int, head_idx: int, q_idx: int, kv_idx: int) -> bool:
  269. if attention_mask is None:
  270. return torch.ones((), dtype=torch.bool)
  271. return attention_mask[batch_idx, kv_idx].to(torch.bool)
  272. return inner_mask
  273. def sliding_window_bidirectional_mask_function(sliding_window: int) -> Callable:
  274. """
  275. This creates bidirectional attention mask with sliding window.
  276. """
  277. def inner_mask(batch_idx: int, head_idx: int, q_idx: int, kv_idx: int) -> bool:
  278. return (q_idx - sliding_window < kv_idx) & (kv_idx < q_idx + sliding_window)
  279. return inner_mask
  280. class T5GemmaEncoderLayer(GradientCheckpointingLayer):
  281. """Encoder sub-layer."""
  282. def __init__(self, config, layer_idx: int):
  283. super().__init__()
  284. self.hidden_size = config.hidden_size
  285. self.config = config
  286. self.layer_idx = layer_idx
  287. self.attention_type = config.layer_types[layer_idx]
  288. self.self_attn = T5GemmaSelfAttention(
  289. config=config,
  290. layer_idx=layer_idx,
  291. )
  292. self.pre_self_attn_layernorm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  293. self.post_self_attn_layernorm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  294. self.mlp = T5GemmaMLP(config)
  295. self.pre_feedforward_layernorm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  296. self.post_feedforward_layernorm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  297. self.dropout = nn.Dropout(config.dropout_rate)
  298. def forward(
  299. self,
  300. hidden_states: torch.Tensor,
  301. position_embeddings: tuple[torch.Tensor, torch.Tensor],
  302. attention_mask: Optional[torch.Tensor] = None,
  303. position_ids: Optional[torch.LongTensor] = None,
  304. **kwargs,
  305. ) -> tuple[torch.FloatTensor,]:
  306. residual = hidden_states
  307. hidden_states = self.pre_self_attn_layernorm(hidden_states)
  308. hidden_states, _ = self.self_attn(
  309. hidden_states=hidden_states,
  310. position_embeddings=position_embeddings,
  311. attention_mask=attention_mask,
  312. position_ids=position_ids,
  313. past_key_values=None,
  314. **kwargs,
  315. )
  316. hidden_states = self.post_self_attn_layernorm(hidden_states)
  317. hidden_states = residual + self.dropout(hidden_states)
  318. residual = hidden_states
  319. hidden_states = self.pre_feedforward_layernorm(hidden_states)
  320. hidden_states = self.mlp(hidden_states)
  321. hidden_states = self.post_feedforward_layernorm(hidden_states)
  322. hidden_states = residual + self.dropout(hidden_states)
  323. return hidden_states
  324. class T5GemmaDecoderLayer(T5GemmaEncoderLayer):
  325. """Decoder sub-layer: an extra cross-attention layer."""
  326. def __init__(self, config, layer_idx: int):
  327. super().__init__(config, layer_idx)
  328. self.cross_attn = T5GemmaCrossAttention(config=config, layer_idx=layer_idx)
  329. self.pre_cross_attn_layernorm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  330. self.post_cross_attn_layernorm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  331. @deprecate_kwarg("past_key_value", new_name="past_key_values", version="4.58")
  332. def forward(
  333. self,
  334. hidden_states: torch.Tensor,
  335. position_embeddings: tuple[torch.Tensor, torch.Tensor],
  336. attention_mask: Optional[torch.Tensor] = None,
  337. position_ids: Optional[torch.LongTensor] = None,
  338. past_key_values: Optional[EncoderDecoderCache] = None,
  339. use_cache: Optional[bool] = False,
  340. cache_position: Optional[torch.LongTensor] = None,
  341. encoder_hidden_states: Optional[torch.Tensor] = None,
  342. encoder_attention_mask: Optional[torch.Tensor] = None,
  343. **kwargs,
  344. ) -> torch.FloatTensor:
  345. residual = hidden_states
  346. hidden_states = self.pre_self_attn_layernorm(hidden_states)
  347. hidden_states, _ = self.self_attn(
  348. hidden_states=hidden_states,
  349. position_embeddings=position_embeddings,
  350. attention_mask=attention_mask,
  351. position_ids=position_ids,
  352. past_key_values=past_key_values.self_attention_cache if past_key_values is not None else None,
  353. use_cache=use_cache,
  354. cache_position=cache_position,
  355. **kwargs,
  356. )
  357. hidden_states = self.post_self_attn_layernorm(hidden_states)
  358. hidden_states = residual + self.dropout(hidden_states)
  359. residual = hidden_states
  360. hidden_states = self.pre_cross_attn_layernorm(hidden_states)
  361. hidden_states, _ = self.cross_attn(
  362. hidden_states=hidden_states,
  363. encoder_hidden_states=encoder_hidden_states,
  364. attention_mask=encoder_attention_mask,
  365. past_key_values=past_key_values,
  366. use_cache=use_cache,
  367. **kwargs,
  368. )
  369. hidden_states = self.post_cross_attn_layernorm(hidden_states)
  370. hidden_states = residual + self.dropout(hidden_states)
  371. residual = hidden_states
  372. hidden_states = self.pre_feedforward_layernorm(hidden_states)
  373. hidden_states = self.mlp(hidden_states)
  374. hidden_states = self.post_feedforward_layernorm(hidden_states)
  375. hidden_states = residual + self.dropout(hidden_states)
  376. return hidden_states
  377. class T5GemmaClassificationHead(nn.Module):
  378. """Head for sentence-level classification tasks."""
  379. def __init__(self, hidden_size: int, num_labels: int, classifier_dropout_rate: float = 0.0):
  380. super().__init__()
  381. self.dropout = nn.Dropout(p=classifier_dropout_rate)
  382. self.out_proj = nn.Linear(hidden_size, num_labels)
  383. def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
  384. hidden_states = self.dropout(hidden_states)
  385. hidden_states = self.out_proj(hidden_states)
  386. return hidden_states
  387. class T5GemmaLMHead(nn.Module):
  388. """Head for language modeling (generation) tasks."""
  389. def __init__(self, hidden_size: int, vocab_size: int, bias: bool = False):
  390. super().__init__()
  391. self.out_proj = nn.Linear(hidden_size, vocab_size, bias=bias)
  392. def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
  393. logits = self.out_proj(hidden_states)
  394. return logits
  395. @auto_docstring
  396. class T5GemmaPreTrainedModel(Gemma2PreTrainedModel):
  397. config: T5GemmaConfig
  398. base_model_prefix = "model"
  399. supports_gradient_checkpointing = True
  400. _no_split_modules = ["T5GemmaEncoderLayer", "T5GemmaDecoderLayer"]
  401. def _init_weights(self, module):
  402. # TODO: support initialization for encoders and decoders separately(?)
  403. PreTrainedModel._init_weights(self, module)
  404. std = self.config.initializer_range
  405. if isinstance(module, T5GemmaClassificationHead):
  406. scale = module.out_proj.weight.shape[0] ** -0.5
  407. module.out_proj.weight.data.normal_(mean=0.0, std=std * scale)
  408. if hasattr(module.out_proj, "bias") and module.out_proj.bias is not None:
  409. module.out_proj.bias.data.zero_()
  410. elif isinstance(module, T5GemmaLMHead):
  411. if not self.config.tie_word_embeddings:
  412. scale = module.out_proj.weight.shape[0] ** -0.5
  413. module.out_proj.weight.data.normal_(mean=0.0, std=std * scale)
  414. # We initialize with 0s to be 1 centered as the RMSNorm here does (1 + weight)
  415. elif "RMSNorm" in module.__class__.__name__:
  416. module.weight.data.zero_()
  417. def _shift_right(self, input_ids):
  418. """
  419. Shifts input_ids to the right, prepends the decoder_start_token_id, and handles
  420. pad_token_id replacement for labels that were -100.
  421. This is a common preparation step for decoder inputs in sequence-to-sequence models.
  422. """
  423. decoder_start_token_id = self.config.decoder.bos_token_id
  424. pad_token_id = self.config.decoder.pad_token_id
  425. if decoder_start_token_id is None:
  426. raise ValueError("self.model.config.decoder.bos_token_id has to be defined. ")
  427. # shift inputs to the right
  428. shifted_input_ids = input_ids.new_zeros(input_ids.shape)
  429. shifted_input_ids[..., 1:] = input_ids[..., :-1].clone()
  430. shifted_input_ids[..., 0] = decoder_start_token_id
  431. if pad_token_id is None:
  432. raise ValueError("self.model.config.decoder.pad_token_id has to be defined.")
  433. # Is this T5 specific?
  434. # replace possible -100 values in labels by `pad_token_id`
  435. shifted_input_ids.masked_fill_(shifted_input_ids == -100, pad_token_id)
  436. return shifted_input_ids
  437. def make_default_2d_attention_mask(
  438. token_ids: Optional[torch.LongTensor],
  439. hidden_states: torch.Tensor,
  440. pad_token_id: Optional[int],
  441. ) -> torch.Tensor:
  442. """Construct the default attention mask."""
  443. if token_ids is not None:
  444. if pad_token_id is None:
  445. raise ValueError("`pad_token_id` is required for padding information.")
  446. attention_mask = (token_ids != pad_token_id).to(hidden_states.device, torch.long)
  447. else:
  448. attention_mask = torch.ones(
  449. (hidden_states.shape[0], hidden_states.shape[1]), device=hidden_states.device, dtype=torch.long
  450. )
  451. return attention_mask
  452. class T5GemmaEncoder(T5GemmaPreTrainedModel):
  453. _can_record_outputs = {
  454. "attentions": T5GemmaSelfAttention,
  455. "hidden_states": T5GemmaEncoderLayer,
  456. }
  457. def __init__(self, config):
  458. super().__init__(config)
  459. self.padding_idx = config.pad_token_id
  460. self.vocab_size = config.vocab_size
  461. self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.padding_idx)
  462. self.norm = T5GemmaRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
  463. self.rotary_emb = T5GemmaRotaryEmbedding(config=config)
  464. self.gradient_checkpointing = False
  465. self.layers = nn.ModuleList(
  466. [T5GemmaEncoderLayer(config, layer_idx) for layer_idx in range(config.num_hidden_layers)]
  467. )
  468. self.dropout = nn.Dropout(config.dropout_rate)
  469. # Initialize weights and apply final processing
  470. self.post_init()
  471. @check_model_inputs()
  472. def forward(
  473. self,
  474. input_ids: Optional[torch.LongTensor] = None,
  475. attention_mask: Optional[torch.Tensor] = None,
  476. position_ids: Optional[torch.LongTensor] = None,
  477. inputs_embeds: Optional[torch.FloatTensor] = None,
  478. **kwargs: Unpack[TransformersKwargs],
  479. ) -> BaseModelOutput:
  480. if (input_ids is None) ^ (inputs_embeds is not None):
  481. raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
  482. # As we want to pass `past_key_values=None` explicitly everywhere, we need to pop them from kwargs if present
  483. kwargs.pop("past_key_values", None)
  484. if inputs_embeds is None:
  485. inputs_embeds = self.embed_tokens(input_ids)
  486. cache_position = torch.arange(0, inputs_embeds.shape[1], device=inputs_embeds.device)
  487. if position_ids is None:
  488. position_ids = cache_position.unsqueeze(0)
  489. if attention_mask is None:
  490. attention_mask = make_default_2d_attention_mask(input_ids, inputs_embeds, self.config.pad_token_id)
  491. if not isinstance(self_attn_mask_mapping := attention_mask, dict):
  492. mask_kwargs = {
  493. "config": self.config,
  494. "input_embeds": inputs_embeds,
  495. "attention_mask": attention_mask,
  496. "cache_position": cache_position,
  497. "past_key_values": None,
  498. "position_ids": position_ids,
  499. }
  500. self_attn_mask_mapping = {
  501. "full_attention": create_causal_mask(
  502. **mask_kwargs,
  503. or_mask_function=bidirectional_mask_function(attention_mask),
  504. ),
  505. "sliding_attention": create_sliding_window_causal_mask(
  506. **mask_kwargs,
  507. or_mask_function=sliding_window_bidirectional_mask_function(self.config.sliding_window),
  508. and_mask_function=bidirectional_mask_function(attention_mask),
  509. ),
  510. }
  511. hidden_states = inputs_embeds
  512. position_embeddings = self.rotary_emb(hidden_states, position_ids)
  513. normalizer = torch.tensor(self.config.hidden_size**0.5, dtype=hidden_states.dtype)
  514. hidden_states = hidden_states * normalizer
  515. hidden_states = self.dropout(hidden_states)
  516. for layer_module in self.layers[: self.config.num_hidden_layers]:
  517. hidden_states = layer_module(
  518. hidden_states,
  519. position_embeddings,
  520. self_attn_mask_mapping[layer_module.attention_type],
  521. position_ids,
  522. **kwargs,
  523. )
  524. hidden_states = self.norm(hidden_states)
  525. hidden_states = self.dropout(hidden_states)
  526. return BaseModelOutput(
  527. last_hidden_state=hidden_states,
  528. )
  529. class T5GemmaDecoder(T5GemmaEncoder):
  530. _can_record_outputs = {
  531. "attentions": OutputRecorder(T5GemmaSelfAttention, index=1),
  532. "cross_attentions": OutputRecorder(T5GemmaCrossAttention, index=1),
  533. "hidden_states": T5GemmaDecoderLayer,
  534. }
  535. def __init__(self, config):
  536. super().__init__(config)
  537. self.layers = nn.ModuleList(
  538. [T5GemmaDecoderLayer(config, layer_idx) for layer_idx in range(config.num_hidden_layers)]
  539. )
  540. self.post_init()
  541. @check_model_inputs()
  542. def forward(
  543. self,
  544. input_ids: Optional[torch.LongTensor] = None,
  545. attention_mask: Optional[torch.Tensor] = None,
  546. position_ids: Optional[torch.LongTensor] = None,
  547. past_key_values: Optional[EncoderDecoderCache] = None,
  548. inputs_embeds: Optional[torch.FloatTensor] = None,
  549. use_cache: Optional[bool] = None,
  550. cache_position: Optional[torch.LongTensor] = None,
  551. encoder_hidden_states: Optional[torch.Tensor] = None,
  552. encoder_attention_mask: Optional[torch.Tensor] = None,
  553. **kwargs: Unpack[TransformersKwargs],
  554. ) -> BaseModelOutputWithPastAndCrossAttentions:
  555. if (input_ids is None) ^ (inputs_embeds is not None):
  556. raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
  557. if encoder_hidden_states is None:
  558. raise ValueError("`encoder_hidden_states` must be given in decoder")
  559. if inputs_embeds is None:
  560. inputs_embeds = self.embed_tokens(input_ids)
  561. if not self.training and use_cache and past_key_values is None:
  562. past_key_values = EncoderDecoderCache(DynamicCache(config=self.config), DynamicCache(config=self.config))
  563. if cache_position is None:
  564. past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
  565. cache_position = torch.arange(
  566. past_seen_tokens, past_seen_tokens + inputs_embeds.shape[1], device=inputs_embeds.device
  567. )
  568. if position_ids is None:
  569. position_ids = cache_position.unsqueeze(0)
  570. if attention_mask is None and past_key_values is None:
  571. attention_mask = make_default_2d_attention_mask(input_ids, inputs_embeds, self.config.pad_token_id)
  572. if not isinstance(self_attn_mask_mapping := attention_mask, dict):
  573. mask_kwargs = {
  574. "config": self.config,
  575. "input_embeds": inputs_embeds,
  576. "attention_mask": attention_mask,
  577. "cache_position": cache_position,
  578. "past_key_values": past_key_values.self_attention_cache if past_key_values is not None else None,
  579. "position_ids": position_ids,
  580. }
  581. self_attn_mask_mapping = {
  582. "full_attention": create_causal_mask(**mask_kwargs),
  583. "sliding_attention": create_sliding_window_causal_mask(**mask_kwargs),
  584. }
  585. if not isinstance(cross_attn_mask_mapping := encoder_attention_mask, dict):
  586. mask_kwargs = {
  587. "config": self.config,
  588. "input_embeds": encoder_hidden_states,
  589. "attention_mask": encoder_attention_mask,
  590. "cache_position": cache_position,
  591. "past_key_values": None,
  592. "position_ids": None,
  593. }
  594. cross_attn_mask_mapping = {
  595. "full_attention": create_causal_mask(
  596. **mask_kwargs,
  597. or_mask_function=bidirectional_mask_function(encoder_attention_mask),
  598. ),
  599. }
  600. hidden_states = inputs_embeds
  601. position_embeddings = self.rotary_emb(hidden_states, position_ids)
  602. normalizer = torch.tensor(self.config.hidden_size**0.5, dtype=hidden_states.dtype)
  603. hidden_states = hidden_states * normalizer
  604. hidden_states = self.dropout(hidden_states)
  605. for layer_module in self.layers[: self.config.num_hidden_layers]:
  606. hidden_states = layer_module(
  607. hidden_states,
  608. position_embeddings,
  609. self_attn_mask_mapping[layer_module.attention_type],
  610. position_ids,
  611. past_key_values,
  612. use_cache,
  613. cache_position,
  614. encoder_hidden_states,
  615. cross_attn_mask_mapping["full_attention"],
  616. **kwargs,
  617. )
  618. hidden_states = self.norm(hidden_states)
  619. hidden_states = self.dropout(hidden_states)
  620. return BaseModelOutputWithPastAndCrossAttentions(
  621. last_hidden_state=hidden_states,
  622. past_key_values=past_key_values,
  623. )
  624. @auto_docstring
  625. class T5GemmaModel(T5GemmaPreTrainedModel):
  626. def __init__(self, config: T5GemmaConfig):
  627. super().__init__(config)
  628. if not config.is_encoder_decoder:
  629. raise ValueError("T5GemmaModel only support encoder-decoder modeling. Use `T5GemmaEncoderModel` instead.")
  630. self.encoder = T5GemmaEncoder(config.encoder)
  631. self.decoder = T5GemmaDecoder(config.decoder)
  632. self.post_init()
  633. def get_encoder(self):
  634. return self.encoder
  635. def get_input_embeddings(self):
  636. return self.encoder.get_input_embeddings()
  637. def set_input_embeddings(self, new_embeddings):
  638. return self.encoder.set_input_embeddings(new_embeddings)
  639. @can_return_tuple
  640. @auto_docstring
  641. def forward(
  642. self,
  643. input_ids: Optional[torch.LongTensor] = None,
  644. attention_mask: Optional[torch.FloatTensor] = None,
  645. position_ids: Optional[torch.LongTensor] = None,
  646. decoder_input_ids: Optional[torch.LongTensor] = None,
  647. decoder_attention_mask: Optional[torch.BoolTensor] = None,
  648. decoder_position_ids: Optional[torch.LongTensor] = None,
  649. encoder_outputs: Optional[BaseModelOutput] = None,
  650. past_key_values: Optional[EncoderDecoderCache] = None,
  651. inputs_embeds: Optional[torch.Tensor] = None,
  652. decoder_inputs_embeds: Optional[torch.Tensor] = None,
  653. use_cache: Optional[bool] = None,
  654. cache_position: Optional[torch.LongTensor] = None,
  655. **kwargs: Unpack[TransformersKwargs],
  656. ) -> Seq2SeqModelOutput:
  657. r"""
  658. decoder_position_ids (`torch.LongTensor` of shape `(batch_size, decoder_sequence_length)`, *optional*):
  659. Indices of positions of each decoder input sequence tokens in the position embeddings. Selected in the range `[0,
  660. config.decoder.n_positions - 1]`. [What are position IDs?](../glossary#position-ids)
  661. """
  662. if encoder_outputs is None:
  663. encoder_outputs = self.encoder(
  664. input_ids=input_ids,
  665. attention_mask=attention_mask,
  666. position_ids=position_ids,
  667. inputs_embeds=inputs_embeds,
  668. **kwargs,
  669. )
  670. encoder_hidden_states = encoder_outputs.last_hidden_state
  671. decoder_outputs = self.decoder(
  672. input_ids=decoder_input_ids,
  673. attention_mask=decoder_attention_mask,
  674. position_ids=decoder_position_ids,
  675. inputs_embeds=decoder_inputs_embeds,
  676. past_key_values=past_key_values,
  677. encoder_hidden_states=encoder_hidden_states,
  678. encoder_attention_mask=attention_mask,
  679. use_cache=use_cache,
  680. cache_position=cache_position,
  681. **kwargs,
  682. )
  683. return Seq2SeqModelOutput(
  684. last_hidden_state=decoder_outputs.last_hidden_state,
  685. past_key_values=decoder_outputs.past_key_values,
  686. decoder_hidden_states=decoder_outputs.hidden_states
  687. if kwargs.get("output_hidden_states", False)
  688. else (decoder_outputs.last_hidden_state,),
  689. decoder_attentions=decoder_outputs.attentions,
  690. cross_attentions=decoder_outputs.cross_attentions,
  691. encoder_last_hidden_state=encoder_outputs.last_hidden_state,
  692. encoder_hidden_states=encoder_outputs.hidden_states,
  693. encoder_attentions=encoder_outputs.attentions,
  694. )
  695. @auto_docstring
  696. class T5GemmaEncoderModel(T5GemmaPreTrainedModel):
  697. def __init__(self, config: T5GemmaConfig):
  698. super().__init__(config)
  699. if config.is_encoder_decoder:
  700. raise ValueError("T5GemmaEncoderModel only supports encoder-only model. Use `T5GemmaModel` instead.")
  701. self.encoder = T5GemmaEncoder(config.encoder)
  702. self.post_init()
  703. def get_input_embeddings(self):
  704. return self.encoder.get_input_embeddings()
  705. def set_input_embeddings(self, new_embeddings):
  706. return self.encoder.set_input_embeddings(new_embeddings)
  707. @can_return_tuple
  708. @auto_docstring
  709. def forward(
  710. self,
  711. input_ids: Optional[torch.LongTensor] = None,
  712. attention_mask: Optional[torch.FloatTensor] = None,
  713. position_ids: Optional[torch.LongTensor] = None,
  714. inputs_embeds: Optional[torch.Tensor] = None,
  715. **kwargs: Unpack[TransformersKwargs],
  716. ) -> BaseModelOutput:
  717. encoder_outputs = self.encoder(
  718. input_ids=input_ids,
  719. attention_mask=attention_mask,
  720. position_ids=position_ids,
  721. inputs_embeds=inputs_embeds,
  722. **kwargs,
  723. )
  724. return encoder_outputs
  725. class T5GemmaForConditionalGeneration(T5GemmaPreTrainedModel, GenerationMixin):
  726. _tied_weights_keys = ["model.decoder.embed_tokens.weight", "lm_head.out_proj.weight"]
  727. _tp_plan = {"lm_head.out_proj": "colwise_rep"}
  728. _pp_plan = {"lm_head.out_proj": (["hidden_states"], ["logits"])}
  729. def __init__(self, config: T5GemmaConfig):
  730. config.is_encoder_decoder = True
  731. super().__init__(config)
  732. self.model = T5GemmaModel(config)
  733. self.vocab_size = config.decoder.vocab_size
  734. self.lm_head = T5GemmaLMHead(config.decoder.hidden_size, self.vocab_size)
  735. self.loss_type = "ForMaskedLM"
  736. self.post_init()
  737. def set_output_embeddings(self, new_embeddings):
  738. self.lm_head.out_proj = new_embeddings
  739. def get_output_embeddings(self):
  740. return self.lm_head.out_proj
  741. def _tie_weights(self):
  742. # Decoder input and output embeddings are tied.
  743. if self.config.tie_word_embeddings:
  744. self._tie_or_clone_weights(self.lm_head.out_proj, self.get_decoder().get_input_embeddings())
  745. def get_encoder(self):
  746. return self.model.encoder
  747. def get_decoder(self):
  748. return self.model.decoder
  749. @can_return_tuple
  750. @auto_docstring
  751. def forward(
  752. self,
  753. input_ids: Optional[torch.LongTensor] = None,
  754. attention_mask: Optional[torch.FloatTensor] = None,
  755. position_ids: Optional[torch.LongTensor] = None,
  756. decoder_input_ids: Optional[torch.LongTensor] = None,
  757. decoder_attention_mask: Optional[torch.BoolTensor] = None,
  758. decoder_position_ids: Optional[torch.LongTensor] = None,
  759. encoder_outputs: Optional[BaseModelOutput] = None,
  760. past_key_values: Optional[EncoderDecoderCache] = None,
  761. inputs_embeds: Optional[torch.FloatTensor] = None,
  762. decoder_inputs_embeds: Optional[torch.FloatTensor] = None,
  763. labels: Optional[torch.LongTensor] = None,
  764. use_cache: Optional[bool] = None,
  765. cache_position: Optional[torch.LongTensor] = None,
  766. logits_to_keep: Union[int, torch.Tensor] = 0,
  767. **kwargs: Unpack[TransformersKwargs],
  768. ) -> Union[tuple[torch.FloatTensor], Seq2SeqLMOutput]:
  769. r"""
  770. decoder_position_ids (`torch.LongTensor` of shape `(batch_size, decoder_sequence_length)`, *optional*):
  771. Indices of positions of each decoder input sequence tokens in the position embeddings. Selected in the range `[0,
  772. config.decoder.n_positions - 1]`. [What are position IDs?](../glossary#position-ids)
  773. labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
  774. Labels for computing the masked language modeling loss. Indices should either be in `[0, ...,
  775. config.vocab_size]` or -100 (see `input_ids` docstring). Tokens with indices set to `-100` are ignored
  776. (masked), the loss is only computed for the tokens with labels in `[0, ..., config.vocab_size]`.
  777. """
  778. if labels is not None and decoder_input_ids is None and decoder_inputs_embeds is None:
  779. # get decoder inputs from shifting lm labels to the right
  780. decoder_input_ids = self._shift_right(labels)
  781. decoder_outputs: Seq2SeqModelOutput = self.model(
  782. input_ids=input_ids,
  783. attention_mask=attention_mask,
  784. position_ids=position_ids,
  785. decoder_input_ids=decoder_input_ids,
  786. decoder_attention_mask=decoder_attention_mask,
  787. decoder_position_ids=decoder_position_ids,
  788. encoder_outputs=encoder_outputs,
  789. past_key_values=past_key_values,
  790. inputs_embeds=inputs_embeds,
  791. decoder_inputs_embeds=decoder_inputs_embeds,
  792. use_cache=use_cache,
  793. cache_position=cache_position,
  794. **kwargs,
  795. )
  796. hidden_states = decoder_outputs.last_hidden_state
  797. # Only compute necessary logits, and do not upcast them to float if we are not computing the loss
  798. slice_indices = slice(-logits_to_keep, None) if isinstance(logits_to_keep, int) else logits_to_keep
  799. logits = self.lm_head(hidden_states[:, slice_indices, :])
  800. decoder_config = self.get_decoder().config
  801. if decoder_config.final_logit_softcapping is not None:
  802. logits = logits / decoder_config.final_logit_softcapping
  803. logits = torch.tanh(logits)
  804. logits = logits * decoder_config.final_logit_softcapping
  805. loss = None
  806. if labels is not None:
  807. # Input has right-shifted so we directly perform masked lm loss
  808. loss = self.loss_function(logits, labels, self.vocab_size, **kwargs)
  809. return Seq2SeqLMOutput(
  810. loss=loss,
  811. logits=logits,
  812. past_key_values=decoder_outputs.past_key_values,
  813. decoder_hidden_states=decoder_outputs.decoder_hidden_states,
  814. decoder_attentions=decoder_outputs.decoder_attentions,
  815. cross_attentions=decoder_outputs.cross_attentions,
  816. encoder_last_hidden_state=decoder_outputs.encoder_last_hidden_state,
  817. encoder_hidden_states=decoder_outputs.encoder_hidden_states,
  818. encoder_attentions=decoder_outputs.encoder_attentions,
  819. )
  820. def prepare_decoder_input_ids_from_labels(self, labels: torch.Tensor):
  821. return self._shift_right(labels)
  822. @auto_docstring
  823. class T5GemmaForSequenceClassification(T5GemmaPreTrainedModel):
  824. def __init__(self, config: T5GemmaConfig, is_encoder_decoder: Optional[bool] = None):
  825. r"""
  826. is_encoder_decoder (`Optional`, *optional*):
  827. Whether use encoder_decoder for sequence classification. When set to False, only encoder is used.
  828. """
  829. if is_encoder_decoder is not None:
  830. config.is_encoder_decoder = is_encoder_decoder
  831. super().__init__(config)
  832. self.num_labels = config.num_labels
  833. if config.is_encoder_decoder:
  834. self.model = T5GemmaModel(config)
  835. else:
  836. self.model = T5GemmaEncoderModel(config)
  837. hidden_size = config.encoder.hidden_size
  838. if config.is_encoder_decoder:
  839. hidden_size = config.decoder.hidden_size
  840. classifier_dropout = getattr(config, "classifier_dropout_rate", 0.1)
  841. self.score = T5GemmaClassificationHead(hidden_size, self.num_labels, classifier_dropout)
  842. self.post_init()
  843. def get_input_embeddings(self):
  844. return self.model.get_input_embeddings()
  845. def set_input_embeddings(self, value):
  846. self.model.set_input_embeddings(value)
  847. @can_return_tuple
  848. @auto_docstring
  849. def forward(
  850. self,
  851. input_ids: Optional[torch.LongTensor] = None,
  852. attention_mask: Optional[torch.Tensor] = None,
  853. position_ids: Optional[torch.LongTensor] = None,
  854. decoder_input_ids: Optional[torch.LongTensor] = None,
  855. decoder_attention_mask: Optional[torch.Tensor] = None,
  856. decoder_position_ids: Optional[torch.LongTensor] = None,
  857. encoder_outputs: Optional[BaseModelOutput] = None,
  858. inputs_embeds: Optional[torch.FloatTensor] = None,
  859. decoder_inputs_embeds: Optional[torch.FloatTensor] = None,
  860. labels: Optional[torch.LongTensor] = None,
  861. **kwargs: Unpack[TransformersKwargs],
  862. ) -> SequenceClassifierOutput:
  863. r"""
  864. decoder_position_ids (`torch.LongTensor` of shape `(batch_size, decoder_sequence_length)`, *optional*):
  865. Indices of positions of each decoder input sequence tokens in the position embeddings. Selected in the range `[0,
  866. config.decoder.n_positions - 1]`. [What are position IDs?](../glossary#position-ids)
  867. labels (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
  868. Labels for computing the sequence classification/regression loss. Indices should be in `[0, ...,
  869. config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If
  870. `config.num_labels > 1` a classification loss is computed (Cross-Entropy).
  871. """
  872. if self.config.is_encoder_decoder and (input_ids is None and inputs_embeds is not None):
  873. raise NotImplementedError(
  874. f"Passing input embeddings is currently not supported for {self.__class__.__name__} in encoder-decoder mode."
  875. )
  876. # Following T5, we automatically creates decoder_input_ids from input_ids if no decoder_input_ids are provided
  877. if self.config.is_encoder_decoder and (decoder_input_ids is None and decoder_inputs_embeds is None):
  878. if input_ids is None:
  879. raise ValueError(
  880. "If no `decoder_input_ids` or `decoder_inputs_embeds` are "
  881. "passed, `input_ids` cannot be `None`. Please pass either "
  882. "`input_ids` or `decoder_input_ids` or `decoder_inputs_embeds`."
  883. )
  884. decoder_input_ids = self._shift_right(input_ids)
  885. if self.config.is_encoder_decoder:
  886. outputs: Seq2SeqModelOutput = self.model(
  887. input_ids,
  888. attention_mask=attention_mask,
  889. position_ids=position_ids,
  890. decoder_input_ids=decoder_input_ids,
  891. decoder_attention_mask=decoder_attention_mask,
  892. decoder_position_ids=decoder_position_ids,
  893. encoder_outputs=encoder_outputs,
  894. inputs_embeds=inputs_embeds,
  895. decoder_inputs_embeds=decoder_inputs_embeds,
  896. use_cache=False,
  897. **kwargs,
  898. )
  899. last_hidden_state = outputs.last_hidden_state
  900. hidden_states = outputs.decoder_hidden_states
  901. attentions = outputs.decoder_attentions
  902. else:
  903. outputs: BaseModelOutput = self.model(
  904. input_ids,
  905. attention_mask=attention_mask,
  906. position_ids=position_ids,
  907. inputs_embeds=inputs_embeds,
  908. **kwargs,
  909. )
  910. last_hidden_state = outputs.last_hidden_state
  911. hidden_states = outputs.hidden_states
  912. attentions = outputs.attentions
  913. logits = self.score(last_hidden_state)
  914. if input_ids is not None:
  915. batch_size = input_ids.shape[0]
  916. else:
  917. batch_size = inputs_embeds.shape[0]
  918. if self.config.pad_token_id is None and batch_size != 1:
  919. raise ValueError("Cannot handle batch sizes > 1 if no padding token is defined.")
  920. if self.config.pad_token_id is None:
  921. last_non_pad_token = -1
  922. elif input_ids is not None:
  923. # To handle both left- and right- padding, we take the rightmost token that is not equal to pad_token_id
  924. non_pad_mask = (input_ids != self.config.pad_token_id).to(logits.device, torch.int32)
  925. token_indices = torch.arange(input_ids.shape[-1], device=logits.device, dtype=torch.int32)
  926. last_non_pad_token = (token_indices * non_pad_mask).argmax(-1)
  927. if self.config.is_encoder_decoder:
  928. last_non_pad_token += 1 # due to the right shift.
  929. last_non_pad_token = torch.clamp(last_non_pad_token, max=decoder_input_ids.shape[-1] - 1)
  930. else:
  931. last_non_pad_token = -1
  932. logger.warning_once(
  933. f"{self.__class__.__name__} will not detect padding tokens in `inputs_embeds`. Results may be "
  934. "unexpected if using padding tokens in conjunction with `inputs_embeds.`"
  935. )
  936. pooled_logits = logits[torch.arange(batch_size, device=logits.device), last_non_pad_token]
  937. loss = None
  938. if labels is not None:
  939. loss = self.loss_function(logits=logits, labels=labels, pooled_logits=pooled_logits, config=self.config)
  940. return SequenceClassifierOutput(
  941. loss=loss,
  942. logits=pooled_logits,
  943. hidden_states=hidden_states,
  944. attentions=attentions,
  945. )
  946. @auto_docstring
  947. class T5GemmaForTokenClassification(T5GemmaPreTrainedModel):
  948. def __init__(self, config: T5GemmaConfig, is_encoder_decoder: Optional[bool] = None):
  949. r"""
  950. is_encoder_decoder (`Optional`, *optional*):
  951. Whether use encoder_decoder for token classification. When set to False, only encoder is used.
  952. """
  953. if is_encoder_decoder is not None:
  954. config.is_encoder_decoder = is_encoder_decoder
  955. super().__init__(config)
  956. self.num_labels = config.num_labels
  957. if config.is_encoder_decoder:
  958. self.model = T5GemmaModel(config)
  959. else:
  960. self.model = T5GemmaEncoderModel(config)
  961. hidden_size = config.encoder.hidden_size
  962. if config.is_encoder_decoder:
  963. hidden_size = config.decoder.hidden_size
  964. classifier_dropout = getattr(config, "classifier_dropout_rate", 0.1)
  965. self.score = T5GemmaClassificationHead(hidden_size, self.num_labels, classifier_dropout)
  966. self.post_init()
  967. def get_input_embeddings(self):
  968. return self.model.get_input_embeddings()
  969. def set_input_embeddings(self, value):
  970. self.model.set_input_embeddings(value)
  971. @can_return_tuple
  972. @auto_docstring
  973. def forward(
  974. self,
  975. input_ids: Optional[torch.LongTensor] = None,
  976. attention_mask: Optional[torch.Tensor] = None,
  977. position_ids: Optional[torch.LongTensor] = None,
  978. decoder_input_ids: Optional[torch.LongTensor] = None,
  979. decoder_attention_mask: Optional[torch.Tensor] = None,
  980. decoder_position_ids: Optional[torch.LongTensor] = None,
  981. encoder_outputs: Optional[BaseModelOutput] = None,
  982. inputs_embeds: Optional[torch.FloatTensor] = None,
  983. decoder_inputs_embeds: Optional[torch.FloatTensor] = None,
  984. labels: Optional[torch.LongTensor] = None,
  985. **kwargs: Unpack[TransformersKwargs],
  986. ) -> TokenClassifierOutput:
  987. r"""
  988. decoder_position_ids (`torch.LongTensor` of shape `(batch_size, decoder_sequence_length)`, *optional*):
  989. Indices of positions of each decoder input sequence tokens in the position embeddings. Selected in the range `[0,
  990. config.decoder.n_positions - 1]`. [What are position IDs?](../glossary#position-ids)
  991. labels (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
  992. Labels for computing the sequence classification/regression loss. Indices should be in `[0, ...,
  993. config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If
  994. `config.num_labels > 1` a classification loss is computed (Cross-Entropy).
  995. """
  996. if self.config.is_encoder_decoder and (input_ids is None and inputs_embeds is not None):
  997. raise NotImplementedError(
  998. f"Passing input embeddings is currently not supported for {self.__class__.__name__} in encoder-decoder mode."
  999. )
  1000. if self.config.is_encoder_decoder and (decoder_input_ids is None and decoder_inputs_embeds is None):
  1001. if input_ids is None:
  1002. raise ValueError(
  1003. "If no `decoder_input_ids` or `decoder_inputs_embeds` are "
  1004. "passed, `input_ids` cannot be `None`. Please pass either "
  1005. "`input_ids` or `decoder_input_ids` or `decoder_inputs_embeds`."
  1006. )
  1007. decoder_input_ids = self._shift_right(input_ids)
  1008. if self.config.is_encoder_decoder:
  1009. outputs: Seq2SeqModelOutput = self.model(
  1010. input_ids,
  1011. attention_mask=attention_mask,
  1012. position_ids=position_ids,
  1013. decoder_input_ids=decoder_input_ids,
  1014. decoder_attention_mask=decoder_attention_mask,
  1015. decoder_position_ids=decoder_position_ids,
  1016. encoder_outputs=encoder_outputs,
  1017. inputs_embeds=inputs_embeds,
  1018. decoder_inputs_embeds=decoder_inputs_embeds,
  1019. use_cache=False,
  1020. **kwargs,
  1021. )
  1022. last_hidden_state = outputs.last_hidden_state
  1023. hidden_states = outputs.decoder_hidden_states
  1024. attentions = outputs.decoder_attentions
  1025. else:
  1026. outputs: BaseModelOutput = self.model(
  1027. input_ids,
  1028. attention_mask=attention_mask,
  1029. position_ids=position_ids,
  1030. inputs_embeds=inputs_embeds,
  1031. **kwargs,
  1032. )
  1033. last_hidden_state = outputs.last_hidden_state
  1034. hidden_states = outputs.hidden_states
  1035. attentions = outputs.attentions
  1036. logits = self.score(last_hidden_state)
  1037. loss = None
  1038. if labels is not None:
  1039. loss = self.loss_function(logits, labels, self.config)
  1040. return TokenClassifierOutput(
  1041. loss=loss,
  1042. logits=logits,
  1043. hidden_states=hidden_states,
  1044. attentions=attentions,
  1045. )
  1046. __all__ = [
  1047. "T5GemmaConfig",
  1048. "T5GemmaModuleConfig",
  1049. "T5GemmaForConditionalGeneration",
  1050. "T5GemmaModel",
  1051. "T5GemmaEncoderModel",
  1052. "T5GemmaPreTrainedModel",
  1053. "T5GemmaForSequenceClassification",
  1054. "T5GemmaForTokenClassification",
  1055. ]