| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728 |
- # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
- # This file was automatically generated from src/transformers/models/glm4v/modular_glm4v.py.
- # Do NOT edit this file manually as any edits will be overwritten by the generation of
- # the file from the modular. If any change should be done, please apply the change to the
- # modular_glm4v.py file directly. One of our CI enforces this.
- # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
- # Copyright 2025 The ZhipuAI Inc. team and HuggingFace Inc. team. All rights reserved.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- import itertools
- from collections.abc import Callable
- from dataclasses import dataclass
- from typing import Any, Optional
- import torch
- import torch.nn as nn
- import torch.nn.functional as F
- from torch.nn import LayerNorm
- from ... import initialization as init
- from ...activations import ACT2FN
- from ...cache_utils import Cache, DynamicCache
- from ...generation import GenerationMixin
- from ...integrations import use_kernel_forward_from_hub
- from ...masking_utils import create_causal_mask
- from ...modeling_flash_attention_utils import FlashAttentionKwargs
- from ...modeling_layers import GradientCheckpointingLayer
- from ...modeling_outputs import BaseModelOutputWithPast, BaseModelOutputWithPooling, ModelOutput
- from ...modeling_rope_utils import ROPE_INIT_FUNCTIONS, dynamic_rope_update
- from ...modeling_utils import ALL_ATTENTION_FUNCTIONS, PreTrainedModel
- from ...processing_utils import Unpack
- from ...utils import TransformersKwargs, auto_docstring, can_return_tuple, torch_compilable_check
- from ...utils.generic import is_flash_attention_requested, maybe_autocast, merge_with_config_defaults
- from ...utils.output_capturing import capture_outputs
- from .configuration_glm4v import Glm4vConfig, Glm4vTextConfig, Glm4vVisionConfig
- @use_kernel_forward_from_hub("RMSNorm")
- class Glm4vRMSNorm(nn.Module):
- def __init__(self, hidden_size, eps: float = 1e-6) -> None:
- """
- Glm4vRMSNorm is equivalent to T5LayerNorm
- """
- super().__init__()
- self.weight = nn.Parameter(torch.ones(hidden_size))
- self.variance_epsilon = eps
- def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
- input_dtype = hidden_states.dtype
- hidden_states = hidden_states.to(torch.float32)
- variance = hidden_states.pow(2).mean(-1, keepdim=True)
- hidden_states = hidden_states * torch.rsqrt(variance + self.variance_epsilon)
- return self.weight * hidden_states.to(input_dtype)
- def extra_repr(self):
- return f"{tuple(self.weight.shape)}, eps={self.variance_epsilon}"
- class Glm4VisionMlp(nn.Module):
- def __init__(self, config, bias: bool = False):
- super().__init__()
- self.hidden_size = config.hidden_size
- self.intermediate_size = config.out_hidden_size
- self.gate_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=bias)
- self.up_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=bias)
- self.down_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=bias)
- self.act_fn = ACT2FN[config.hidden_act]
- def forward(self, hidden_state):
- return self.down_proj(self.act_fn(self.gate_proj(hidden_state)) * self.up_proj(hidden_state))
- class Glm4vVisionPatchEmbed(nn.Module):
- def __init__(self, config: Glm4vVisionConfig) -> None:
- super().__init__()
- self.patch_size = config.patch_size
- self.temporal_patch_size = config.temporal_patch_size
- self.in_channels = config.in_channels
- self.embed_dim = config.hidden_size
- kernel_size = [self.temporal_patch_size, self.patch_size, self.patch_size]
- self.proj = nn.Conv3d(self.in_channels, self.embed_dim, kernel_size=kernel_size, stride=kernel_size)
- def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
- target_dtype = self.proj.weight.dtype
- hidden_states = hidden_states.view(
- -1, self.in_channels, self.temporal_patch_size, self.patch_size, self.patch_size
- )
- hidden_states = self.proj(hidden_states.to(dtype=target_dtype)).view(-1, self.embed_dim)
- return hidden_states
- class Glm4vVisionRotaryEmbedding(nn.Module):
- inv_freq: torch.Tensor # fix linting for `register_buffer`
- def __init__(self, dim: int, theta: float = 10000.0) -> None:
- super().__init__()
- self.dim = dim
- self.theta = theta
- inv_freq = 1.0 / (theta ** (torch.arange(0, dim, 2, dtype=torch.float) / dim))
- self.register_buffer("inv_freq", inv_freq, persistent=False)
- def forward(self, seqlen: int) -> torch.Tensor:
- seq = torch.arange(seqlen, device=self.inv_freq.device, dtype=self.inv_freq.dtype)
- freqs = torch.outer(seq, self.inv_freq)
- return freqs
- class Glm4vVisionPatchMerger(nn.Module):
- def __init__(self, dim: int, context_dim: int, hidden_act: str, bias: bool = False) -> None:
- super().__init__()
- self.proj = nn.Linear(dim, dim, bias=bias)
- self.post_projection_norm = LayerNorm(dim)
- self.gate_proj = nn.Linear(dim, context_dim, bias=bias)
- self.up_proj = nn.Linear(dim, context_dim, bias=bias)
- self.down_proj = nn.Linear(context_dim, dim, bias=bias)
- self.act1 = nn.GELU()
- self.act_fn = ACT2FN[hidden_act]
- def forward(self, hidden_state: torch.Tensor) -> torch.Tensor:
- hidden_state = self.proj(hidden_state)
- hidden_state = self.act1(self.post_projection_norm(hidden_state))
- return self.down_proj(self.act_fn(self.gate_proj(hidden_state)) * self.up_proj(hidden_state))
- class Glm4vVisionEmbeddings(nn.Module):
- def __init__(self, config: Glm4vVisionConfig):
- super().__init__()
- self.config = config
- self.embed_dim = config.hidden_size
- self.image_size = config.image_size
- self.patch_size = config.patch_size
- self.num_patches = (self.image_size // self.patch_size) ** 2
- self.num_positions = self.num_patches
- self.position_embedding = nn.Embedding(self.num_positions, self.embed_dim)
- self.interpolated_method = "bicubic"
- def forward(self, embeddings, lengths, image_shapes, h_coords, w_coords) -> torch.Tensor:
- """
- Forward pass with integrated position encoding adaptation using 2D interpolation.
- Args:
- embeddings: Input embeddings tensor
- lengths (torch.Tensor): Sequence lengths for each image in the batch.
- image_shapes (torch.Tensor): Tensor of shape [batch_size, 3] representing the image shapes (t, h, w).
- h_coords (torch.Tensor): Tensor of shape [total_seq] representing the h coordinate for each patch.
- w_coords (torch.Tensor): Tensor of shape [total_seq] representing the w coordinate for each patch.
- Returns:
- torch.Tensor: Embeddings with adapted position encoding added.
- """
- # Get position embedding parameters
- pos_embed_weight = self.position_embedding.weight
- hidden_size = pos_embed_weight.shape[1]
- device = pos_embed_weight.device
- # Convert inputs to tensors if needed
- if isinstance(lengths, list):
- lengths = torch.tensor(lengths, device=device, dtype=torch.long)
- # Prepare 2D position embedding
- orig_size_sq = pos_embed_weight.shape[0]
- orig_size = int(orig_size_sq**0.5)
- pos_embed_2d = (
- pos_embed_weight.view(orig_size, orig_size, hidden_size)
- .permute(2, 0, 1)
- .unsqueeze(0)
- .to(device=device, dtype=torch.float32)
- )
- # Calculate target dimensions for each patch
- target_h = torch.cat([image_shapes[i, 1].repeat(lengths[i]) for i in range(len(lengths))]).to(
- device=device, dtype=torch.float32
- )
- target_w = torch.cat([image_shapes[i, 2].repeat(lengths[i]) for i in range(len(lengths))]).to(
- device=device, dtype=torch.float32
- )
- # Normalize coordinates to [-1, 1] range for grid_sample
- norm_w = ((w_coords + 0.5) / target_w) * 2 - 1
- norm_h = ((h_coords + 0.5) / target_h) * 2 - 1
- # Create sampling grid
- grid = torch.stack((norm_w, norm_h), dim=-1).unsqueeze(0).unsqueeze(2)
- # Perform bicubic interpolation
- interpolated_embed_fp32 = F.grid_sample(
- pos_embed_2d, grid, mode=self.interpolated_method, align_corners=False, padding_mode="border"
- )
- # Reshape and convert back to original dtype
- adapted_pos_embed_fp32 = interpolated_embed_fp32.squeeze(0).squeeze(-1).permute(1, 0)
- adapted_pos_embed = adapted_pos_embed_fp32.to(pos_embed_weight.dtype).to(embeddings.device)
- # Add adapted position encoding to embeddings
- embeddings = embeddings + adapted_pos_embed
- return embeddings
- def rotate_half(x):
- """Rotates half the hidden dims of the input."""
- x1 = x[..., : x.shape[-1] // 2]
- x2 = x[..., x.shape[-1] // 2 :]
- return torch.cat((-x2, x1), dim=-1)
- def apply_rotary_pos_emb_vision(
- q: torch.Tensor, k: torch.Tensor, cos: torch.Tensor, sin: torch.Tensor
- ) -> tuple[torch.Tensor, torch.Tensor]:
- orig_q_dtype = q.dtype
- orig_k_dtype = k.dtype
- q, k = q.float(), k.float()
- cos, sin = cos.unsqueeze(-2).float(), sin.unsqueeze(-2).float()
- q_embed = (q * cos) + (rotate_half(q) * sin)
- k_embed = (k * cos) + (rotate_half(k) * sin)
- q_embed = q_embed.to(orig_q_dtype)
- k_embed = k_embed.to(orig_k_dtype)
- return q_embed, k_embed
- def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
- """
- This is the equivalent of torch.repeat_interleave(x, dim=1, repeats=n_rep). The hidden states go from (batch,
- num_key_value_heads, seqlen, head_dim) to (batch, num_attention_heads, seqlen, head_dim)
- """
- batch, num_key_value_heads, slen, head_dim = hidden_states.shape
- if n_rep == 1:
- return hidden_states
- hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_key_value_heads, n_rep, slen, head_dim)
- return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim)
- def eager_attention_forward(
- module: nn.Module,
- query: torch.Tensor,
- key: torch.Tensor,
- value: torch.Tensor,
- attention_mask: torch.Tensor | None,
- scaling: float,
- dropout: float = 0.0,
- **kwargs: Unpack[TransformersKwargs],
- ):
- key_states = repeat_kv(key, module.num_key_value_groups)
- value_states = repeat_kv(value, module.num_key_value_groups)
- attn_weights = torch.matmul(query, key_states.transpose(2, 3)) * scaling
- if attention_mask is not None:
- attn_weights = attn_weights + attention_mask
- attn_weights = nn.functional.softmax(attn_weights, dim=-1, dtype=torch.float32).to(query.dtype)
- attn_weights = nn.functional.dropout(attn_weights, p=dropout, training=module.training)
- attn_output = torch.matmul(attn_weights, value_states)
- attn_output = attn_output.transpose(1, 2).contiguous()
- return attn_output, attn_weights
- class Glm4vVisionAttention(nn.Module):
- def __init__(self, config: Glm4vVisionConfig) -> None:
- super().__init__()
- self.dim = config.hidden_size
- self.num_heads = config.num_heads
- self.head_dim = self.dim // self.num_heads
- self.num_key_value_groups = 1 # needed for eager attention
- self.qkv = nn.Linear(config.hidden_size, config.hidden_size * 3, bias=config.attention_bias)
- self.proj = nn.Linear(config.hidden_size, config.hidden_size, bias=False)
- self.scaling = self.head_dim**-0.5
- self.config = config
- self.attention_dropout = config.attention_dropout
- self.is_causal = False
- def forward(
- self,
- hidden_states: torch.Tensor,
- cu_seqlens: torch.Tensor,
- rotary_pos_emb: torch.Tensor | None = None,
- position_embeddings: tuple[torch.Tensor, torch.Tensor] | None = None,
- **kwargs,
- ) -> torch.Tensor:
- seq_length = hidden_states.shape[0]
- query_states, key_states, value_states = (
- self.qkv(hidden_states).reshape(seq_length, 3, self.num_heads, -1).permute(1, 0, 2, 3).unbind(0)
- )
- cos, sin = position_embeddings
- query_states, key_states = apply_rotary_pos_emb_vision(query_states, key_states, cos, sin)
- query_states = query_states.transpose(0, 1).unsqueeze(0)
- key_states = key_states.transpose(0, 1).unsqueeze(0)
- value_states = value_states.transpose(0, 1).unsqueeze(0)
- attention_interface: Callable = ALL_ATTENTION_FUNCTIONS.get_interface(
- self.config._attn_implementation, eager_attention_forward
- )
- if is_flash_attention_requested(self.config):
- # Flash Attention: Use cu_seqlens for variable length attention
- max_seqlen = (cu_seqlens[1:] - cu_seqlens[:-1]).max()
- attn_output, _ = attention_interface(
- self,
- query_states,
- key_states,
- value_states,
- attention_mask=None,
- scaling=self.scaling,
- dropout=0.0 if not self.training else self.attention_dropout,
- cu_seq_lens_q=cu_seqlens,
- cu_seq_lens_k=cu_seqlens,
- max_length_q=max_seqlen,
- max_length_k=max_seqlen,
- is_causal=False,
- **kwargs,
- )
- else:
- # Other implementations: Process each chunk separately
- lengths = cu_seqlens[1:] - cu_seqlens[:-1]
- splits = [
- torch.split(tensor, lengths.tolist(), dim=2) for tensor in (query_states, key_states, value_states)
- ]
- attn_outputs = [
- attention_interface(
- self,
- q,
- k,
- v,
- attention_mask=None,
- scaling=self.scaling,
- dropout=0.0 if not self.training else self.attention_dropout,
- is_causal=False,
- **kwargs,
- )[0]
- for q, k, v in zip(*splits)
- ]
- attn_output = torch.cat(attn_outputs, dim=1)
- attn_output = attn_output.reshape(seq_length, -1).contiguous()
- attn_output = self.proj(attn_output)
- return attn_output
- class Glm4vVisionBlock(GradientCheckpointingLayer):
- def __init__(self, config) -> None:
- super().__init__()
- self.norm1 = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.norm2 = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.attn = Glm4vVisionAttention(config)
- self.mlp = Glm4VisionMlp(config, bias=False)
- @auto_docstring
- def forward(
- self,
- hidden_states: torch.Tensor,
- cu_seqlens: torch.Tensor,
- rotary_pos_emb: torch.Tensor | None = None,
- position_embeddings: tuple[torch.Tensor, torch.Tensor] | None = None,
- **kwargs,
- ) -> torch.Tensor:
- r"""
- cu_seqlens (`torch.Tensor`):
- Cumulative sequence lengths used for packed variable-length attention in Flash Attention kernels.
- rotary_pos_emb (`torch.Tensor`, *optional*):
- Precomputed rotary positional embeddings applied to the vision attention query/key states.
- """
- hidden_states = hidden_states + self.attn(
- self.norm1(hidden_states),
- cu_seqlens=cu_seqlens,
- rotary_pos_emb=rotary_pos_emb,
- position_embeddings=position_embeddings,
- **kwargs,
- )
- hidden_states = hidden_states + self.mlp(self.norm2(hidden_states))
- return hidden_states
- class Glm4vTextRotaryEmbedding(nn.Module):
- inv_freq: torch.Tensor # fix linting for `register_buffer`
- def __init__(self, config: Glm4vTextConfig, device=None):
- super().__init__()
- self.max_seq_len_cached = config.max_position_embeddings
- self.original_max_seq_len = config.max_position_embeddings
- self.config = config
- self.rope_type = self.config.rope_parameters["rope_type"]
- rope_init_fn: Callable = self.compute_default_rope_parameters
- if self.rope_type != "default":
- rope_init_fn = ROPE_INIT_FUNCTIONS[self.rope_type]
- inv_freq, self.attention_scaling = rope_init_fn(self.config, device)
- self.register_buffer("inv_freq", inv_freq, persistent=False)
- self.register_buffer("original_inv_freq", inv_freq.clone(), persistent=False)
- self.mrope_section = config.rope_parameters.get("mrope_section", [8, 12, 12])
- @staticmethod
- def compute_default_rope_parameters(
- config: Glm4vTextConfig | None = None,
- device: Optional["torch.device"] = None,
- seq_len: int | None = None,
- ) -> tuple["torch.Tensor", float]:
- """
- Computes the inverse frequencies according to the original RoPE implementation
- Args:
- config ([`~transformers.PreTrainedConfig`]):
- The model configuration.
- device (`torch.device`):
- The device to use for initialization of the inverse frequencies.
- seq_len (`int`, *optional*):
- The current sequence length. Unused for this type of RoPE.
- Returns:
- Tuple of (`torch.Tensor`, `float`), containing the inverse frequencies for the RoPE embeddings and the
- post-processing scaling factor applied to the computed cos/sin (unused in this type of RoPE).
- """
- base = config.rope_parameters["rope_theta"]
- partial_rotary_factor = config.rope_parameters.get("partial_rotary_factor", 1.0)
- head_dim = getattr(config, "head_dim", None) or config.hidden_size // config.num_attention_heads
- dim = int(head_dim * partial_rotary_factor)
- attention_factor = 1.0 # Unused in this type of RoPE
- # Compute the inverse frequencies
- inv_freq = 1.0 / (
- base ** (torch.arange(0, dim, 2, dtype=torch.int64).to(device=device, dtype=torch.float) / dim)
- )
- return inv_freq, attention_factor
- @torch.no_grad()
- @dynamic_rope_update # power user: used with advanced RoPE types (e.g. dynamic rope)
- def forward(self, x, position_ids):
- # In contrast to other models, GLM-V has different position ids for the grids
- # So we expand the inv_freq to shape (3, ...)
- inv_freq_expanded = self.inv_freq[None, None, :, None].float().expand(3, position_ids.shape[1], -1, 1)
- position_ids_expanded = position_ids[:, :, None, :].float() # shape (3, bs, 1, positions)
- device_type = x.device.type if isinstance(x.device.type, str) and x.device.type != "mps" else "cpu"
- with maybe_autocast(device_type=device_type, enabled=False): # Force float32
- freqs = (inv_freq_expanded.float() @ position_ids_expanded.float()).transpose(2, 3)
- freqs = self.apply_mrope(freqs, self.mrope_section)
- emb = torch.cat((freqs, freqs), dim=-1)
- cos = emb.cos() * self.attention_scaling
- sin = emb.sin() * self.attention_scaling
- return cos.to(dtype=x.dtype), sin.to(dtype=x.dtype)
- def apply_mrope(self, freqs, mrope_section):
- section = mrope_section
- chunks = freqs.split(section, dim=-1)
- result = torch.cat([chunk[i % 3] for i, chunk in enumerate(chunks)], dim=-1)
- return result
- def rotate_half_llm(x):
- """Rotates half the hidden dims of the input."""
- x1 = x[..., 0::2]
- x2 = x[..., 1::2]
- return torch.stack((-x2, x1), dim=-1).flatten(-2)
- def apply_rotary_pos_emb(q, k, cos, sin, unsqueeze_dim=1):
- """Applies Rotary Position Embedding to the query and key tensors.
- Args:
- q (`torch.Tensor`): The query tensor.
- k (`torch.Tensor`): The key tensor.
- cos (`torch.Tensor`): The cosine part of the rotary embedding.
- sin (`torch.Tensor`): The sine part of the rotary embedding.
- unsqueeze_dim (`int`, *optional*, defaults to 1):
- The 'unsqueeze_dim' argument specifies the dimension along which to unsqueeze cos[position_ids] and
- sin[position_ids] so that they can be properly broadcasted to the dimensions of q and k. For example, note
- that cos[position_ids] and sin[position_ids] have the shape [batch_size, seq_len, head_dim]. Then, if q and
- k have the shape [batch_size, heads, seq_len, head_dim], then setting unsqueeze_dim=1 makes
- cos[position_ids] and sin[position_ids] broadcastable to the shapes of q and k. Similarly, if q and k have
- the shape [batch_size, seq_len, heads, head_dim], then set unsqueeze_dim=2.
- Returns:
- `tuple(torch.Tensor)` comprising of the query and key tensors rotated using the Rotary Position Embedding.
- """
- cos = cos.unsqueeze(unsqueeze_dim)
- sin = sin.unsqueeze(unsqueeze_dim)
- # Interleave them instead of usual shape
- cos = cos[..., : cos.shape[-1] // 2].repeat_interleave(2, dim=-1)
- sin = sin[..., : sin.shape[-1] // 2].repeat_interleave(2, dim=-1)
- # Keep half or full tensor for later concatenation
- rotary_dim = cos.shape[-1]
- q_rot, q_pass = q[..., :rotary_dim], q[..., rotary_dim:]
- k_rot, k_pass = k[..., :rotary_dim], k[..., rotary_dim:]
- # Apply rotary embeddings on the first half or full tensor
- q_embed = (q_rot * cos) + (rotate_half_llm(q_rot) * sin)
- k_embed = (k_rot * cos) + (rotate_half_llm(k_rot) * sin)
- # Concatenate back to full shape
- q_embed = torch.cat([q_embed, q_pass], dim=-1)
- k_embed = torch.cat([k_embed, k_pass], dim=-1)
- return q_embed, k_embed
- class Glm4vTextAttention(nn.Module):
- """
- Multi-headed attention from 'Attention Is All You Need' paper.
- and "Generating Long Sequences with Sparse Transformers".
- """
- def __init__(self, config: Glm4vTextConfig, layer_idx: int | None = None):
- super().__init__()
- self.config = config
- self.layer_idx = layer_idx
- self.hidden_size = config.hidden_size
- self.num_heads = config.num_attention_heads
- self.head_dim = self.hidden_size // self.num_heads
- self.num_key_value_heads = config.num_key_value_heads
- self.num_key_value_groups = self.num_heads // self.num_key_value_heads
- self.is_causal = True
- self.attention_dropout = config.attention_dropout
- self.rope_parameters = config.rope_parameters
- self.scaling = self.head_dim**-0.5
- self.q_proj = nn.Linear(self.hidden_size, self.num_heads * self.head_dim, bias=True)
- self.k_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=True)
- self.v_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=True)
- self.o_proj = nn.Linear(self.num_heads * self.head_dim, self.hidden_size, bias=False)
- def forward(
- self,
- hidden_states: torch.Tensor,
- position_embeddings: tuple[torch.Tensor, torch.Tensor] | None = None,
- attention_mask: torch.Tensor | None = None,
- past_key_values: Cache | None = None,
- **kwargs: Unpack[FlashAttentionKwargs],
- ) -> tuple[torch.Tensor, torch.Tensor | None, tuple[torch.Tensor] | None]:
- bsz, q_len, _ = hidden_states.size()
- query_states = self.q_proj(hidden_states)
- key_states = self.k_proj(hidden_states)
- value_states = self.v_proj(hidden_states)
- query_states = query_states.view(bsz, q_len, -1, self.head_dim).transpose(1, 2)
- key_states = key_states.view(bsz, q_len, -1, self.head_dim).transpose(1, 2)
- value_states = value_states.view(bsz, q_len, -1, self.head_dim).transpose(1, 2)
- cos, sin = position_embeddings
- query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin)
- if past_key_values is not None:
- key_states, value_states = past_key_values.update(key_states, value_states, self.layer_idx)
- attention_interface: Callable = ALL_ATTENTION_FUNCTIONS.get_interface(
- self.config._attn_implementation, eager_attention_forward
- )
- attn_output, attn_weights = attention_interface(
- self,
- query_states,
- key_states,
- value_states,
- attention_mask,
- dropout=0.0 if not self.training else self.attention_dropout,
- scaling=self.scaling,
- **kwargs,
- )
- attn_output = attn_output.reshape(bsz, q_len, -1).contiguous()
- attn_output = self.o_proj(attn_output)
- return attn_output, attn_weights
- class Glm4vTextMLP(nn.Module):
- def __init__(self, config):
- super().__init__()
- self.config = config
- self.gate_up_proj = nn.Linear(config.hidden_size, 2 * config.intermediate_size, bias=False)
- self.down_proj = nn.Linear(config.intermediate_size, config.hidden_size, bias=False)
- self.activation_fn = ACT2FN[config.hidden_act]
- def forward(self, hidden_states: torch.FloatTensor) -> torch.FloatTensor:
- up_states = self.gate_up_proj(hidden_states)
- gate, up_states = up_states.chunk(2, dim=-1)
- up_states = up_states * self.activation_fn(gate)
- return self.down_proj(up_states)
- class Glm4vTextDecoderLayer(GradientCheckpointingLayer):
- def __init__(self, config: Glm4vTextConfig, layer_idx: int):
- super().__init__()
- self.hidden_size = config.hidden_size
- self.self_attn = Glm4vTextAttention(config, layer_idx)
- self.mlp = Glm4vTextMLP(config)
- self.input_layernorm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.post_attention_layernorm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.post_self_attn_layernorm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.post_mlp_layernorm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- @auto_docstring
- def forward(
- self,
- hidden_states: torch.Tensor,
- position_embeddings: tuple[torch.Tensor, torch.Tensor] | None = None,
- attention_mask: torch.Tensor | None = None,
- position_ids: torch.LongTensor | None = None,
- past_key_values: Cache | None = None,
- use_cache: bool | None = False,
- **kwargs,
- ) -> tuple[torch.FloatTensor, tuple[torch.FloatTensor, torch.FloatTensor] | None]:
- residual = hidden_states
- hidden_states = self.input_layernorm(hidden_states)
- # Self Attention
- hidden_states, _ = self.self_attn(
- hidden_states=hidden_states,
- position_embeddings=position_embeddings,
- attention_mask=attention_mask,
- position_ids=position_ids,
- past_key_values=past_key_values,
- use_cache=use_cache,
- **kwargs,
- )
- hidden_states = self.post_self_attn_layernorm(hidden_states)
- hidden_states = residual + hidden_states
- # Fully Connected
- residual = hidden_states
- hidden_states = self.post_attention_layernorm(hidden_states)
- hidden_states = self.mlp(hidden_states)
- hidden_states = self.post_mlp_layernorm(hidden_states)
- hidden_states = residual + hidden_states
- return hidden_states
- @dataclass
- @auto_docstring(
- custom_intro="""
- Base class for Llava outputs, with hidden states and attentions.
- """
- )
- class Glm4vModelOutputWithPast(ModelOutput):
- r"""
- past_key_values (`Cache`, *optional*, returned when `use_cache=True` is passed or when `config.use_cache=True`):
- It is a [`~cache_utils.Cache`] instance. For more details, see our [kv cache guide](https://huggingface.co/docs/transformers/en/kv_cache).
- Contains pre-computed hidden-states (key and values in the self-attention blocks) that can be used (see
- `past_key_values` input) to speed up sequential decoding.
- rope_deltas (`torch.LongTensor` of shape `(batch_size, )`, *optional*):
- The rope index difference between sequence length and multimodal rope.
- """
- last_hidden_state: torch.FloatTensor | None = None
- past_key_values: Cache | None = None
- hidden_states: tuple[torch.FloatTensor] | None = None
- attentions: tuple[torch.FloatTensor] | None = None
- rope_deltas: torch.LongTensor | None = None
- @auto_docstring
- class Glm4vPreTrainedModel(PreTrainedModel):
- config: Glm4vConfig
- base_model_prefix = "model"
- input_modalities = ("image", "video", "text")
- supports_gradient_checkpointing = True
- _no_split_modules = ["Glm4vTextDecoderLayer", "Glm4vVisionBlock"]
- _skip_keys_device_placement = "past_key_values"
- _supports_flash_attn = True
- _supports_sdpa = True
- _can_compile_fullgraph = True
- _supports_attention_backend = True
- def _init_weights(self, module):
- super()._init_weights(module)
- if isinstance(module, Glm4vVisionRotaryEmbedding):
- inv_freq = 1.0 / (module.theta ** (torch.arange(0, module.dim, 2, dtype=torch.float) / module.dim))
- init.copy_(module.inv_freq, inv_freq)
- class Glm4vVisionModel(Glm4vPreTrainedModel):
- config: Glm4vVisionConfig
- input_modalities = ("image", "video")
- _no_split_modules = ["Glm4vVisionBlock"]
- _can_record_outputs = {
- "hidden_states": Glm4vVisionBlock,
- "attentions": Glm4vVisionAttention,
- }
- def __init__(self, config) -> None:
- super().__init__(config)
- self.spatial_merge_size = config.spatial_merge_size
- self.patch_size = config.patch_size
- self.embeddings = Glm4vVisionEmbeddings(config)
- self.patch_embed = Glm4vVisionPatchEmbed(config)
- head_dim = config.hidden_size // config.num_heads
- self.rotary_pos_emb = Glm4vVisionRotaryEmbedding(head_dim // 2)
- self.blocks = nn.ModuleList([Glm4vVisionBlock(config) for _ in range(config.depth)])
- self.merger = Glm4vVisionPatchMerger(
- dim=config.out_hidden_size, context_dim=config.intermediate_size, hidden_act=config.hidden_act
- )
- self.post_conv_layernorm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.downsample = nn.Conv2d(
- in_channels=config.hidden_size,
- out_channels=config.out_hidden_size,
- kernel_size=config.spatial_merge_size,
- stride=config.spatial_merge_size,
- )
- self.post_layernorm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.gradient_checkpointing = False
- self.post_init()
- def rot_pos_emb(self, grid_thw):
- pos_ids = []
- for t, h, w in grid_thw:
- hpos_ids = torch.arange(h).unsqueeze(1).expand(-1, w)
- hpos_ids = hpos_ids.reshape(
- h // self.spatial_merge_size,
- self.spatial_merge_size,
- w // self.spatial_merge_size,
- self.spatial_merge_size,
- )
- hpos_ids = hpos_ids.permute(0, 2, 1, 3)
- hpos_ids = hpos_ids.flatten()
- wpos_ids = torch.arange(w).unsqueeze(0).expand(h, -1)
- wpos_ids = wpos_ids.reshape(
- h // self.spatial_merge_size,
- self.spatial_merge_size,
- w // self.spatial_merge_size,
- self.spatial_merge_size,
- )
- wpos_ids = wpos_ids.permute(0, 2, 1, 3)
- wpos_ids = wpos_ids.flatten()
- pos_ids.append(torch.stack([hpos_ids, wpos_ids], dim=-1).repeat(t, 1))
- pos_ids = torch.cat(pos_ids, dim=0)
- max_grid_size = grid_thw[:, 1:].max()
- rotary_pos_emb_full = self.rotary_pos_emb(max_grid_size)
- rotary_pos_emb = rotary_pos_emb_full[pos_ids].flatten(1)
- return rotary_pos_emb, pos_ids
- @merge_with_config_defaults
- @capture_outputs
- @auto_docstring
- def forward(
- self, hidden_states: torch.Tensor, grid_thw: torch.Tensor, **kwargs: Unpack[TransformersKwargs]
- ) -> tuple | BaseModelOutputWithPooling:
- r"""
- hidden_states (`torch.Tensor` of shape `(seq_len, hidden_size)`):
- The final hidden states of the model.
- grid_thw (`torch.Tensor` of shape `(num_images_or_videos, 3)`):
- The temporal, height and width of feature shape of each image in LLM.
- Returns:
- `torch.Tensor`: hidden_states.
- """
- hidden_states = self.patch_embed(hidden_states)
- hidden_states = self.post_conv_layernorm(hidden_states)
- rotary_pos_emb, image_type_ids = self.rot_pos_emb(grid_thw)
- emb = torch.cat((rotary_pos_emb, rotary_pos_emb), dim=-1)
- position_embeddings = (emb.cos(), emb.sin())
- cu_seqlens = torch.repeat_interleave(grid_thw[:, 1] * grid_thw[:, 2], grid_thw[:, 0]).cumsum(
- dim=0,
- # Select dtype based on the following factors:
- # - FA2 requires that cu_seqlens_q must have dtype int32
- # - torch.onnx.export requires that cu_seqlens_q must have same dtype as grid_thw
- # See https://github.com/huggingface/transformers/pull/34852 for more information
- dtype=grid_thw.dtype if torch.jit.is_tracing() else torch.int32,
- )
- cu_seqlens = F.pad(cu_seqlens, (1, 0), value=0)
- seqlens = (cu_seqlens[1:] - cu_seqlens[:-1]).tolist()
- hidden_states = self.embeddings(
- hidden_states,
- seqlens,
- grid_thw,
- image_type_ids[:, 0].to(hidden_states.device),
- image_type_ids[:, 1].to(hidden_states.device),
- )
- for blk in self.blocks:
- hidden_states = blk(
- hidden_states,
- cu_seqlens=cu_seqlens,
- position_embeddings=position_embeddings,
- **kwargs,
- )
- hidden_states = self.post_layernorm(hidden_states)
- hidden_states = hidden_states.view(
- -1, self.spatial_merge_size, self.spatial_merge_size, hidden_states.shape[-1]
- )
- hidden_states = hidden_states.permute(0, 3, 1, 2)
- hidden_states = self.downsample(hidden_states).view(-1, self.config.out_hidden_size)
- merged_hidden_states = self.merger(hidden_states)
- return BaseModelOutputWithPooling(
- last_hidden_state=hidden_states,
- pooler_output=merged_hidden_states,
- )
- @auto_docstring
- class Glm4vTextModel(Glm4vPreTrainedModel):
- config: Glm4vTextConfig
- input_modalities = ("text",)
- _can_record_outputs = {
- "hidden_states": Glm4vTextDecoderLayer,
- "attentions": Glm4vTextAttention,
- }
- def __init__(self, config: Glm4vTextConfig):
- super().__init__(config)
- self.padding_idx = config.pad_token_id
- self.vocab_size = config.vocab_size
- self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.padding_idx)
- self.layers = nn.ModuleList(
- [Glm4vTextDecoderLayer(config, layer_idx) for layer_idx in range(config.num_hidden_layers)]
- )
- self.norm = Glm4vRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
- self.rotary_emb = Glm4vTextRotaryEmbedding(config=config)
- self.gradient_checkpointing = False
- # Initialize weights and apply final processing
- self.post_init()
- @auto_docstring
- @merge_with_config_defaults
- @capture_outputs
- def forward(
- self,
- input_ids: torch.LongTensor | None = None,
- attention_mask: torch.Tensor | None = None,
- position_ids: torch.LongTensor | None = None,
- past_key_values: Cache | None = None,
- inputs_embeds: torch.FloatTensor | None = None,
- use_cache: bool | None = None,
- **kwargs: Unpack[FlashAttentionKwargs],
- ) -> tuple | BaseModelOutputWithPast:
- if (input_ids is None) ^ (inputs_embeds is not None):
- raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
- # torch.jit.trace() doesn't support cache objects in the output
- if use_cache and past_key_values is None and not torch.jit.is_tracing():
- past_key_values = DynamicCache(config=self.config)
- if inputs_embeds is None:
- inputs_embeds = self.embed_tokens(input_ids)
- # the hard coded `3` is for temporal, height and width.
- if position_ids is None:
- past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
- position_ids = torch.arange(inputs_embeds.shape[1], device=inputs_embeds.device) + past_seen_tokens
- position_ids = position_ids.view(1, 1, -1).expand(3, inputs_embeds.shape[0], -1)
- elif position_ids.ndim == 2:
- position_ids = position_ids[None, ...].expand(3, position_ids.shape[0], -1)
- # NOTE: we need to pass text position ids for packing. Qwen2-VL uses 3D positions
- # where each dim indicates visual spatial positions for temporal/height/width grids.
- # There are two scenarios when FA2-like packed masking might be activated.
- # 1. User specifically passed packed `position_ids` and no attention mask.
- # In this case we expect the useer to create correct position ids for all 3 grids
- # and prepend text-only position ids to it. The final tensor will be [4, bs, seq-len]
- # 2. User runs forward with no attention mask and no position ids. In this case, position ids
- # are prepared by the model (`get_rope_index`) as `[4, bs, seq-len]` tensor. Text-only positions are
- # prepended by us when creating positions so that the mask is constructed correctly. NOTE: failing to pass
- # text-only positions will cause incorrect mask construction, do not change `prepare_input_for_generation`
- if position_ids.ndim == 3 and position_ids.shape[0] == 4:
- text_position_ids = position_ids[0]
- position_ids = position_ids[1:]
- else:
- # If inputs are not packed (usual 3D positions), do not prepare mask from position_ids
- text_position_ids = None
- mask_kwargs = {
- "config": self.config,
- "inputs_embeds": inputs_embeds,
- "attention_mask": attention_mask,
- "past_key_values": past_key_values,
- "position_ids": text_position_ids,
- }
- # Create the masks
- causal_mask = create_causal_mask(**mask_kwargs)
- hidden_states = inputs_embeds
- position_embeddings = self.rotary_emb(hidden_states, position_ids=position_ids)
- for decoder_layer in self.layers:
- layer_outputs = decoder_layer(
- hidden_states,
- attention_mask=causal_mask,
- position_ids=text_position_ids,
- past_key_values=past_key_values,
- position_embeddings=position_embeddings,
- **kwargs,
- )
- hidden_states = layer_outputs
- hidden_states = self.norm(hidden_states)
- return BaseModelOutputWithPast(
- last_hidden_state=hidden_states,
- past_key_values=past_key_values,
- )
- @auto_docstring
- class Glm4vModel(Glm4vPreTrainedModel):
- base_model_prefix = "model"
- # Reference: fix gemma3 grad acc #37208
- accepts_loss_kwargs = False
- _no_split_modules = ["Glm4vTextDecoderLayer", "Glm4vVisionBlock"]
- def __init__(self, config):
- super().__init__(config)
- self.visual = Glm4vVisionModel._from_config(config.vision_config)
- self.language_model = Glm4vTextModel._from_config(config.text_config)
- self.rope_deltas = None # cache rope_deltas here
- # Initialize weights and apply final processing
- self.post_init()
- def get_input_embeddings(self):
- return self.language_model.get_input_embeddings()
- def set_input_embeddings(self, value):
- self.language_model.set_input_embeddings(value)
- def get_vision_position_ids(
- self,
- start_position: int,
- grid_thw: list[int, int, int] | torch.Tensor,
- temp_merge_size: int = 1,
- spatial_merge_size: int = 1,
- time_interval: int = 1,
- device: str | torch.device | None = None,
- ):
- """
- Compute 3D positional indices for vision tokens derived from a single image or video input.
- The positions are generated from the input grid defined by temporal (T), height (H), and
- width (W) dimensions. Temporal and spatial dimensions can be downscaled according to the
- merge sizes used in the vision backbone. The resulting positions are offset by `start_position`.
- Args:
- start_position (`int`):
- Offset added to all computed positional indices.
- grid_thw (`Sequence[int]` or `torch.Tensor` of shape `(3,)`):
- The (T, H, W) grid representing the feature layout of the current image or video after patch embedding.
- temp_merge_size (`int`, *optional*):
- Factor by which the temporal dimension is reduced in the backbone. The temporal grid size is divided
- by this value. Defaults to 1.
- spatial_merge_size (`int`, *optional*):
- Factor by which the spatial dimensions (H and W) are reduced in the backbone. Both H and W are divided
- by this value. Defaults to 1.
- time_interval (`int`, *optional*):
- Spacing factor applied between consecutive temporal position indices.Defaults to 1.
- device (`str` or `torch.device`, *optional*):
- Device on which the resulting tensor is allocated. If `None`, uses the current default device.
- Returns:
- torch.LongTensor of shape (3, sequence_length):
- Positional indices for temporal, height, and width dimensions,
- flattened into sequence form and offset by `start_position`.
- """
- llm_grid_t, llm_grid_h, llm_grid_w = (
- grid_thw[0].item() // temp_merge_size,
- grid_thw[1].item() // spatial_merge_size,
- grid_thw[2].item() // spatial_merge_size,
- )
- image_seq_length = llm_grid_h * llm_grid_w * llm_grid_t
- position_width = torch.arange(start_position, start_position + llm_grid_w, device=device).repeat(
- llm_grid_h * llm_grid_t
- )
- position_height = torch.arange(start_position, start_position + llm_grid_h, device=device).repeat_interleave(
- llm_grid_w * llm_grid_t
- )
- position_temporal = torch.full((image_seq_length,), start_position, device=device, dtype=torch.long)
- position_temporal = position_temporal * time_interval
- vision_position_ids = torch.stack([position_temporal, position_height, position_width], dim=0)
- return vision_position_ids
- def get_rope_index(
- self,
- input_ids: torch.LongTensor,
- mm_token_type_ids: torch.IntTensor,
- image_grid_thw: torch.LongTensor | None = None,
- video_grid_thw: torch.LongTensor | None = None,
- attention_mask: torch.Tensor | None = None,
- **kwargs,
- ) -> tuple[torch.Tensor, torch.Tensor]:
- """
- Calculate the 3D rope index based on image and video's sizes. The utility expects a `vision + text`
- sequence and will error out otherwise. For pure text sequence, please rely on model's auto-inferred
- position ids. In a mixed vision + text sequence, vision tokens use 3D RoPE (temporal, height, width)
- while text tokens use standard 1D RoPE.
- Example:
- Temporal patches: 3; Height patches: 2; Width patches: 2
- Each vision input results in (temporal x height × width) positions. Here: 3 x 2 × 2 = 12 positions total.
- Temporal position IDs are spaced by:
- `interval = tokens_per_second * temporal_patch_size / fps`
- If fps = 1; tokens_per_second = 25; temporal_patch_size = 2, temporal IDs increase by 50 for each temporal patch:
- `[0, 0, 0, 0, 50, 50, 50, 50, 100, 100, 100, 100]`
- Height IDs repeat per row: `[0, 0, 1, 1, ...]`
- Width IDs alternate per column: `[0, 1, 0, 1, ...]`
- Text tokens follow standard 1D RoPE and the position IDs grow consequently with a step of `1`
- Args:
- input_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`):
- Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide
- it.
- mm_token_type_ids (`torch.IntTensor` of shape `(batch_size, sequence_length)`):
- Token type ids matching each modality to a different value in the input sequence, i.e. text (0), image (1), video (2).
- image_grid_thw (`torch.LongTensor` of shape `(num_images, 3)`, *optional*):
- The temporal, height and width of feature shape of each image in LLM.
- video_grid_thw (`torch.LongTensor` of shape `(num_videos, 3)`, *optional*):
- The temporal, height and width of feature shape of each video in LLM.
- attention_mask (`torch.Tensor` of shape `(batch_size, sequence_length)`, *optional*):
- Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`:
- - 1 for tokens that are **not masked**,
- - 0 for tokens that are **masked**.
- Returns:
- position_ids (`torch.LongTensor` of shape `(3, batch_size, sequence_length)`)
- mrope_position_deltas (`torch.Tensor` of shape `(batch_size)`)
- """
- spatial_merge_size = self.config.vision_config.spatial_merge_size
- mrope_position_deltas = []
- position_ids = torch.zeros(
- 3,
- input_ids.shape[0],
- input_ids.shape[1],
- dtype=input_ids.dtype,
- device=input_ids.device,
- )
- grid_iters = {
- 1: iter(image_grid_thw) if image_grid_thw is not None else None,
- 2: iter(video_grid_thw) if video_grid_thw is not None else None,
- }
- for batch_idx, current_input_ids in enumerate(input_ids):
- input_token_type = mm_token_type_ids[batch_idx]
- if attention_mask is not None:
- current_input_ids = current_input_ids[attention_mask[batch_idx].bool()]
- input_token_type = input_token_type[attention_mask[batch_idx].bool()]
- input_type_group = []
- for key, group in itertools.groupby(enumerate(input_token_type.tolist()), lambda x: x[1]):
- group = list(group)
- start_index = group[0][0]
- end_index = group[-1][0] + 1
- input_type_group.append((key, start_index, end_index))
- current_pos = 0
- video_group_index = 0
- llm_pos_ids_list = []
- for modality_type, start_idx, end_idx in input_type_group:
- # text == 0
- if modality_type == 0:
- text_len = end_idx - start_idx
- llm_pos_ids_list.append(
- torch.arange(text_len, device=input_ids.device).view(1, -1).expand(3, -1) + current_pos
- )
- current_pos += text_len
- # image == 1, video == 2
- else:
- # GLM4V splits video into segments per frame but there's only one `grid_thw`
- # per whole video. We can't exhaus the iterator and have to re-use the grid
- # while processing the same video!
- if modality_type == 2:
- if video_group_index == 0:
- grid_thw = next(grid_iters[modality_type])
- video_group_index += 1
- video_group_index = 0 if video_group_index >= grid_thw[0] else video_group_index
- else:
- grid_thw = next(grid_iters[modality_type])
- # Videos are processed per frame separately, each temporal grid is always `1`
- temp_merge_size = grid_thw[0]
- vision_position_ids = self.get_vision_position_ids(
- current_pos, grid_thw, temp_merge_size, spatial_merge_size, device=input_ids.device
- )
- llm_pos_ids_list.append(vision_position_ids)
- current_pos += max(grid_thw[1], grid_thw[2]) // spatial_merge_size
- llm_positions = torch.cat(llm_pos_ids_list, dim=1).reshape(3, -1)
- if attention_mask is not None:
- position_ids[:, batch_idx, attention_mask[batch_idx].bool()] = llm_positions.to(position_ids.device)
- else:
- position_ids[:, batch_idx] = llm_positions.to(position_ids.device)
- mrope_position_deltas.append(llm_positions.max() + 1 - len(current_input_ids))
- mrope_position_deltas = torch.tensor(mrope_position_deltas, device=input_ids.device).unsqueeze(1)
- return position_ids, mrope_position_deltas
- @can_return_tuple
- @auto_docstring
- def get_video_features(
- self,
- pixel_values_videos: torch.FloatTensor,
- video_grid_thw: torch.LongTensor | None = None,
- **kwargs: Unpack[TransformersKwargs],
- ) -> tuple | BaseModelOutputWithPooling:
- r"""
- pixel_values_videos (`torch.FloatTensor` of shape `(batch_size, num_channels, image_size, image_size)`):
- The tensors corresponding to the input videos.
- video_grid_thw (`torch.LongTensor` of shape `(num_videos, 3)`, *optional*):
- The temporal, height and width of feature shape of each video in LLM.
- """
- pixel_values_videos = pixel_values_videos.type(self.visual.dtype)
- # reshape video_grid_thw -> [b, 3] -> [1, h, w] * frames
- temp_frames_hw = []
- video_grid_thw_list = video_grid_thw.tolist()
- for t, h, w in video_grid_thw_list:
- repeated_row = torch.tensor([1, h, w]).unsqueeze(0).repeat(t, 1)
- temp_frames_hw.append(repeated_row)
- flattened_video_grid_thw = torch.cat(temp_frames_hw, dim=0)
- vision_outputs = self.visual(
- pixel_values_videos, grid_thw=flattened_video_grid_thw, return_dict=True, **kwargs
- )
- split_sizes = (video_grid_thw.prod(-1) // self.visual.spatial_merge_size**2).tolist()
- video_embeds = torch.split(vision_outputs.pooler_output, split_sizes)
- vision_outputs.pooler_output = video_embeds
- return vision_outputs
- @can_return_tuple
- @auto_docstring
- def get_image_features(
- self,
- pixel_values: torch.FloatTensor,
- image_grid_thw: torch.LongTensor | None = None,
- **kwargs: Unpack[TransformersKwargs],
- ) -> tuple | BaseModelOutputWithPooling:
- r"""
- pixel_values (`torch.FloatTensor` of shape `(batch_size, num_channels, image_size, image_size)`):
- The tensors corresponding to the input images.
- image_grid_thw (`torch.LongTensor` of shape `(num_images, 3)`, *optional*):
- The temporal, height and width of feature shape of each image in LLM.
- """
- pixel_values = pixel_values.type(self.visual.dtype)
- vision_outputs = self.visual(pixel_values, grid_thw=image_grid_thw, **kwargs)
- split_sizes = (image_grid_thw.prod(-1) // self.visual.spatial_merge_size**2).tolist()
- image_embeds = torch.split(vision_outputs.pooler_output, split_sizes)
- vision_outputs.pooler_output = image_embeds
- return vision_outputs
- def get_placeholder_mask(
- self,
- input_ids: torch.LongTensor,
- inputs_embeds: torch.FloatTensor,
- image_features: torch.FloatTensor | None = None,
- video_features: torch.FloatTensor | None = None,
- ):
- """
- Obtains multimodal placeholder mask from `input_ids` or `inputs_embeds`, and checks that the placeholder token count is
- equal to the length of multimodal features. If the lengths are different, an error is raised.
- """
- if input_ids is None:
- special_image_mask = inputs_embeds == self.get_input_embeddings()(
- torch.tensor(self.config.image_token_id, dtype=torch.long, device=inputs_embeds.device)
- )
- special_image_mask = special_image_mask.all(-1)
- special_video_mask = inputs_embeds == self.get_input_embeddings()(
- torch.tensor(self.config.video_token_id, dtype=torch.long, device=inputs_embeds.device)
- )
- special_video_mask = special_video_mask.all(-1)
- else:
- # GLM-4.1V and GLM-4.5V special_video_mask is special_image_mask
- special_image_mask = input_ids == self.config.image_token_id
- special_video_mask = input_ids == self.config.image_token_id
- n_image_tokens = special_image_mask.sum()
- special_image_mask = special_image_mask.unsqueeze(-1).expand_as(inputs_embeds).to(inputs_embeds.device)
- if image_features is not None:
- torch_compilable_check(
- inputs_embeds[special_image_mask].numel() == image_features.numel(),
- f"Image features and image tokens do not match, tokens: {n_image_tokens}, features: {image_features.shape[0]}",
- )
- n_video_tokens = special_video_mask.sum()
- special_video_mask = special_video_mask.unsqueeze(-1).expand_as(inputs_embeds).to(inputs_embeds.device)
- if video_features is not None:
- torch_compilable_check(
- inputs_embeds[special_video_mask].numel() == video_features.numel(),
- f"Video features and video tokens do not match, tokens: {n_video_tokens}, features: {video_features.shape[0]}",
- )
- return special_image_mask, special_video_mask
- def compute_3d_position_ids(
- self,
- input_ids: torch.Tensor | None,
- inputs_embeds: torch.Tensor | None,
- image_grid_thw: torch.Tensor | None = None,
- video_grid_thw: torch.Tensor | None = None,
- attention_mask: torch.Tensor | None = None,
- past_key_values: torch.Tensor | None = None,
- mm_token_type_ids: torch.IntTensor | None = None,
- ) -> torch.Tensor | None:
- past_key_values_length = 0 if past_key_values is None else past_key_values.get_seq_length()
- has_multimodal = image_grid_thw is not None or video_grid_thw is not None
- if has_multimodal and mm_token_type_ids is None and input_ids is not None:
- raise ValueError(
- "Multimodal data was passed (via `image_grid_thw` or `video_grid_thw`) but `mm_token_type_ids` is "
- "missing. Please pass `mm_token_type_ids` to the model so that multimodal RoPE (M-RoPE) can be "
- "computed correctly. `mm_token_type_ids` is returned by the processor alongside `input_ids`."
- )
- can_compute_mrope = input_ids is not None and mm_token_type_ids is not None and has_multimodal
- if can_compute_mrope and (self.rope_deltas is None or past_key_values_length == 0):
- position_ids, rope_deltas = self.get_rope_index(
- input_ids,
- image_grid_thw=image_grid_thw,
- video_grid_thw=video_grid_thw,
- attention_mask=attention_mask,
- mm_token_type_ids=mm_token_type_ids,
- )
- self.rope_deltas = rope_deltas
- # Use pre-calculated rope-deltas to infer correct 3D position ids during incremental
- # generation (past_key_values_length > 0) or when only inputs_embeds is provided (no input_ids
- # to recompute from). Skip when input_ids is provided without past_key_values to avoid shape
- # mismatches from stale rope_deltas (e.g., training forward pass after generation).
- elif self.rope_deltas is not None and (past_key_values_length > 0 or input_ids is None):
- batch_size, seq_length, _ = inputs_embeds.shape
- if attention_mask is not None:
- position_ids = attention_mask.long().cumsum(-1) - 1
- position_ids = position_ids.masked_fill(attention_mask == 0, 0)
- position_ids = position_ids.view(1, batch_size, -1).repeat(3, 1, 1).to(inputs_embeds.device)
- else:
- position_ids = torch.arange(past_key_values_length, past_key_values_length + seq_length)
- position_ids = position_ids.view(1, 1, -1).expand(3, batch_size, -1).to(inputs_embeds.device)
- delta = self.rope_deltas.repeat_interleave(batch_size // self.rope_deltas.shape[0], dim=0)
- position_ids = position_ids + delta.to(device=inputs_embeds.device)
- else:
- # Can't build correct 3D positions. Let the model infer it
- position_ids = None
- return position_ids
- @auto_docstring
- @can_return_tuple
- def forward(
- self,
- input_ids: torch.LongTensor | None = None,
- attention_mask: torch.Tensor | None = None,
- position_ids: torch.LongTensor | None = None,
- past_key_values: Cache | None = None,
- inputs_embeds: torch.FloatTensor | None = None,
- pixel_values: torch.Tensor | None = None,
- pixel_values_videos: torch.FloatTensor | None = None,
- image_grid_thw: torch.LongTensor | None = None,
- video_grid_thw: torch.LongTensor | None = None,
- rope_deltas: torch.LongTensor | None = None,
- mm_token_type_ids: torch.IntTensor | None = None,
- **kwargs: Unpack[TransformersKwargs],
- ) -> tuple | Glm4vModelOutputWithPast:
- r"""
- image_grid_thw (`torch.LongTensor` of shape `(num_images, 3)`, *optional*):
- The temporal, height and width of feature shape of each image in LLM.
- video_grid_thw (`torch.LongTensor` of shape `(num_videos, 3)`, *optional*):
- The temporal, height and width of feature shape of each video in LLM.
- rope_deltas (`torch.LongTensor` of shape `(batch_size, )`, *optional*):
- The rope index difference between sequence length and multimodal rope.
- """
- if (input_ids is None) ^ (inputs_embeds is not None):
- raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
- if inputs_embeds is None:
- inputs_embeds = self.get_input_embeddings()(input_ids)
- if pixel_values is not None:
- image_embeds = self.get_image_features(pixel_values, image_grid_thw, return_dict=True).pooler_output
- image_embeds = torch.cat(image_embeds, dim=0).to(inputs_embeds.device, inputs_embeds.dtype)
- image_mask, _ = self.get_placeholder_mask(input_ids, inputs_embeds, image_features=image_embeds)
- inputs_embeds = inputs_embeds.masked_scatter(image_mask, image_embeds)
- if pixel_values_videos is not None:
- video_embeds = self.get_video_features(pixel_values_videos, video_grid_thw, return_dict=True).pooler_output
- video_embeds = torch.cat(video_embeds, dim=0).to(inputs_embeds.device, inputs_embeds.dtype)
- _, video_mask = self.get_placeholder_mask(input_ids, inputs_embeds, video_features=video_embeds)
- inputs_embeds = inputs_embeds.masked_scatter(video_mask, video_embeds)
- if position_ids is None:
- position_ids = self.compute_3d_position_ids(
- input_ids=input_ids,
- image_grid_thw=image_grid_thw,
- video_grid_thw=video_grid_thw,
- inputs_embeds=inputs_embeds,
- attention_mask=attention_mask,
- past_key_values=past_key_values,
- mm_token_type_ids=mm_token_type_ids,
- )
- outputs = self.language_model(
- input_ids=None,
- position_ids=position_ids,
- attention_mask=attention_mask,
- past_key_values=past_key_values,
- inputs_embeds=inputs_embeds,
- **kwargs,
- )
- return Glm4vModelOutputWithPast(
- **outputs,
- rope_deltas=self.rope_deltas,
- )
- @dataclass
- @auto_docstring(
- custom_intro="""
- Base class for Glm4v causal language model (or autoregressive) outputs.
- """
- )
- class Glm4vCausalLMOutputWithPast(ModelOutput):
- r"""
- loss (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `labels` is provided):
- Language modeling loss (for next-token prediction).
- logits (`torch.FloatTensor` of shape `(batch_size, sequence_length, config.vocab_size)`):
- Prediction scores of the language modeling head (scores for each vocabulary token before SoftMax).
- past_key_values (`Cache`, *optional*, returned when `use_cache=True` is passed or when `config.use_cache=True`):
- It is a [`~cache_utils.Cache`] instance. For more details, see our [kv cache guide](https://huggingface.co/docs/transformers/en/kv_cache).
- Contains pre-computed hidden-states (key and values in the self-attention blocks) that can be used (see
- `past_key_values` input) to speed up sequential decoding.
- rope_deltas (`torch.LongTensor` of shape `(batch_size, )`, *optional*):
- The rope index difference between sequence length and multimodal rope.
- """
- loss: torch.FloatTensor | None = None
- logits: torch.FloatTensor | None = None
- past_key_values: Cache | None = None
- hidden_states: tuple[torch.FloatTensor] | None = None
- attentions: tuple[torch.FloatTensor] | None = None
- rope_deltas: torch.LongTensor | None = None
- class Glm4vForConditionalGeneration(Glm4vPreTrainedModel, GenerationMixin):
- _tied_weights_keys = {"lm_head.weight": "model.language_model.embed_tokens.weight"}
- # Reference: fix gemma3 grad acc #37208
- accepts_loss_kwargs = False
- def __init__(self, config):
- super().__init__(config)
- self.model = Glm4vModel(config)
- self.lm_head = nn.Linear(config.text_config.hidden_size, config.text_config.vocab_size, bias=False)
- self.post_init()
- def get_input_embeddings(self):
- return self.model.get_input_embeddings()
- def set_input_embeddings(self, value):
- self.model.set_input_embeddings(value)
- @auto_docstring
- def get_video_features(
- self,
- pixel_values_videos: torch.FloatTensor,
- video_grid_thw: torch.LongTensor | None = None,
- **kwargs: Unpack[TransformersKwargs],
- ) -> tuple | BaseModelOutputWithPooling:
- r"""
- pixel_values_videos (`torch.FloatTensor` of shape `(batch_size, num_channels, image_size, image_size)`):
- The tensors corresponding to the input videos.
- video_grid_thw (`torch.LongTensor` of shape `(num_videos, 3)`, *optional*):
- The temporal, height and width of feature shape of each video in LLM.
- """
- return self.model.get_video_features(
- pixel_values_videos=pixel_values_videos, video_grid_thw=video_grid_thw, **kwargs
- )
- @auto_docstring
- def get_image_features(
- self,
- pixel_values: torch.FloatTensor,
- image_grid_thw: torch.LongTensor | None = None,
- **kwargs: Unpack[TransformersKwargs],
- ) -> tuple | BaseModelOutputWithPooling:
- r"""
- pixel_values (`torch.FloatTensor` of shape `(batch_size, num_channels, image_size, image_size)`):
- The tensors corresponding to the input images.
- image_grid_thw (`torch.LongTensor` of shape `(num_images, 3)`, *optional*):
- The temporal, height and width of feature shape of each image in LLM.
- """
- return self.model.get_image_features(pixel_values=pixel_values, image_grid_thw=image_grid_thw, **kwargs)
- @can_return_tuple
- @auto_docstring
- def forward(
- self,
- input_ids: torch.LongTensor | None = None,
- attention_mask: torch.Tensor | None = None,
- position_ids: torch.LongTensor | None = None,
- past_key_values: Cache | None = None,
- inputs_embeds: torch.FloatTensor | None = None,
- labels: torch.LongTensor | None = None,
- pixel_values: torch.Tensor | None = None,
- pixel_values_videos: torch.FloatTensor | None = None,
- image_grid_thw: torch.LongTensor | None = None,
- video_grid_thw: torch.LongTensor | None = None,
- mm_token_type_ids: torch.IntTensor | None = None,
- logits_to_keep: int | torch.Tensor = 0,
- **kwargs: Unpack[TransformersKwargs],
- ) -> tuple | Glm4vCausalLMOutputWithPast:
- r"""
- labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
- Labels for computing the masked language modeling loss. Indices should either be in `[0, ...,
- config.vocab_size]` or -100 (see `input_ids` docstring). Tokens with indices set to `-100` are ignored
- (masked), the loss is only computed for the tokens with labels in `[0, ..., config.vocab_size]`.
- image_grid_thw (`torch.LongTensor` of shape `(num_images, 3)`, *optional*):
- The temporal, height and width of feature shape of each image in LLM.
- video_grid_thw (`torch.LongTensor` of shape `(num_videos, 3)`, *optional*):
- The temporal, height and width of feature shape of each video in LLM.
- Example:
- ```python
- >>> from PIL import Image
- >>> import httpx
- >>> from io import BytesIO
- >>> from transformers import AutoProcessor, Glm4vForConditionalGeneration
- >>> model = Glm4vForConditionalGeneration.from_pretrained("zai-org/GLM-4.1V-9B-Thinking")
- >>> processor = AutoProcessor.from_pretrained("zai-org/GLM-4.1V-9B-Thinking")
- >>> messages = [
- {
- "role": "user",
- "content": [
- {"type": "image", "url": "https://www.ilankelman.org/stopsigns/australia.jpg"},
- {"type": "text", "text": "What is shown in this image?"},
- ],
- },
- ]
- >>> url = "https://www.ilankelman.org/stopsigns/australia.jpg"
- >>> with httpx.stream("GET", url) as response:
- ... image = Image.open(BytesIO(response.read()))
- >>> text = processor.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
- >>> inputs = processor(text=[text], images=[image], vision_infos=[vision_infos])
- >>> # Generate
- >>> generate_ids = model.generate(inputs.input_ids, max_length=30)
- >>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
- "The image shows a street scene with a red stop sign in the foreground. In the background, there is a large red gate with Chinese characters ..."
- ```"""
- outputs = self.model(
- input_ids=input_ids,
- pixel_values=pixel_values,
- pixel_values_videos=pixel_values_videos,
- image_grid_thw=image_grid_thw,
- video_grid_thw=video_grid_thw,
- mm_token_type_ids=mm_token_type_ids,
- position_ids=position_ids,
- attention_mask=attention_mask,
- past_key_values=past_key_values,
- inputs_embeds=inputs_embeds,
- **kwargs,
- )
- hidden_states = outputs[0]
- # Only compute necessary logits, and do not upcast them to float if we are not computing the loss
- slice_indices = slice(-logits_to_keep, None) if isinstance(logits_to_keep, int) else logits_to_keep
- logits = self.lm_head(hidden_states[:, slice_indices, :])
- loss = None
- if labels is not None:
- loss = self.loss_function(logits=logits, labels=labels, vocab_size=self.config.text_config.vocab_size)
- return Glm4vCausalLMOutputWithPast(
- loss=loss,
- logits=logits,
- past_key_values=outputs.past_key_values,
- hidden_states=outputs.hidden_states,
- attentions=outputs.attentions,
- rope_deltas=outputs.rope_deltas,
- )
- def prepare_inputs_for_generation(
- self,
- input_ids,
- past_key_values=None,
- attention_mask=None,
- inputs_embeds=None,
- position_ids=None,
- use_cache=True,
- pixel_values=None,
- pixel_values_videos=None,
- image_grid_thw=None,
- video_grid_thw=None,
- is_first_iteration=False,
- **kwargs,
- ):
- # Overwritten -- in specific circumstances we don't want to forward image inputs to the model
- model_inputs = super().prepare_inputs_for_generation(
- input_ids,
- past_key_values=past_key_values,
- attention_mask=attention_mask,
- inputs_embeds=inputs_embeds,
- position_ids=position_ids,
- pixel_values=pixel_values,
- pixel_values_videos=pixel_values_videos,
- image_grid_thw=image_grid_thw,
- video_grid_thw=video_grid_thw,
- use_cache=use_cache,
- is_first_iteration=is_first_iteration,
- **kwargs,
- )
- if not is_first_iteration and use_cache:
- model_inputs["pixel_values"] = None
- model_inputs["pixel_values_videos"] = None
- return model_inputs
- def _prepare_position_ids_for_generation(self, inputs_tensor, model_kwargs):
- # Overwritten -- requires 3D position ids
- text_positions = super()._prepare_position_ids_for_generation(inputs_tensor, model_kwargs)
- # Early exit in case we are continuing generation from past kv
- past_length = 0
- if (cache := model_kwargs.get("past_key_values")) is not None:
- past_length = cache.get_seq_length()
- if past_length != 0 and self.model.rope_deltas is not None:
- position_ids = text_positions[None, ...] + self.model.rope_deltas
- return position_ids
- # Otherwise compute 3d position ids for vision tokens and concat with text position ids
- if "input_ids" in model_kwargs and model_kwargs["input_ids"].shape[1] > 0:
- inputs_tensor = model_kwargs["input_ids"]
- is_input_ids = len(inputs_tensor.shape) == 2 and inputs_tensor.dtype in [torch.int, torch.long]
- if (
- is_input_ids
- and model_kwargs.get("mm_token_type_ids") is not None
- and (model_kwargs.get("image_grid_thw") is not None or model_kwargs.get("video_grid_thw") is not None)
- ):
- model_kwargs = {k: v for k, v in model_kwargs.items() if k != "input_ids"}
- vision_positions, rope_deltas = self.model.get_rope_index(inputs_tensor, **model_kwargs)
- self.model.rope_deltas = rope_deltas
- else:
- vision_positions = text_positions.unsqueeze(0).expand(3, -1, -1)
- self.model.rope_deltas = torch.zeros(
- inputs_tensor.shape[0], 1, dtype=torch.long, device=inputs_tensor.device
- )
- # Concatenate "text + vision" positions into [4, bs, seq-len]
- text_positions = text_positions[None, ...]
- position_ids = torch.cat([text_positions, vision_positions], dim=0)
- return position_ids
- def _get_image_nums_and_video_nums(
- self,
- input_ids: torch.LongTensor | None,
- inputs_embeds: torch.Tensor | None = None,
- ) -> tuple[torch.Tensor, torch.Tensor]:
- """
- Get the number of images and videos for each sample to calculate the separation length of the sample tensor.
- These parameters are not passed through the processor to avoid unpredictable impacts from interface modifications.
- Args:
- input_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`):
- Indices of input sequence tokens in the vocabulary.
- Returns:
- image_nums (`torch.LongTensor` of shape `(batch_size, num_images_sample)`)
- video_nums (`torch.LongTensor` of shape `(batch_size, num_videos_sample)`)
- """
- if inputs_embeds is not None:
- is_image = (
- inputs_embeds
- == self.get_input_embeddings()(
- torch.tensor(self.config.image_start_token_id, dtype=torch.long, device=inputs_embeds.device)
- )
- )[..., 0]
- is_video_start = (
- inputs_embeds
- == self.get_input_embeddings()(
- torch.tensor(self.config.video_start_token_id, dtype=torch.long, device=inputs_embeds.device)
- )
- )[..., 0]
- is_video_end = (
- inputs_embeds
- == self.get_input_embeddings()(
- torch.tensor(self.config.video_end_token_id, dtype=torch.long, device=inputs_embeds.device)
- )
- )[..., 0]
- else:
- is_image = input_ids == self.config.image_start_token_id
- is_video_start = input_ids == self.config.video_start_token_id
- is_video_end = input_ids == self.config.video_end_token_id
- # Cumulative sum to track if we're inside a video span
- # We'll assume well-formed video tags (i.e. matching starts and ends)
- video_level = torch.cumsum(is_video_start.int() - is_video_end.int(), dim=1)
- inside_video = video_level > 0 # shape (batch_size, seq_length)
- # Mask out image tokens that are inside video spans
- standalone_images = is_image & (~inside_video)
- # Count per batch
- image_counts = standalone_images.sum(dim=1)
- video_counts = is_video_start.sum(dim=1)
- return image_counts, video_counts
- def _expand_inputs_for_generation(
- self,
- expand_size: int = 1,
- is_encoder_decoder: bool = False,
- input_ids: torch.LongTensor | None = None,
- **model_kwargs,
- ) -> tuple[torch.LongTensor, dict[str, Any]]:
- # Overwritten -- Support for expanding tensors without a batch size dimension
- # e.g., pixel_values, image_grid_thw, pixel_values_videos, video_grid_thw, second_per_grid_t
- # pixel_values.shape[0] is sum(seqlen_images for samples)
- # image_grid_thw.shape[0] is sum(num_images for samples)
- if expand_size == 1:
- return input_ids, model_kwargs
- visual_keys = ["pixel_values", "image_grid_thw", "pixel_values_videos", "video_grid_thw", "second_per_grid_ts"]
- def _expand_dict_for_generation_visual(dict_to_expand):
- image_grid_thw = model_kwargs.get("image_grid_thw", None)
- video_grid_thw = model_kwargs.get("video_grid_thw", None)
- image_nums, video_nums = self._get_image_nums_and_video_nums(
- input_ids, inputs_embeds=model_kwargs.get("inputs_embeds", None)
- )
- def _repeat_interleave_samples(x, lengths, repeat_times):
- samples = torch.split(x, lengths)
- repeat_args = [repeat_times] + [1] * (x.dim() - 1)
- result = torch.cat([sample.repeat(*repeat_args) for sample in samples], dim=0)
- return result
- for key in dict_to_expand:
- if key == "pixel_values":
- # split images into samples
- samples = torch.split(image_grid_thw, list(image_nums))
- # compute the sequence length of images for each sample
- lengths = [torch.prod(sample, dim=1).sum() for sample in samples]
- dict_to_expand[key] = _repeat_interleave_samples(
- dict_to_expand[key], lengths=lengths, repeat_times=expand_size
- )
- elif key == "image_grid_thw":
- # get the num of images for each sample
- lengths = list(image_nums)
- dict_to_expand[key] = _repeat_interleave_samples(
- dict_to_expand[key], lengths=lengths, repeat_times=expand_size
- )
- elif key == "pixel_values_videos":
- samples = torch.split(video_grid_thw, list(video_nums))
- lengths = [torch.prod(sample, dim=1).sum() for sample in samples]
- dict_to_expand[key] = _repeat_interleave_samples(
- dict_to_expand[key], lengths=lengths, repeat_times=expand_size
- )
- elif key == "video_grid_thw":
- lengths = list(video_nums)
- dict_to_expand[key] = _repeat_interleave_samples(
- dict_to_expand[key], lengths=lengths, repeat_times=expand_size
- )
- elif key == "second_per_grid_ts":
- dict_to_expand[key] = _repeat_interleave_samples(
- dict_to_expand[key], lengths=list(video_nums), repeat_times=expand_size
- )
- return dict_to_expand
- def _expand_dict_for_generation(dict_to_expand):
- for key in dict_to_expand:
- if key == "position_ids" and dict_to_expand[key].ndim == 3:
- dict_to_expand[key] = dict_to_expand[key].repeat_interleave(expand_size, dim=1)
- elif (
- dict_to_expand[key] is not None
- and isinstance(dict_to_expand[key], torch.Tensor)
- and key not in visual_keys
- ):
- dict_to_expand[key] = dict_to_expand[key].repeat_interleave(expand_size, dim=0)
- return dict_to_expand
- model_kwargs = _expand_dict_for_generation_visual(model_kwargs)
- if input_ids is not None:
- input_ids = input_ids.repeat_interleave(expand_size, dim=0)
- model_kwargs = _expand_dict_for_generation(model_kwargs)
- if is_encoder_decoder:
- if model_kwargs.get("encoder_outputs") is None:
- raise ValueError("If `is_encoder_decoder` is True, make sure that `encoder_outputs` is defined.")
- model_kwargs["encoder_outputs"] = _expand_dict_for_generation(model_kwargs["encoder_outputs"])
- return input_ids, model_kwargs
- __all__ = ["Glm4vForConditionalGeneration", "Glm4vModel", "Glm4vPreTrainedModel", "Glm4vTextModel", "Glm4vVisionModel"]
|