qwen2_vl.py 59.4 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Adapted from
# https://github.com/huggingface/transformers/blob/19e6e80e10118f855137b90740936c0b11ac397f/src/transformers/models/qwen2_vl/modeling_qwen2_vl.py
# Copyright 2024 The Qwen team.
# Copyright 2023 The vLLM team.
# Copyright 2022 EleutherAI and the HuggingFace Inc. team. All rights reserved.
#
# This code is based on EleutherAI's GPT-NeoX library and the GPT-NeoX
# and OPT implementations in this library. It has been modified from its
# original forms to accommodate minor architectural differences compared
# to GPT-NeoX and OPT used by the Meta AI team that trained the model.
#
# 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.
"""Inference-only Qwen2-VL model compatible with HuggingFace weights."""
27
from collections.abc import Iterable, Mapping, Sequence
28
from functools import partial
29
from typing import Any, Callable, Literal, Optional, TypedDict, Union
30
31
32
33
34

import torch
import torch.nn as nn
import torch.nn.functional as F
from einops import rearrange, repeat
35
from transformers import AutoConfig, BatchFeature
36
37
from transformers.models.qwen2_vl import (Qwen2VLImageProcessor,
                                          Qwen2VLProcessor)
38
39
from transformers.models.qwen2_vl.configuration_qwen2_vl import (
    Qwen2VLConfig, Qwen2VLVisionConfig)
40
from transformers.models.qwen2_vl.image_processing_qwen2_vl import smart_resize
41
42
from transformers.models.qwen2_vl.video_processing_qwen2_vl import (
    Qwen2VLVideoProcessor)
43

44
from vllm.config import VllmConfig
45
from vllm.distributed import parallel_state, tensor_model_parallel_all_gather
46
47
48
49
50
51
52
from vllm.distributed import utils as dist_utils
from vllm.logger import init_logger
from vllm.model_executor import SamplingMetadata
from vllm.model_executor.layers.activation import QuickGELU
from vllm.model_executor.layers.linear import (ColumnParallelLinear,
                                               RowParallelLinear)
from vllm.model_executor.layers.quantization import QuantizationConfig
53
54
55
from vllm.model_executor.layers.quantization.gptq import GPTQConfig
from vllm.model_executor.layers.quantization.gptq_marlin import (
    GPTQMarlinConfig)
56
from vllm.model_executor.model_loader.weight_utils import default_weight_loader
57
from vllm.model_executor.models.module_mapping import MultiModelKeys
58
from vllm.multimodal import MULTIMODAL_REGISTRY
59
from vllm.multimodal.inputs import (ImageItem, ModalityData,
60
61
                                    MultiModalDataDict, MultiModalFieldConfig,
                                    MultiModalKwargs, VideoItem)
zhuwenwen's avatar
zhuwenwen committed
62
63
64
from vllm.multimodal.parse import (DictEmbeddingItems, ImageSize,
                                   ModalityDataItems, MultiModalDataItems,
                                   MultiModalDataParser)
65
from vllm.multimodal.processing import (BaseMultiModalProcessor,
66
67
                                        BaseProcessingInfo, PromptReplacement,
                                        PromptUpdate)
68
from vllm.multimodal.profiling import BaseDummyInputsBuilder
69
from vllm.platforms import _Backend, current_platform
70
from vllm.sequence import IntermediateTensors
71
from vllm.transformers_utils.config import uses_mrope
zhuwenwen's avatar
zhuwenwen committed
72
73
from vllm.transformers_utils.processor import (
    cached_image_processor_from_config)
74
from vllm.transformers_utils.tokenizer import AnyTokenizer
75

76
77
from .interfaces import (MultiModalEmbeddings, SupportsLoRA,
                         SupportsMultiModal, SupportsPP)
78
from .utils import (AutoWeightsLoader, WeightsMapper,
79
80
                    init_vllm_registered_model, maybe_prefix,
                    merge_multimodal_embeddings)
81
from .vision import get_vit_attn_backend
82

zhuwenwen's avatar
zhuwenwen committed
83
84
85
86
import os
import re
from vllm import _custom_ops as ops
from vllm.model_executor.utils import pad_weight, gemm_bank_conf
87
from vllm.platforms import current_platform
88
from vllm.utils import SUPPORT_TC
zhuwenwen's avatar
zhuwenwen committed
89

90
91
logger = init_logger(__name__)

92
93
94
# For profile run
_MAX_FRAMES_PER_VIDEO = 16

95
96
97
# === Vision Inputs === #


98
99
class Qwen2VLImagePixelInputs(TypedDict):
    type: Literal["pixel_values"]
100
    pixel_values: torch.Tensor
101
    """Shape:
102
103
104
105
106
107
108
109
110
    `(num_patches, num_channels * patch_size * patch_size)`
    """

    image_grid_thw: torch.Tensor
    """Shape: `(num_images, 3)`
    This should be in `(grid_t, grid_h, grid_w)` format.
    """


111
112
class Qwen2VLImageEmbeddingInputs(TypedDict):
    type: Literal["image_embeds"]
113
114
    image_embeds: torch.Tensor
    """Supported types:
115
    - list[`torch.Tensor`]: A list of tensors holding all images' features.
116
117
118
        Each tensor holds an image's features.
    - `torch.Tensor`: A tensor holding all images' features
        (concatenation of all images' feature tensors).
119
    
120
121
122
123
124
125
126
127
    Tensor shape: `(num_image_features, hidden_size)`
    - `num_image_features` varies based on
        the number and resolution of the images.
    - `hidden_size` must match the hidden size of language model backbone.
    """

    image_grid_thw: torch.Tensor
    """Shape: `(num_images, 3)`
128
129
130
131
    This should be in `(grid_t, grid_h, grid_w)` format.
    """


132
133
134
135
Qwen2VLImageInputs = Union[Qwen2VLImagePixelInputs,
                           Qwen2VLImageEmbeddingInputs]


136
137
class Qwen2VLVideoPixelInputs(TypedDict):
    type: Literal["pixel_values_videos"]
138
    pixel_values_videos: torch.Tensor
139
140
    """Shape:
    `(num_patches,
141
142
143
144
145
      num_channels * temporal_patch_size * patch_size * patch_size)`
    """

    video_grid_thw: torch.Tensor
    """Shape: `(num_videos, 3)`
146

147
148
149
150
    This should be in `(grid_t, grid_h, grid_w)` format.
    """


151
152
153
154
class Qwen2VLVideoEmbeddingInputs(TypedDict):
    type: Literal["video_embeds"]
    video_embeds: torch.Tensor
    """Supported types:
155
    - list[`torch.Tensor`]: A list of tensors holding all videos' features.
156
157
        Each tensor holds an video's features.
    - `torch.Tensor`: A tensor holding all videos' features
158
        (concatenation of all videos' feature tensors).
159
    
160
161
162
163
164
165
166
167
    Tensor shape: `(num_image_features, hidden_size)`
    - `num_image_features` varies based on 
        the number and resolution of the videos.
    - `hidden_size` must match the hidden size of language model backbone.
    """

    video_grid_thw: torch.Tensor
    """Shape: `(num_videos, 3)`
168
169
170
171
    This should be in `(grid_t, grid_h, grid_w)` format.
    """


172
173
174
Qwen2VLVideoInputs = Union[Qwen2VLVideoPixelInputs,
                           Qwen2VLVideoEmbeddingInputs]

175
176
177
178
179
180
181
182
# === Vision Encoder === #


class Qwen2VisionMLP(nn.Module):

    def __init__(
        self,
        in_features: int,
183
        hidden_features: int,
184
        act_layer: type[nn.Module] = QuickGELU,
185
        quant_config: Optional[QuantizationConfig] = None,
186
        prefix: str = "",
187
188
189
190
    ):
        super().__init__()
        self.fc1 = ColumnParallelLinear(in_features,
                                        hidden_features,
191
192
                                        quant_config=quant_config,
                                        prefix=f"{prefix}.fc1")
193
194
195
        self.act = act_layer()
        self.fc2 = RowParallelLinear(hidden_features,
                                     in_features,
196
197
                                     quant_config=quant_config,
                                     prefix=f"{prefix}.fc2")
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

    def forward(self, x: torch.Tensor) -> torch.Tensor:
        x_parallel, _ = self.fc1(x)
        x_parallel = self.act(x_parallel)
        x, _ = self.fc2(x_parallel)
        return x


def rotate_half(x: torch.Tensor, interleaved: bool = False) -> torch.Tensor:
    if not interleaved:
        x1, x2 = x.chunk(2, dim=-1)
        return torch.cat((-x2, x1), dim=-1)
    else:
        x1, x2 = x[..., ::2], x[..., 1::2]
        return rearrange(torch.stack((-x2, x1), dim=-1),
                         "... d two -> ... (d two)",
                         two=2)


def apply_rotary_emb_torch(x: torch.Tensor,
                           cos: torch.Tensor,
                           sin: torch.Tensor,
                           interleaved: bool = False) -> torch.Tensor:
    """
    x: (batch_size, seqlen, nheads, headdim)
    cos, sin: (seqlen, rotary_dim / 2) or (batch_size, seqlen, rotary_dim / 2)
    """
    ro_dim = cos.shape[-1] * 2
    assert ro_dim <= x.shape[-1]
    cos = repeat(
        cos,
        "... d -> ... 1 (2 d)" if not interleaved else "... d -> ... 1 (d 2)")
    sin = repeat(
        sin,
        "... d -> ... 1 (2 d)" if not interleaved else "... d -> ... 1 (d 2)")
    return torch.cat(
        [
            x[..., :ro_dim] * cos +
            rotate_half(x[..., :ro_dim], interleaved) * sin, x[..., ro_dim:]
        ],
        dim=-1,
    )


def apply_rotary_pos_emb_vision(t: torch.Tensor,
243
                                freqs: torch.Tensor) -> torch.Tensor:
244
245
246
    t_ = t.float()
    cos = freqs.cos()
    sin = freqs.sin()
zhuwenwen's avatar
zhuwenwen committed
247
    apply_rotary_emb = apply_rotary_emb_torch
248
249
    if current_platform.is_cuda():
        from vllm.vllm_flash_attn.layers.rotary import apply_rotary_emb
250
    if current_platform.is_rocm() and SUPPORT_TC:
251
        from flash_attn.layers.rotary import apply_rotary_emb
zhuwenwen's avatar
zhuwenwen committed
252
    output = apply_rotary_emb(t_, cos, sin).type_as(t)
253
254
255
256
257
258
259
    return output


class Qwen2VisionAttention(nn.Module):

    def __init__(
        self,
260
261
262
        embed_dim: int,
        num_heads: int,
        projection_size: int,
263
        quant_config: Optional[QuantizationConfig] = None,
264
        prefix: str = "",
265
266
267
268
    ) -> None:
        super().__init__()
        # Per attention head and per partition values.
        world_size = parallel_state.get_tensor_model_parallel_world_size()
269
270
        self.tp_size = world_size
        self.tp_rank = parallel_state.get_tensor_model_parallel_rank()
271
272
273
274
275
276
277
        self.hidden_size_per_attention_head = dist_utils.divide(
            projection_size, num_heads)
        self.num_attention_heads_per_partition = dist_utils.divide(
            num_heads, world_size)

        self.qkv = ColumnParallelLinear(input_size=embed_dim,
                                        output_size=3 * projection_size,
278
279
                                        quant_config=quant_config,
                                        prefix=f"{prefix}.qkv")
280
281
        self.proj = RowParallelLinear(input_size=projection_size,
                                      output_size=embed_dim,
282
283
                                      quant_config=quant_config,
                                      prefix=f"{prefix}.proj")
284
285

        # Detect attention implementation.
286
        self.attn_backend: _Backend = get_vit_attn_backend(support_fa=True)
287
288
289
290
291
        if self.attn_backend not in {
                _Backend.FLASH_ATTN, _Backend.TORCH_SDPA, _Backend.XFORMERS
        }:
            raise RuntimeError(
                f"Qwen2-VL does not support {self.attn_backend} backend now.")
292

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
    def split_qkv(self, qkv: torch.Tensor) -> tuple[torch.Tensor, ...]:
        # [s, b, 3 * head * head_dim]
        seq_len, bs, _ = qkv.shape
        if self.tp_size > 1:
            qkv = tensor_model_parallel_all_gather(qkv)

        # [s, b, 3 * head * head_dim] -> 3 * [s, b, head * head_dim]
        q, k, v = qkv.chunk(3, dim=2)

        # 3 * [s, b, head * head_dim]
        if self.tp_size > 1:
            splitter = partial(dist_utils.split_tensor_along_last_dim,
                               num_partitions=self.tp_size)
            q = splitter(q)[self.tp_rank]
            k = splitter(k)[self.tp_rank]
            v = splitter(v)[self.tp_rank]

        # 3 * [s, b, head * head_dim] -> 3 * [s, b, head, head_dim]
        new_shape = (seq_len, bs, self.num_attention_heads_per_partition,
                     self.hidden_size_per_attention_head)
        q, k, v = (x.view(*new_shape) for x in (q, k, v))
        return q, k, v

316
    def forward(
317
318
319
320
321
322
            self,
            x: torch.Tensor,
            cu_seqlens: torch.Tensor,
            rotary_pos_emb: torch.Tensor,
            max_seqlen: Optional[int] = None,  # Only used for Flash Attention
            seqlens: Optional[list[int]] = None,  # Only used for xFormers
323
324
    ) -> torch.Tensor:

325
326
        # [s, b, c] --> [s, b, 3 * head * head_dim]
        x, _ = self.qkv(x)
327

328
329
        # [s, b, 3 * head * head_dim] -> 3 * [s, b, head, head_dim]
        q, k, v = self.split_qkv(x)
330
331
        batch_size = q.shape[1]

332
333
        q, k, v = (rearrange(x, "s b ... -> b s ...").contiguous()
                   for x in (q, k, v))
334
335
336
337
        if rotary_pos_emb is not None:
            q = apply_rotary_pos_emb_vision(q, rotary_pos_emb)
            k = apply_rotary_pos_emb_vision(k, rotary_pos_emb)

338
        if self.attn_backend == _Backend.FLASH_ATTN:
339
340
341
342
343
            if not current_platform.is_rocm():
                from vllm_flash_attn.flash_attn_interface import (
                flash_attn_varlen_func)
            else:
                from flash_attn import flash_attn_varlen_func
344

345
            q, k, v = (rearrange(x, "b s ... -> (b s) ...") for x in [q, k, v])
346
347
348
349
350
351
352
353
354
355
356
357
358
359

            output = flash_attn_varlen_func(q,
                                            k,
                                            v,
                                            cu_seqlens_q=cu_seqlens,
                                            cu_seqlens_k=cu_seqlens,
                                            max_seqlen_q=max_seqlen,
                                            max_seqlen_k=max_seqlen,
                                            dropout_p=0,
                                            causal=False)

            context_layer = rearrange(output,
                                      "(b s) ... -> b s ...",
                                      b=batch_size)
360
        elif self.attn_backend == _Backend.TORCH_SDPA:
zhuwenwen's avatar
zhuwenwen committed
361
362
            # Execute attention entry by entry for speed & less VRAM.
            outputs = []
363
            for i in range(1, len(cu_seqlens)):
zhuwenwen's avatar
zhuwenwen committed
364
365
366
367
368
369
370
371
372
373
374
375
376
377
                start_idx = cu_seqlens[i - 1]
                end_idx = cu_seqlens[i]
                q_i = q[:, start_idx:end_idx]
                k_i = k[:, start_idx:end_idx]
                v_i = v[:, start_idx:end_idx]
                q_i, k_i, v_i = (rearrange(x, "b s h d -> b h s d")
                                 for x in [q_i, k_i, v_i])
                output_i = F.scaled_dot_product_attention(q_i,
                                                          k_i,
                                                          v_i,
                                                          dropout_p=0.0)
                output_i = rearrange(output_i, "b h s d -> b s h d ")
                outputs.append(output_i)
            context_layer = torch.cat(outputs, dim=1)
378
        elif self.attn_backend == _Backend.XFORMERS:
379
380
381
382
            from xformers import ops as xops
            from xformers.ops.fmha.attn_bias import BlockDiagonalMask

            attn_bias = BlockDiagonalMask.from_seqlens(q_seqlen=seqlens,
383
384
                                                       kv_seqlen=None,
                                                       device=q.device)
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401

            context_layer = xops.memory_efficient_attention_forward(
                q, k, v, attn_bias=attn_bias, p=0, scale=None)
        context_layer = rearrange(context_layer,
                                  "b s h d -> s b (h d)").contiguous()

        output, _ = self.proj(context_layer)
        return output


class Qwen2VisionBlock(nn.Module):

    def __init__(
        self,
        dim: int,
        num_heads: int,
        mlp_ratio: float,
402
        act_layer: type[nn.Module] = QuickGELU,
403
        norm_layer: Optional[Callable[[int], nn.Module]] = None,
404
        quant_config: Optional[QuantizationConfig] = None,
405
        prefix: str = "",
406
407
408
409
410
411
412
413
414
415
416
    ) -> None:
        super().__init__()
        if norm_layer is None:
            norm_layer = partial(nn.LayerNorm, eps=1e-6)
        self.norm1 = norm_layer(dim)
        self.norm2 = norm_layer(dim)
        mlp_hidden_dim = int(dim * mlp_ratio)

        self.attn = Qwen2VisionAttention(embed_dim=dim,
                                         num_heads=num_heads,
                                         projection_size=dim,
417
418
                                         quant_config=quant_config,
                                         prefix=f"{prefix}.attn")
419
420
421
        self.mlp = Qwen2VisionMLP(dim,
                                  mlp_hidden_dim,
                                  act_layer=act_layer,
422
423
                                  quant_config=quant_config,
                                  prefix=f"{prefix}.mlp")
424

425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
    def forward(
            self,
            x: torch.Tensor,
            cu_seqlens: torch.Tensor,
            rotary_pos_emb: torch.Tensor,
            max_seqlen: Optional[int] = None,  # Only used for Flash Attention
            seqlens: Optional[list[int]] = None,  # Only used for xFormers
    ) -> torch.Tensor:
        x = x + self.attn(
            self.norm1(x),
            cu_seqlens=cu_seqlens,
            rotary_pos_emb=rotary_pos_emb,
            max_seqlen=max_seqlen,
            seqlens=seqlens,
        )

441
442
443
444
445
446
447
448
449
450
        x = x + self.mlp(self.norm2(x))
        return x


class Qwen2VisionPatchEmbed(nn.Module):

    def __init__(
        self,
        patch_size: int = 14,
        temporal_patch_size: int = 2,
451
        in_channels: int = 3,
452
453
454
455
456
457
458
        embed_dim: int = 1152,
    ) -> None:
        super().__init__()
        self.patch_size = patch_size
        self.temporal_patch_size = temporal_patch_size
        self.embed_dim = embed_dim

459
460
        kernel_size = (temporal_patch_size, patch_size, patch_size)
        self.proj = nn.Conv3d(in_channels,
461
462
463
464
465
466
467
468
469
                              embed_dim,
                              kernel_size=kernel_size,
                              stride=kernel_size,
                              bias=False)

    def forward(self, x: torch.Tensor) -> torch.Tensor:
        L, C = x.shape
        x = x.view(L, -1, self.temporal_patch_size, self.patch_size,
                   self.patch_size)
470
471
        if os.environ.get('PYTORCH_MIOPEN_SUGGEST_NDHWC') == '1':
            x = x.to(memory_format=torch.channels_last_3d)
472
473
474
475
476
477
478
479
480
481
        x = self.proj(x).view(L, self.embed_dim)
        return x


class Qwen2VisionPatchMerger(nn.Module):

    def __init__(
        self,
        d_model: int,
        context_dim: int,
482
        norm_layer: Optional[Callable[[int], nn.Module]] = None,
483
484
        spatial_merge_size: int = 2,
        quant_config: Optional[QuantizationConfig] = None,
485
        prefix: str = "",
486
487
488
489
490
491
492
493
494
495
    ) -> None:
        super().__init__()
        self.hidden_size = context_dim * (spatial_merge_size**2)
        if norm_layer is None:
            norm_layer = partial(nn.LayerNorm, eps=1e-6)
        self.ln_q = norm_layer(context_dim)
        self.mlp = nn.ModuleList([
            ColumnParallelLinear(self.hidden_size,
                                 self.hidden_size,
                                 bias=True,
496
497
                                 quant_config=quant_config,
                                 prefix=f"{prefix}.mlp.0"),
498
499
500
501
            nn.GELU(),
            RowParallelLinear(self.hidden_size,
                              d_model,
                              bias=True,
502
503
                              quant_config=quant_config,
                              prefix=f"{prefix}.mlp.2"),
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
        ])

    def forward(self, x: torch.Tensor) -> torch.Tensor:
        x = self.ln_q(x)
        x = x.view(-1, self.hidden_size)

        mlp_fc1, mlp_act, mlp_fc2 = self.mlp
        x_parallel, _ = mlp_fc1(x)
        x_parallel = mlp_act(x_parallel)
        out, _ = mlp_fc2(x_parallel)
        return out


class Qwen2VisionRotaryEmbedding(nn.Module):

    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)
        self._seq_len_cached = 0
        self._freqs_cached = None

    def update_freqs_cache(self, seqlen: int) -> None:
        if seqlen > self._seq_len_cached:
            seqlen *= 2
            self._seq_len_cached = seqlen
            self.inv_freq = 1.0 / (self.theta**(torch.arange(
                0, self.dim, 2, dtype=torch.float, device=self.inv_freq.device)
                                                / self.dim))
            seq = torch.arange(seqlen,
                               device=self.inv_freq.device,
                               dtype=self.inv_freq.dtype)
            freqs = torch.outer(seq, self.inv_freq)
            self._freqs_cached = freqs

    def forward(self, seqlen: int) -> torch.Tensor:
        self.update_freqs_cache(seqlen)
        return self._freqs_cached[:seqlen]


class Qwen2VisionTransformer(nn.Module):

    def __init__(
        self,
        vision_config: Qwen2VLVisionConfig,
        norm_eps: float = 1e-6,
        quant_config: Optional[QuantizationConfig] = None,
554
        prefix: str = "",
555
556
557
    ) -> None:
        super().__init__()

558
559
560
561
562
563
564
565
566
        patch_size = vision_config.patch_size
        temporal_patch_size = vision_config.temporal_patch_size
        spatial_merge_size = vision_config.spatial_merge_size
        in_channels = vision_config.in_channels
        hidden_size = vision_config.hidden_size
        embed_dim = vision_config.embed_dim
        depth = vision_config.depth
        num_heads = vision_config.num_heads
        mlp_ratio = vision_config.mlp_ratio
567
568

        self.spatial_merge_size = spatial_merge_size
569
570
        self.num_heads = num_heads
        self.embed_dim = embed_dim
571
572
573
574

        self.patch_embed = Qwen2VisionPatchEmbed(
            patch_size=patch_size,
            temporal_patch_size=temporal_patch_size,
575
            in_channels=in_channels,
576
577
578
579
580
581
582
583
            embed_dim=embed_dim,
        )

        norm_layer = partial(nn.LayerNorm, eps=norm_eps)
        head_dim = embed_dim // num_heads
        self.rotary_pos_emb = Qwen2VisionRotaryEmbedding(head_dim // 2)

        self.blocks = nn.ModuleList([
584
585
586
587
588
589
590
            Qwen2VisionBlock(dim=embed_dim,
                             num_heads=num_heads,
                             mlp_ratio=mlp_ratio,
                             norm_layer=norm_layer,
                             quant_config=quant_config,
                             prefix=f"{prefix}.blocks.{layer_idx}")
            for layer_idx in range(depth)
591
592
593
594
595
596
        ])
        self.merger = Qwen2VisionPatchMerger(
            d_model=hidden_size,
            context_dim=embed_dim,
            norm_layer=norm_layer,
            quant_config=quant_config,
597
            prefix=f"{prefix}.merger",
598
        )
zhuwenwen's avatar
zhuwenwen committed
599

600
        self.attn_backend: _Backend = get_vit_attn_backend(support_fa=True)
zhuwenwen's avatar
zhuwenwen committed
601
602
603
604
605
606
607
608
609
610
        
        self.quant_method = None
        if quant_config is not None:
            self.quant_method=quant_config.get_name()
            self.quant_config=quant_config
            
        self.use_llama_nn = os.environ.get('LLAMA_NN') == '1'
        self.use_gemm_pad = os.environ.get('GEMM_PAD') == '1'
        self.use_fa_pad = os.environ.get('FA_PAD') == '1'
        self.use_awq_pad = os.environ.get('AWQ_PAD') == '1'
611
612
613

    @property
    def dtype(self) -> torch.dtype:
614
        return self.patch_embed.proj.weight.dtype
615
616
617

    @property
    def device(self) -> torch.device:
618
        return self.patch_embed.proj.weight.device
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644

    def rot_pos_emb(self, grid_thw: torch.Tensor) -> torch.Tensor:
        pos_ids = []
        for t, h, w in grid_thw:
            hpos_ids = torch.arange(h).unsqueeze(1).expand(-1, w)
            wpos_ids = torch.arange(w).unsqueeze(0).expand(h, -1)
            hpos_ids = hpos_ids.reshape(
                h // self.spatial_merge_size,
                self.spatial_merge_size,
                w // self.spatial_merge_size,
                self.spatial_merge_size,
            ).permute(0, 2, 1, 3).flatten()
            wpos_ids = wpos_ids.reshape(
                h // self.spatial_merge_size,
                self.spatial_merge_size,
                w // self.spatial_merge_size,
                self.spatial_merge_size,
            ).permute(0, 2, 1, 3).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

645
646
647
648
649
650
651
652
653
654
    def compute_attn_mask_seqlen(
            self, cu_seqlens: torch.Tensor
    ) -> tuple[Optional[int], Optional[list[int]]]:
        max_seqlen, seqlens = None, None
        if self.attn_backend == _Backend.FLASH_ATTN:
            max_seqlen = (cu_seqlens[1:] - cu_seqlens[:-1]).max().item()
        elif self.attn_backend == _Backend.XFORMERS:
            seqlens = (cu_seqlens[1:] - cu_seqlens[:-1]).tolist()
        return max_seqlen, seqlens

655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
    def forward(
        self,
        x: torch.Tensor,
        grid_thw: torch.Tensor,
    ) -> torch.Tensor:
        # patchify
        x = x.to(device=self.device, dtype=self.dtype)
        x = self.patch_embed(x)

        # compute position embedding
        rotary_pos_emb = self.rot_pos_emb(grid_thw)

        # compute cu_seqlens
        cu_seqlens = torch.repeat_interleave(grid_thw[:, 1] * grid_thw[:, 2],
                                             grid_thw[:, 0]).cumsum(
                                                 dim=0, dtype=torch.int32)
        cu_seqlens = F.pad(cu_seqlens, (1, 0), "constant", 0)

        # transformers
        x = x.unsqueeze(1)
675

676
677
        # pre-compute seqlens for attn mask to reduce cuMemcpy operations
        max_seqlen, seqlens = self.compute_attn_mask_seqlen(cu_seqlens)
678
        for blk in self.blocks:
679
680
681
682
683
684
685
            x = blk(
                x,
                cu_seqlens=cu_seqlens,
                rotary_pos_emb=rotary_pos_emb,
                max_seqlen=max_seqlen,
                seqlens=seqlens,
            )
686
687
688

        # adapter
        x = self.merger(x)
689

690
691
        return x

692
693
    def load_weights(self, weights: Iterable[tuple[str,
                                                   torch.Tensor]]) -> set[str]:
694
695
696
697
698
699
700
        stacked_params_mapping = [
            # (param_name, shard_name, shard_id)
            ("qkv_proj", "q_proj", "q"),
            ("qkv_proj", "k_proj", "k"),
            ("qkv_proj", "v_proj", "v"),
        ]
        params_dict = dict(self.named_parameters(remove_duplicate=False))
701
        loaded_params: set[str] = set()
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718

        for name, loaded_weight in weights:
            for (param_name, weight_name, shard_id) in stacked_params_mapping:
                if weight_name not in name:
                    continue
                name = name.replace(weight_name, param_name)

                param = params_dict[name]
                weight_loader = param.weight_loader
                weight_loader(param, loaded_weight, shard_id)
                break
            else:
                param = params_dict[name]
                weight_loader = getattr(param, "weight_loader",
                                        default_weight_loader)
                weight_loader(param, loaded_weight)
            loaded_params.add(name)
zhuwenwen's avatar
zhuwenwen committed
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
            
        if self.use_llama_nn and self.quant_method is None:
            lay_key_words = [
                "attn.qkv.weight",
                "attn.proj.weight",
                "mlp.fc1.weight",
                "mlp.fc2.weight",
                "mlp.0.weight",
                "mlp.2.weight",
                "self_attn.qkv_proj.weight",
                "self_attn.o_proj.weight",
                "mlp.gate_up_proj.weight",
                "mlp.down_proj.weight",
                "lm_head.weight",
            ]
            combined_words = "|".join(lay_key_words)
            
zhuwenwen's avatar
zhuwenwen committed
736
737
            # lay_qkv_words = ["attn.qkv.weight"]   
            # qkv_words = "|".join(lay_qkv_words)  
zhuwenwen's avatar
zhuwenwen committed
738
            
zhuwenwen's avatar
zhuwenwen committed
739
740
            # lay_qkv_bias_words = ["attn.qkv.bias"]   
            # qkv_bias_words = "|".join(lay_qkv_bias_words) 
zhuwenwen's avatar
zhuwenwen committed
741
            
zhuwenwen's avatar
zhuwenwen committed
742
743
            for layername in loaded_params:
                weight = params_dict[layername]
zhuwenwen's avatar
zhuwenwen committed
744
745
746
747
748
                # if self.use_fa_pad and (re.findall(qkv_bias_words, layername)):
                #     weight.data = pad_weight(weight.data, 32)
                    
                matches = re.findall(combined_words, layername)
                if matches:   
zhuwenwen's avatar
zhuwenwen committed
749
750
                    # if self.use_gemm_pad and gemm_bank_conf(weight.data.shape[0]):
                    #     weight.data = pad_weight(weight.data, 32)  
zhuwenwen's avatar
zhuwenwen committed
751
752
753
754
755
756
757
758
759
760
761
762
763
                    
                    # if self.use_fa_pad and (re.findall(qkv_words, layername)):
                    #     if not gemm_bank_conf(weight.data.shape[0]):
                    #         weight.data = pad_weight(weight.data, 32)
                        
                    _weight = torch.zeros_like(weight.data)
                    ori_shape =_weight.shape
                    
                    ops.trans_w16_gemm(_weight, weight.data, _weight.shape[0], _weight.shape[1])
                    weight.data.copy_(_weight)
                    
                    weight.data=weight.data.reshape(ori_shape[1],-1)
                    
764
765
        return loaded_params

766

zhuwenwen's avatar
zhuwenwen committed
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
def _qwen2vl_field_config(hf_inputs: Mapping[str, torch.Tensor]):
    image_grid_thw = hf_inputs.get("image_grid_thw", torch.empty((0, 3)))
    image_grid_sizes = image_grid_thw.prod(-1)

    video_grid_thw = hf_inputs.get("video_grid_thw", torch.empty((0, 3)))
    video_grid_sizes = video_grid_thw.prod(-1)

    return dict(
        pixel_values=MultiModalFieldConfig.flat_from_sizes(
            "image", image_grid_sizes),
        image_embeds=MultiModalFieldConfig.flat_from_sizes(
            "image", image_grid_sizes),
        image_grid_thw=MultiModalFieldConfig.batched("image"),
        pixel_values_videos=MultiModalFieldConfig.flat_from_sizes(
            "video", video_grid_sizes),
        video_embeds=MultiModalFieldConfig.flat_from_sizes(
            "video", video_grid_sizes),
        video_grid_thw=MultiModalFieldConfig.batched("video"),
    )
786
787


Roger Wang's avatar
Roger Wang committed
788
class Qwen2VLMultiModalDataParser(MultiModalDataParser):
789

790
791
792
    def _parse_image_data(
        self,
        data: Union[dict[str, torch.Tensor], ModalityData[ImageItem]],
793
    ) -> Optional[ModalityDataItems[Any, Any]]:
794
        if isinstance(data, dict):
zhuwenwen's avatar
zhuwenwen committed
795
796
797
798
799
800
            return DictEmbeddingItems(
                data,
                modality="image",
                required_fields={"image_embeds", "image_grid_thw"},
                fields_factory=_qwen2vl_field_config,
            )
801

802
        return super()._parse_image_data(data)
803

804
    def _parse_video_data(
805
        self,
806
        data: Union[dict[str, torch.Tensor], ModalityData[VideoItem]],
807
    ) -> Optional[ModalityDataItems[Any, Any]]:
808
        if isinstance(data, dict):
zhuwenwen's avatar
zhuwenwen committed
809
810
811
812
813
814
            return DictEmbeddingItems(
                data,
                modality="video",
                required_fields={"video_embeds", "video_grid_thw"},
                fields_factory=_qwen2vl_field_config,
            )
815
816
817

        return super()._parse_video_data(data)

818

819
class Qwen2VLProcessingInfo(BaseProcessingInfo):
820

821
    def get_hf_config(self):
822
823
        return self.ctx.get_hf_config(Qwen2VLConfig)

824
    def get_hf_processor(
825
826
827
828
        self,
        *,
        min_pixels: Optional[int] = None,
        max_pixels: Optional[int] = None,
zhuwenwen's avatar
zhuwenwen committed
829
830
        size: Optional[dict[str, int]] = None,
        **kwargs: object,
831
    ) -> Qwen2VLProcessor:
zhuwenwen's avatar
zhuwenwen committed
832
833
        return self.ctx.get_hf_processor(
            Qwen2VLProcessor,
Lu Fang's avatar
Lu Fang committed
834
835
836
837
838
            image_processor=self.get_image_processor(min_pixels=min_pixels,
                                                     max_pixels=max_pixels,
                                                     size=size,
                                                     use_fast=kwargs.get(
                                                         "use_fast", True)),
zhuwenwen's avatar
zhuwenwen committed
839
840
841
842
843
844
845
846
847
848
849
            **kwargs,
        )

    def _get_image_processor_kwargs(
        self,
        *,
        min_pixels: Optional[int] = None,
        max_pixels: Optional[int] = None,
        size: Optional[dict[str, int]] = None,
        **kwargs: object,
    ):
850
851
852
        mm_config = self.ctx.model_config.get_multimodal_config()
        if mm_config.mm_processor_kwargs:
            kwargs.update(mm_config.mm_processor_kwargs)
zhuwenwen's avatar
zhuwenwen committed
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873

        if min_pixels is not None:
            kwargs["min_pixels"] = min_pixels

            if size is None:
                size = {"shortest_edge": min_pixels}
            else:
                size["shortest_edge"] = min_pixels

        if max_pixels is not None:
            kwargs["max_pixels"] = max_pixels

            if size is None:
                size = {"longest_edge": max_pixels}
            else:
                size["longest_edge"] = max_pixels

        if size is not None:
            kwargs["size"] = size

        return kwargs
874

875
    def get_image_processor(
876
        self,
877
878
879
        *,
        min_pixels: Optional[int] = None,
        max_pixels: Optional[int] = None,
zhuwenwen's avatar
zhuwenwen committed
880
881
        size: Optional[dict[str, int]] = None,
        **kwargs: object,
882
    ) -> Qwen2VLImageProcessor:
883
        kwargs["use_fast"] = kwargs.get("use_fast", True)
zhuwenwen's avatar
zhuwenwen committed
884
885
886
887
888
889
890
        return cached_image_processor_from_config(
            self.ctx.model_config,
            **self._get_image_processor_kwargs(min_pixels=min_pixels,
                                               max_pixels=max_pixels,
                                               size=size,
                                               **kwargs),
        )
891

892
893
894
    def get_supported_mm_limits(self) -> Mapping[str, Optional[int]]:
        return {"image": None, "video": None}

895
896
897
898
899
900
901
902
    def get_max_tokens_per_item(
            self, seq_len: int,
            mm_counts: Mapping[str, int]) -> Optional[Mapping[str, int]]:

        max_image_tokens = self.get_max_image_tokens()
        max_video_tokens = self.get_max_video_tokens(seq_len, mm_counts)
        return {"image": max_image_tokens, "video": max_video_tokens}

903
904
905
906
907
908
909
    def _get_vision_info(
        self,
        *,
        image_width: int,
        image_height: int,
        num_frames: int = 1,
        do_resize: bool = True,
910
        image_processor: Optional[Qwen2VLImageProcessor],
911
    ) -> tuple[ImageSize, int]:
912
913
914
915
        if image_processor is None:
            image_processor = self.get_image_processor()

        hf_config = self.get_hf_config()
916
        vision_config = hf_config.vision_config
917
918
919
        patch_size = vision_config.patch_size
        merge_size = vision_config.spatial_merge_size
        temporal_patch_size = vision_config.temporal_patch_size
920

921
922
923
924
925
926
927
928
929
930
931
932
933
934
        if do_resize:
            resized_height, resized_width = smart_resize(
                height=image_height,
                width=image_width,
                factor=patch_size * merge_size,
                min_pixels=image_processor.min_pixels,
                max_pixels=image_processor.max_pixels,
            )
            preprocessed_size = ImageSize(width=resized_width,
                                          height=resized_height)
        else:
            preprocessed_size = ImageSize(width=image_width,
                                          height=image_height)

zhuwenwen's avatar
zhuwenwen committed
935
936
937
938
939
        # NOTE: Frames are padded to be divisible by `temporal_patch_size`
        # https://github.com/huggingface/transformers/blob/v4.48.3/src/transformers/models/qwen2_vl/image_processing_qwen2_vl.py#L294
        padded_num_frames = num_frames + num_frames % temporal_patch_size

        grid_t = max(padded_num_frames // temporal_patch_size, 1)
940
941
942
943
944
945
946
947
        grid_h = preprocessed_size.height // patch_size
        grid_w = preprocessed_size.width // patch_size

        num_patches = grid_t * grid_h * grid_w
        num_vision_tokens = num_patches // (merge_size**2)

        return preprocessed_size, num_vision_tokens

948
    def get_num_image_tokens(
949
950
951
952
        self,
        *,
        image_width: int,
        image_height: int,
953
        image_processor: Optional[Qwen2VLImageProcessor],
954
955
956
957
    ) -> int:
        _, num_image_tokens = self._get_vision_info(
            image_width=image_width,
            image_height=image_height,
958
            image_processor=image_processor,
959
960
961
        )
        return num_image_tokens

962
    def get_num_video_tokens(
963
964
965
966
967
        self,
        *,
        image_width: int,
        image_height: int,
        num_frames: int,
968
        image_processor: Optional[Qwen2VLImageProcessor],
969
970
971
972
973
    ) -> int:
        _, num_video_tokens = self._get_vision_info(
            image_width=image_width,
            image_height=image_height,
            num_frames=num_frames,
974
            image_processor=image_processor,
975
976
977
        )
        return num_video_tokens

978
    def get_image_size_with_most_features(self) -> ImageSize:
979
980
981
        max_image_size, _ = self._get_vision_info(
            image_width=9999999,
            image_height=9999999,
982
            image_processor=None,
983
984
985
        )
        return max_image_size

986
987
    def get_max_image_tokens(self) -> int:
        target_width, target_height = self.get_image_size_with_most_features()
988

989
        return self.get_num_image_tokens(
990
991
            image_width=target_width,
            image_height=target_height,
992
            image_processor=None,
993
        )
994
995

    def _get_max_video_frames(self, max_tokens: int) -> int:
996
        target_width, target_height = self.get_image_size_with_most_features()
997

998
999
1000
1001
        num_frames = 0

        while True:
            next_num_frames = num_frames + 1
1002
            next_max_tokens = self.get_num_video_tokens(
1003
1004
1005
                image_width=target_width,
                image_height=target_height,
                num_frames=next_num_frames,
1006
                image_processor=None,
1007
            )
1008

1009
            if next_max_tokens > max_tokens:
1010
1011
1012
1013
1014
1015
                break

            num_frames = next_num_frames

        return num_frames

1016
1017
1018
1019
1020
1021
1022
    def get_num_frames_with_most_features(
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
    ) -> int:
        max_images = mm_counts.get("image", 0)
        max_videos = mm_counts.get("video", 0)
1023

1024
        max_image_tokens = self.get_max_image_tokens() * max_images
1025
1026
        max_total_frames = self._get_max_video_frames(seq_len -
                                                      max_image_tokens)
zhuwenwen's avatar
zhuwenwen committed
1027
1028
        max_frames_per_video = min(max_total_frames // max(max_videos, 1),
                                   _MAX_FRAMES_PER_VIDEO)
1029

zhuwenwen's avatar
zhuwenwen committed
1030
        return max(max_frames_per_video, 1)
1031

1032
1033
1034
1035
1036
    def get_max_video_tokens(
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
    ) -> int:
1037
        target_width, target_height = self.get_image_size_with_most_features()
1038

1039
        return self.get_num_video_tokens(
1040
1041
            image_width=target_width,
            image_height=target_height,
1042
1043
            num_frames=self.get_num_frames_with_most_features(
                seq_len, mm_counts),
1044
            image_processor=None,
1045
1046
        )

1047
1048
1049

class Qwen2VLDummyInputsBuilder(BaseDummyInputsBuilder[Qwen2VLProcessingInfo]):

1050
    def get_dummy_text(self, mm_counts: Mapping[str, int]) -> str:
1051
1052
1053
        num_images = mm_counts.get("image", 0)
        num_videos = mm_counts.get("video", 0)

1054
        hf_processor = self.info.get_hf_processor()
1055
1056
        image_token: str = hf_processor.image_token
        video_token: str = hf_processor.video_token
1057

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
        return image_token * num_images + video_token * num_videos

    def get_dummy_mm_data(
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
    ) -> MultiModalDataDict:
        num_images = mm_counts.get("image", 0)
        num_videos = mm_counts.get("video", 0)

1068
1069
1070
        target_width, target_height = \
            self.info.get_image_size_with_most_features()
        target_num_frames = \
1071
            self.info.get_num_frames_with_most_features(seq_len, mm_counts)
1072

1073
        return {
1074
1075
1076
1077
1078
1079
1080
1081
            "image":
            self._get_dummy_images(width=target_width,
                                   height=target_height,
                                   num_images=num_images),
            "video":
            self._get_dummy_videos(
                width=target_width,
                height=target_height,
1082
                num_frames=target_num_frames,
1083
1084
                num_videos=num_videos,
            )
1085
1086
        }

1087

1088
1089
class Qwen2VLMultiModalProcessor(BaseMultiModalProcessor[Qwen2VLProcessingInfo]
                                 ):
1090

1091
    def _get_data_parser(self) -> MultiModalDataParser:
Roger Wang's avatar
Roger Wang committed
1092
        return Qwen2VLMultiModalDataParser()
1093

zhuwenwen's avatar
zhuwenwen committed
1094
1095
1096
1097
1098
    def _call_hf_processor(
        self,
        prompt: str,
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
1099
        tok_kwargs: Mapping[str, object],
zhuwenwen's avatar
zhuwenwen committed
1100
    ) -> BatchFeature:
1101
        mm_kwargs = self.info._get_image_processor_kwargs(**mm_kwargs)
zhuwenwen's avatar
zhuwenwen committed
1102
1103
1104
        return self.info.ctx.call_hf_processor(
            self.info.get_hf_processor(**mm_kwargs),
            dict(text=prompt, **mm_data),
1105
            dict(**mm_kwargs, **tok_kwargs),
zhuwenwen's avatar
zhuwenwen committed
1106
1107
        )

1108
    def _get_prompt_updates(
1109
1110
        self,
        mm_items: MultiModalDataItems,
1111
        hf_processor_mm_kwargs: Mapping[str, Any],
1112
        out_mm_kwargs: MultiModalKwargs,
1113
    ) -> Sequence[PromptUpdate]:
1114
1115
1116
        hf_processor = self.info.get_hf_processor(**hf_processor_mm_kwargs)
        image_processor = self.info.get_image_processor(
            **hf_processor_mm_kwargs)
1117
1118
        tokenizer = self.info.get_tokenizer()
        vocab = tokenizer.get_vocab()
1119
1120

        placeholder = {
1121
1122
            "image": vocab[hf_processor.image_token],
            "video": vocab[hf_processor.video_token],
1123
        }
1124

1125
1126
1127
        merge_length = image_processor.merge_size**2

        def get_replacement_qwen2vl(item_idx: int, modality: str):
1128
1129
1130
            grid_thw = out_mm_kwargs[f"{modality}_grid_thw"][item_idx]
            assert isinstance(grid_thw, torch.Tensor)

1131
1132
            num_tokens = int(grid_thw.prod()) // merge_length
            return [placeholder[modality]] * num_tokens
1133
1134
1135
1136

        return [
            PromptReplacement(
                modality=modality,
1137
                target=[placeholder[modality]],
1138
1139
1140
1141
                replacement=partial(get_replacement_qwen2vl,
                                    modality=modality),
            ) for modality in ("image", "video")
        ]
1142

1143
    def _get_mm_fields_config(
1144
        self,
1145
1146
1147
        hf_inputs: BatchFeature,
        hf_processor_mm_kwargs: Mapping[str, object],
    ) -> Mapping[str, MultiModalFieldConfig]:
zhuwenwen's avatar
zhuwenwen committed
1148
        return _qwen2vl_field_config(hf_inputs)
1149
1150


1151
1152
1153
@MULTIMODAL_REGISTRY.register_processor(Qwen2VLMultiModalProcessor,
                                        info=Qwen2VLProcessingInfo,
                                        dummy_inputs=Qwen2VLDummyInputsBuilder)
1154
class Qwen2VLForConditionalGeneration(nn.Module, SupportsMultiModal,
1155
                                      SupportsLoRA, SupportsPP):
1156

1157
    # To ensure correct weight loading and mapping.
1158
1159
1160
1161
1162
1163
1164
1165
1166
    hf_to_vllm_mapper = WeightsMapper(
        orig_to_new_prefix={
            # mapping for new names in checkpoint saved after transformers v4.52
            "model.language_model.": "language_model.model.",
            "model.visual.": "visual.",
            # mapping for original checkpoint
            "lm_head.": "language_model.lm_head.",
            "model.": "language_model.model.",
        })
1167

1168
1169
1170
1171
1172
1173
1174
1175
1176
    @classmethod
    def get_placeholder_str(cls, modality: str, i: int) -> Optional[str]:
        if modality.startswith("image"):
            return "<|vision_start|><|image_pad|><|vision_end|>"
        if modality.startswith("video"):
            return "<|vision_start|><|video_pad|><|vision_end|>"

        raise ValueError("Only image or video modality is supported")

1177
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
1178
        super().__init__()
1179
        config: Qwen2VLConfig = vllm_config.model_config.hf_config
1180
1181
        quant_config = vllm_config.quant_config
        multimodal_config = vllm_config.model_config.multimodal_config
1182
1183
1184
1185
1186
1187
1188

        self.config = config
        self.multimodal_config = multimodal_config

        self.visual = Qwen2VisionTransformer(
            config.vision_config,
            norm_eps=getattr(config, "rms_norm_eps", 1e-6),
1189
            quant_config=self._maybe_ignore_quant_config(quant_config),
1190
            prefix=maybe_prefix(prefix, "visual"),
1191
1192
        )

1193
1194
1195
1196
1197
        self.language_model = init_vllm_registered_model(
            vllm_config=vllm_config,
            prefix=maybe_prefix(prefix, "language_model"),
            architectures=["Qwen2ForCausalLM"],
        )
1198

1199
        self.make_empty_intermediate_tensors = (
1200
            self.language_model.make_empty_intermediate_tensors)
1201
1202


1203
1204
1205
1206
1207
1208
1209
    def _maybe_ignore_quant_config(self, quant_config: QuantizationConfig):
        # GPTQ configs do not have a list of ignored modules, however AutoGPTQ
        # seems to avoid vision encoder sections for some models.
        # See: https://huggingface.co/Qwen/Qwen2-VL-2B-Instruct-GPTQ-Int4
        if isinstance(quant_config, (GPTQConfig, GPTQMarlinConfig)):
            return None
        return quant_config
zhuwenwen's avatar
zhuwenwen committed
1210
    
1211

1212
    def _validate_and_reshape_mm_tensor(self, mm_input: object,
1213
1214
1215
1216
1217
1218
1219
1220
1221
                                        name: str) -> torch.Tensor:
        if not isinstance(mm_input, (torch.Tensor, list)):
            raise ValueError(f"Incorrect type of {name}. "
                             f"Got type: {type(mm_input)}")
        if isinstance(mm_input, torch.Tensor):
            if mm_input.ndim == 2:
                return mm_input
            if mm_input.ndim != 3:
                raise ValueError(f"{name} should be 2D or batched 3D tensor. "
1222
1223
                                 f"Got ndim: {mm_input.ndim} "
                                 f"(shape={mm_input.shape})")
1224
1225
1226
1227
1228
1229
1230
            return torch.concat(list(mm_input))
        else:
            return torch.concat(mm_input)

    def _parse_and_validate_image_input(
            self, **kwargs: object) -> Optional[Qwen2VLImageInputs]:
        pixel_values = kwargs.pop("pixel_values", None)
1231
        image_embeds = kwargs.pop("image_embeds", None)
1232
1233
        image_grid_thw = kwargs.pop("image_grid_thw", None)

1234
        if pixel_values is None and image_embeds is None:
1235
1236
            return None

1237
1238
1239
1240
1241
        if pixel_values is not None:
            pixel_values = self._validate_and_reshape_mm_tensor(
                pixel_values, "image pixel values")
            image_grid_thw = self._validate_and_reshape_mm_tensor(
                image_grid_thw, "image grid_thw")
1242

1243
1244
1245
            if not isinstance(pixel_values, (torch.Tensor, list)):
                raise ValueError("Incorrect type of image pixel values. "
                                 f"Got type: {type(pixel_values)}")
1246

1247
            return Qwen2VLImagePixelInputs(type="pixel_values",
1248
                                           pixel_values=pixel_values,
1249
1250
1251
                                           image_grid_thw=image_grid_thw)

        if image_embeds is not None:
1252
1253
            image_embeds = self._validate_and_reshape_mm_tensor(
                image_embeds, "image embeds")
1254
1255
            image_grid_thw = self._validate_and_reshape_mm_tensor(
                image_grid_thw, "image grid_thw")
1256

1257
1258
1259
1260
            if not isinstance(image_embeds, torch.Tensor):
                raise ValueError("Incorrect type of image embeddings. "
                                 f"Got type: {type(image_embeds)}")
            return Qwen2VLImageEmbeddingInputs(type="image_embeds",
1261
1262
                                               image_embeds=image_embeds,
                                               image_grid_thw=image_grid_thw)
1263
1264
1265
1266

    def _parse_and_validate_video_input(
            self, **kwargs: object) -> Optional[Qwen2VLVideoInputs]:
        pixel_values_videos = kwargs.pop("pixel_values_videos", None)
1267
        video_embeds = kwargs.pop("video_embeds", None)
1268
1269
        video_grid_thw = kwargs.pop("video_grid_thw", None)

1270
        if pixel_values_videos is None and video_embeds is None:
1271
1272
            return None

1273
1274
1275
1276
1277
        if pixel_values_videos is not None:
            pixel_values_videos = self._validate_and_reshape_mm_tensor(
                pixel_values_videos, "video pixel values")
            video_grid_thw = self._validate_and_reshape_mm_tensor(
                video_grid_thw, "video grid_thw")
1278

1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
            return Qwen2VLVideoPixelInputs(
                type="pixel_values_videos",
                pixel_values_videos=pixel_values_videos,
                video_grid_thw=video_grid_thw,
            )

        if video_embeds is not None:
            video_embeds = self._validate_and_reshape_mm_tensor(
                video_embeds, "video embeds")
            video_grid_thw = self._validate_and_reshape_mm_tensor(
                video_grid_thw, "video grid_thw")

            if not isinstance(video_embeds, torch.Tensor):
                raise ValueError("Incorrect type of video embeddings. "
                                 f"Got type: {type(video_embeds)}")
            return Qwen2VLVideoEmbeddingInputs(type="video_embeds",
                                               video_embeds=video_embeds,
                                               video_grid_thw=video_grid_thw)
1297

1298
1299
1300
1301
1302
1303
    def _process_image_input(
            self, image_input: Qwen2VLImageInputs) -> tuple[torch.Tensor, ...]:

        grid_thw = image_input["image_grid_thw"]
        assert grid_thw.ndim == 2

1304
        if image_input["type"] == "image_embeds":
1305
            image_embeds = image_input["image_embeds"]
1306
        else:
1307
            pixel_values = image_input["pixel_values"]
1308
1309
1310
1311
1312
            image_embeds = self.visual(pixel_values, grid_thw=grid_thw)

        # Split concatenated embeddings for each image item.
        merge_size = self.visual.spatial_merge_size
        sizes = grid_thw.prod(-1) // merge_size // merge_size
1313

1314
1315
1316
1317
        return image_embeds.split(sizes.tolist())

    def _process_video_input(
            self, video_input: Qwen2VLVideoInputs) -> tuple[torch.Tensor, ...]:
1318

1319
1320
        grid_thw = video_input["video_grid_thw"]
        assert grid_thw.ndim == 2
1321

1322
        if video_input["type"] == "video_embeds":
1323
            video_embeds = video_input["video_embeds"]
1324
        else:
1325
            pixel_values_videos = video_input["pixel_values_videos"]
1326
            video_embeds = self.visual(pixel_values_videos, grid_thw=grid_thw)
1327

1328
1329
1330
        # Split concatenated embeddings for each video item.
        merge_size = self.visual.spatial_merge_size
        sizes = grid_thw.prod(-1) // merge_size // merge_size
1331

1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
        return video_embeds.split(sizes.tolist())

    def _parse_and_validate_multimodal_inputs(self, **kwargs: object) -> dict:
        modalities = {}

        # Preserve the order of modalities if there are multiple of them
        # from the order of kwargs.
        for input_key in kwargs:
            if input_key in ("pixel_values",
                             "image_embeds") and "images" not in modalities:
                modalities["images"] = self._parse_and_validate_image_input(
                    **kwargs)
            if input_key in ("pixel_values_videos",
                             "video_embeds") and "videos" not in modalities:
                modalities["videos"] = self._parse_and_validate_video_input(
                    **kwargs)

        return modalities
1350

1351
1352
1353
    def get_language_model(self) -> torch.nn.Module:
        return self.language_model

1354
1355
    def get_multimodal_embeddings(self,
                                  **kwargs: object) -> MultiModalEmbeddings:
1356

1357
1358
        modalities = self._parse_and_validate_multimodal_inputs(**kwargs)
        if not modalities:
1359
            return []
1360
1361
            return None

1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
        # The result multimodal_embeddings is tuple of tensors, with each
        # tensor correspoending to a multimodal data item (image or video).
        multimodal_embeddings: tuple[torch.Tensor, ...] = ()

        # NOTE: It is important to iterate over the keys in this dictionary
        # to preserve the order of the modalities.
        for modality in modalities:
            if modality == "images":
                image_input = modalities["images"]
                vision_embeddings = self._process_image_input(image_input)
                multimodal_embeddings += vision_embeddings
            if modality == "videos":
                video_input = modalities["videos"]
                video_embeddings = self._process_video_input(video_input)
                multimodal_embeddings += video_embeddings
1377
1378
1379
1380
1381
1382

        return multimodal_embeddings

    def get_input_embeddings(
        self,
        input_ids: torch.Tensor,
1383
        multimodal_embeddings: Optional[MultiModalEmbeddings] = None,
1384
    ) -> torch.Tensor:
1385
        inputs_embeds = self.language_model.get_input_embeddings(input_ids)
1386
1387
        if multimodal_embeddings is not None \
            and len(multimodal_embeddings) != 0:
1388
1389
1390
            inputs_embeds = merge_multimodal_embeddings(
                input_ids, inputs_embeds, multimodal_embeddings,
                [self.config.image_token_id, self.config.video_token_id])
1391
1392
        return inputs_embeds

1393
1394
1395
    def get_input_embeddings_v0(
        self,
        input_ids: torch.Tensor,
1396
1397
        image_input: Optional[Qwen2VLImagePixelInputs] = None,
        video_input: Optional[Qwen2VLVideoPixelInputs] = None,
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
    ) -> torch.Tensor:
        inputs_embeds = self.get_input_embeddings(input_ids)
        if image_input is not None:
            image_embeds = self._process_image_input(image_input)
            inputs_embeds = merge_multimodal_embeddings(
                input_ids,
                inputs_embeds,
                image_embeds,
                placeholder_token_id=self.config.image_token_id,
            )

        if video_input is not None:
            video_embeds = self._process_video_input(video_input)
            inputs_embeds = merge_multimodal_embeddings(
                input_ids,
                inputs_embeds,
                video_embeds,
                placeholder_token_id=self.config.video_token_id,
            )
1417
1418
        return inputs_embeds

1419
1420
1421
1422
1423
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
        intermediate_tensors: Optional[IntermediateTensors] = None,
1424
        inputs_embeds: Optional[torch.Tensor] = None,
1425
        **kwargs: object,
1426
    ) -> Union[torch.Tensor, IntermediateTensors]:
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
        """Run forward pass for Qwen2-VL.

        Args:
            input_ids: Flattened (concatenated) input_ids corresponding to a
                batch.
            positions: Flattened (concatenated) position ids corresponding to a
                batch.
                **NOTE**: If mrope is enabled (default setting for Qwen2-VL
                opensource models), the shape will be `(3, seq_len)`,
                otherwise it will be `(seq_len,).
            pixel_values: Pixel values to be fed to a model.
                `None` if no images are passed.
            image_grid_thw: Tensor `(n_images, 3)` of image 3D grid in LLM.
                `None` if no images are passed.
            pixel_values_videos: Pixel values of videos to be fed to a model.
                `None` if no videos are passed.
            video_grid_thw: Tensor `(n_videos, 3)` of video 3D grid in LLM.
                `None` if no videos are passed.
        """

1447
        if intermediate_tensors is not None:
1448
            inputs_embeds = None
1449

1450
1451
1452
        # NOTE: In v1, inputs_embeds is always generated at model runner from
        # `get_multimodal_embeddings` and `get_input_embeddings`, this
        # condition is only for v0 compatibility.
1453
        elif inputs_embeds is None:
1454
1455
            image_input = self._parse_and_validate_image_input(**kwargs)
            video_input = self._parse_and_validate_video_input(**kwargs)
1456

1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
            if image_input is None and video_input is None:
                inputs_embeds = None
            else:
                if uses_mrope(self.config):
                    assert positions.ndim == 2 and positions.size(0) == 3, (
                        "multimodal section rotary embedding requires "
                        f"(3, seq_len) positions, but got {positions.size()}")
                inputs_embeds = self.get_input_embeddings_v0(
                    input_ids,
                    image_input=image_input,
                    video_input=video_input)
                input_ids = None
1469

1470
        hidden_states = self.language_model.model(
1471
1472
            input_ids=input_ids,
            positions=positions,
1473
            intermediate_tensors=intermediate_tensors,
1474
1475
1476
1477
            inputs_embeds=inputs_embeds,
        )
        return hidden_states

1478
1479
1480
1481
1482
1483
1484
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[torch.Tensor]:
        return self.language_model.compute_logits(hidden_states,
                                                  sampling_metadata)
1485

1486
1487
    def load_weights(self, weights: Iterable[tuple[str,
                                                   torch.Tensor]]) -> set[str]:
1488
1489

        loader = AutoWeightsLoader(self)
1490
        return loader.load_weights(weights, mapper=self.hf_to_vllm_mapper)
1491
1492
1493
1494
1495
1496
1497

    def get_mm_mapping(self) -> MultiModelKeys:
        """
        Get the module prefix in multimodal models
        """
        return MultiModelKeys.from_string_field(
            language_model="language_model",
1498
1499
1500
            connector="visual.merger.",
            tower_model="visual.",
        )
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584


class Tarsier2MultiModalProcessor(Qwen2VLMultiModalProcessor):
    pass


class Tarsier2ImageProcessor(Qwen2VLImageProcessor):

    def __init__(
        self,
        size: Optional[dict[str, int]] = None,
        **kwargs,
    ) -> None:
        if size is not None and "min_pixels" in size and "max_pixels" in size:
            # Remap if Tarsier2-specific format is provided
            remapped_size = {
                "shortest_edge": size["min_pixels"],
                "longest_edge": size["max_pixels"]
            }
            super().__init__(size=remapped_size, **kwargs)
        else:
            super().__init__(size=size, **kwargs)


class Tarsier2Processor(Qwen2VLProcessor):

    def __init__(
        self,
        vision_config: dict,
        tokenizer: AnyTokenizer,
        **kwargs,
    ):
        self.image_processor = Tarsier2ImageProcessor(**vision_config)
        super().__init__(image_processor=self.image_processor,
                         tokenizer=tokenizer,
                         video_processor=Qwen2VLVideoProcessor(),
                         chat_template=None,
                         **kwargs)


class Tarsier2ProcessingInfo(Qwen2VLProcessingInfo):

    def get_hf_config(self) -> Qwen2VLConfig:
        model_path = self.ctx.model_config.model
        original_config = AutoConfig.from_pretrained(model_path)
        config_dict = original_config.to_dict()
        correct_config = Qwen2VLConfig.from_dict(config_dict)

        return correct_config

    def get_hf_processor(self, **kwargs: object) -> Tarsier2Processor:
        return Tarsier2Processor(
            vision_config=self.ctx.get_hf_image_processor_config(),
            tokenizer=self.get_tokenizer(),
            **kwargs,
        )

    def get_image_processor(self) -> Tarsier2ImageProcessor:
        return Tarsier2ImageProcessor(
            **self.ctx.get_hf_image_processor_config())


@MULTIMODAL_REGISTRY.register_processor(Tarsier2MultiModalProcessor,
                                        info=Tarsier2ProcessingInfo,
                                        dummy_inputs=Qwen2VLDummyInputsBuilder)
class Tarsier2ForConditionalGeneration(Qwen2VLForConditionalGeneration):
    hf_to_vllm_mapper = WeightsMapper(orig_to_new_prefix={
        "vision_tower.": "visual.",
    })

    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        # Tarsier2 uses llava as model_type, which will create a Qwen2VLConfig
        # as text_config, we need to reconstruct Qwen2VLConfig from LlavaConfig.
        config = vllm_config.model_config.hf_config
        qwen2vl_config = config.text_config
        qwen2vl_config.architectures = config.architectures
        vllm_config.model_config.hf_config = qwen2vl_config
        super().__init__(vllm_config=vllm_config, prefix=prefix)

    def load_weights(self, weights: Iterable[tuple[str,
                                                   torch.Tensor]]) -> set[str]:

        loader = AutoWeightsLoader(self)
        return loader.load_weights(weights, mapper=self.hf_to_vllm_mapper)