minicpmv.py 60.5 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
# Adapted from
# https://github.com/huggingface/transformers/blob/v4.28.0/src/transformers/models/llama/modeling_llama.py
# 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.
Alphi's avatar
Alphi committed
25
"""Inference-only MiniCPM-V model compatible with HuggingFace weights."""
26

27
import math
28
from collections import defaultdict
29
from collections.abc import Callable, Iterable, Mapping, Sequence
30
from functools import partial
tc-mb's avatar
tc-mb committed
31
from itertools import chain
32
from typing import Annotated, Any, Literal, TypeAlias
33

34
import numpy as np
35
import torch
Alphi's avatar
Alphi committed
36
import torch.types
37
from torch import nn
tc-mb's avatar
tc-mb committed
38
from torch.nn.init import trunc_normal_
39
from transformers import BatchFeature, PretrainedConfig
40
from typing_extensions import TypeVar
41

42
from vllm.config import VllmConfig
43
from vllm.config.multimodal import BaseDummyOptions
44
from vllm.model_executor.layers.quantization import QuantizationConfig
tc-mb's avatar
tc-mb committed
45
46
from vllm.model_executor.layers.quantization.awq import AWQConfig
from vllm.model_executor.layers.quantization.awq_marlin import AWQMarlinConfig
47
48
49
50
51
from vllm.model_executor.layers.resampler import (
    BaseResampler,
    Resampler2,
    get_2d_sincos_pos_embed,
)
Jee Jee Li's avatar
Jee Jee Li committed
52
from vllm.model_executor.model_loader.utils import set_default_torch_dtype
53
54
from vllm.model_executor.models.llama import LlamaForCausalLM
from vllm.model_executor.models.minicpm import MiniCPMForCausalLM
55
from vllm.model_executor.models.module_mapping import MultiModelKeys
56
from vllm.model_executor.models.qwen2 import Qwen2ForCausalLM
tc-mb's avatar
tc-mb committed
57
58
from vllm.model_executor.models.qwen3 import Qwen3ForCausalLM
from vllm.multimodal import MULTIMODAL_REGISTRY
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
from vllm.multimodal.inputs import (
    MultiModalDataDict,
    MultiModalFieldConfig,
    MultiModalKwargsItems,
    NestedTensors,
)
from vllm.multimodal.parse import (
    DictEmbeddingItems,
    ImageItem,
    ImageProcessorItems,
    ImageSize,
    ModalityData,
    ModalityDataItems,
    MultiModalDataItems,
    MultiModalDataParser,
    VideoItem,
    VideoProcessorItems,
)
from vllm.multimodal.processing import (
    BaseMultiModalProcessor,
    BaseProcessingInfo,
    PromptReplacement,
    PromptUpdate,
    PromptUpdateDetails,
    ResolvedPromptUpdate,
    _seq2text,
)
86
from vllm.multimodal.profiling import BaseDummyInputsBuilder
87
from vllm.platforms import current_platform
88
from vllm.sequence import IntermediateTensors
89
from vllm.utils import flatten_2d_lists
90
from vllm.utils.tensor_schema import TensorSchema, TensorShape
91

Jee Jee Li's avatar
Jee Jee Li committed
92
from .idefics2_vision_model import Idefics2VisionTransformer
93
94
95
96
97
98
from .interfaces import (
    MultiModalEmbeddings,
    SupportsLoRA,
    SupportsMultiModal,
    SupportsPP,
)
99
from .utils import AutoWeightsLoader, flatten_bn, maybe_prefix
100

101
102
103
# For profile run
_MAX_FRAMES_PER_VIDEO = 16

104

105
class MiniCPMVImagePixelInputs(TensorSchema):
Jee Jee Li's avatar
Jee Jee Li committed
106
    """
107
108
109
110
111
112
    Dimensions:
        - bns: Batch size * number of images * number of slices
        - bn: Batch size * number of images
        - c: Number of channels
        - h: Height
        - w: Width
Jee Jee Li's avatar
Jee Jee Li committed
113
114
    """

115
116
117
118
119
120
    type: Literal["pixel_values"] = "pixel_values"

    # Note that the image size may vary, so we pass it as a list instead of a
    # batched tensor.
    pixel_values: Annotated[
        list[torch.Tensor],
121
        TensorShape("bns", "c", "h", "w", dynamic_dims={"h", "w"}),
122
123
124
125
126
127
128
129
130
131
132
133
    ]
    tgt_sizes: Annotated[
        torch.Tensor,
        TensorShape("bns", 2),  # This should be in `(height, width)` format.
    ]
    num_slices: Annotated[
        torch.Tensor,
        TensorShape("bn"),
    ]


class MiniCPMVImageEmbeddingInputs(TensorSchema):
Jee Jee Li's avatar
Jee Jee Li committed
134
    """
135
136
137
138
    Dimensions:
        - bn: Batch size * number of images
        - ns: Number of slices
        - hs: Hidden size (must match language model backbone)
Jee Jee Li's avatar
Jee Jee Li committed
139
140
    """

141
    type: Literal["image_embeds"]
142
    image_embeds: Annotated[
143
        torch.Tensor | list[torch.Tensor],
144
145
        TensorShape("bn", "ns", "hs"),
    ]
146
147


148
MiniCPMVImageInputs: TypeAlias = MiniCPMVImagePixelInputs | MiniCPMVImageEmbeddingInputs
149

Jee Jee Li's avatar
Jee Jee Li committed
150
151
152
153
DEFAULT_LN = partial(nn.LayerNorm, eps=1e-6)


class Resampler2_5(BaseResampler):
154
155
156
157
158
    def __init__(
        self,
        num_queries: int,
        embed_dim: int,
        num_heads: int,
159
        kv_dim: int | None = None,
160
161
        norm_layer: Callable[[int], nn.LayerNorm] = DEFAULT_LN,
        max_size: tuple[int, int] = (70, 70),
162
        quant_config: QuantizationConfig | None = None,
163
164
165
166
167
168
169
170
171
172
173
        prefix: str = "",
    ) -> None:
        super().__init__(
            num_queries,
            embed_dim,
            num_heads,
            kv_dim,
            norm_layer,
            quant_config=quant_config,
            prefix=prefix,
        )
Jee Jee Li's avatar
Jee Jee Li committed
174
175
176

        self.max_size = max_size
        self._set_2d_pos_cache(self.max_size)
177

178
179
180
181
182
183
    def _set_2d_pos_cache(
        self, max_size: tuple[int, int], device: torch.types.Device = "cpu"
    ) -> None:
        pos_embed_arr = get_2d_sincos_pos_embed(
            self.embed_dim, max_size, version=(2, 5)
        )
Jee Jee Li's avatar
Jee Jee Li committed
184
        pos_embed = torch.from_numpy(pos_embed_arr).float().to(device)
185
186
        self.register_buffer("pos_embed", pos_embed, persistent=False)

187
188
189
    def _adjust_pos_cache(
        self, tgt_sizes: torch.Tensor, device: torch.types.Device
    ) -> None:
Jee Jee Li's avatar
Jee Jee Li committed
190
191
192
193
        max_h = tgt_sizes[:, 0].max().item()
        max_w = tgt_sizes[:, 1].max().item()
        assert isinstance(max_h, int) and isinstance(max_w, int)

194
        if max_h > self.max_size[0] or max_w > self.max_size[1]:
Jee Jee Li's avatar
Jee Jee Li committed
195
            self.max_size = (
196
                max(max_h, self.max_size[0]),
Jee Jee Li's avatar
Jee Jee Li committed
197
198
                max(max_w, self.max_size[1]),
            )
199
200
            self._set_2d_pos_cache(self.max_size, device)

201
    def forward(self, x: torch.Tensor, tgt_sizes: torch.Tensor) -> torch.Tensor:
202
203
204
205
206
207
208
209
210
211
        assert x.shape[0] == tgt_sizes.shape[0]
        bs = x.shape[0]

        device = x.device
        dtype = x.dtype

        patch_len = tgt_sizes[:, 0] * tgt_sizes[:, 1]

        self._adjust_pos_cache(tgt_sizes, device=device)

Jee Jee Li's avatar
Jee Jee Li committed
212
213
214
        max_patch_len = patch_len.max().item()
        assert isinstance(max_patch_len, int)

215
216
217
        key_padding_mask = torch.zeros(
            (bs, max_patch_len), dtype=torch.bool, device=device
        )
218
219
220

        pos_embed = []
        for i in range(bs):
Jee Jee Li's avatar
Jee Jee Li committed
221
            tgt_h, tgt_w = tgt_sizes[i].tolist()
222
223
224
225
226
227
228
            pos_embed.append(
                self.pos_embed[:tgt_h, :tgt_w, :].reshape((tgt_h * tgt_w, -1)).to(dtype)
            )  # patches * D
            key_padding_mask[i, patch_len[i] :] = True
        pos_embed = torch.nn.utils.rnn.pad_sequence(
            pos_embed, batch_first=True, padding_value=0.0
        ).permute(1, 0, 2)  # BLD => L * B * D
Jee Jee Li's avatar
Jee Jee Li committed
229
        x, _ = self.kv_proj(x)  # B * L * D
230
231
232
233
234
235
236
237
        x = self.ln_kv(x).permute(1, 0, 2)  # L * B * D

        q = self.ln_q(self.query)  # Q * D

        out = self.attn(
            self._repeat(q, bs),  # Q * B * D
            x + pos_embed,  # L * B * D +  L * B * D
            x,
Jee Jee Li's avatar
Jee Jee Li committed
238
239
            key_padding_mask=key_padding_mask,
        )[0]
240
241
242
243
244
245
246
247
        #  out: Q * B * D
        x = out.permute(1, 0, 2)  # B * Q * D

        x = self.ln_post(x)
        x = x @ self.proj
        return x


tc-mb's avatar
tc-mb committed
248
class Resampler4_5(Resampler2_5):
249
250
251
252
253
    def __init__(
        self,
        num_queries: int,
        embed_dim: int,
        num_heads: int,
254
        kv_dim: int | None = None,
255
256
257
        norm_layer: Callable[[int], nn.LayerNorm] = DEFAULT_LN,
        max_size: tuple[int, int] = (70, 70),
        max_temporal_size: int = 36000,
258
        quant_config: QuantizationConfig | None = None,
259
260
261
262
263
264
265
266
267
268
269
270
        prefix: str = "",
    ) -> None:
        super().__init__(
            num_queries,
            embed_dim,
            num_heads,
            kv_dim,
            norm_layer,
            max_size,
            quant_config=quant_config,
            prefix=prefix,
        )
tc-mb's avatar
tc-mb committed
271

272
        trunc_normal_(self.query, std=0.02)
tc-mb's avatar
tc-mb committed
273
274
275
276
        self.max_temporal_size = max_temporal_size
        self._set_temporal_pos_cache(self.max_temporal_size)
        self.apply(self._init_weights)

277
278
279
    def get_1d_sincos_pos_embed_from_temporal_size(
        self, embed_dim: int, pos: np.ndarray
    ):
tc-mb's avatar
tc-mb committed
280
281
282
283
284
285
286
        """
        embed_dim: output dimension for each position
        pos: a list of positions to be encoded: size (M,)
        out: (M, D)
        """
        assert embed_dim % 2 == 0
        omega = np.arange(embed_dim // 2, dtype=np.float32)
287
288
        omega /= embed_dim / 2.0
        omega = 1.0 / 10000**omega  # (D/2,)
tc-mb's avatar
tc-mb committed
289
290

        pos = pos.reshape(-1)  # (M,)
291
        out = np.einsum("m,d->md", pos, omega)  # (M, D/2), outer product
tc-mb's avatar
tc-mb committed
292
293
294
295
296
297
298

        emb_sin = np.sin(out)  # (M, D/2)
        emb_cos = np.cos(out)  # (M, D/2)

        emb = np.concatenate([emb_sin, emb_cos], axis=1)  # (M, D)
        return emb

299
300
301
    def _set_temporal_pos_cache(
        self, max_temporal_size: int, device: torch.types.Device = "cpu"
    ) -> None:
tc-mb's avatar
tc-mb committed
302
        temporal_size = np.arange(max_temporal_size, dtype=np.float32)
303
304
305
306
307
308
309
310
311
        pos_embed = (
            torch.from_numpy(
                self.get_1d_sincos_pos_embed_from_temporal_size(
                    self.embed_dim, temporal_size
                )
            )
            .float()
            .to(device)
        )
tc-mb's avatar
tc-mb committed
312
313
        self.register_buffer("temporal_pos_embed", pos_embed, persistent=False)

314
315
316
    def _adjust_temporal_pos_cache(
        self, max_temporal_size: int, device: torch.types.Device = "cpu"
    ):
tc-mb's avatar
tc-mb committed
317
318
319
320
        if max_temporal_size > self.max_temporal_size:
            self.max_temporal_size = max_temporal_size
            self._set_temporal_pos_cache(self.max_temporal_size, device)

321
    def _init_weights(self, m: nn.Linear | nn.LayerNorm):
tc-mb's avatar
tc-mb committed
322
        if isinstance(m, nn.Linear):
323
            trunc_normal_(m.weight, std=0.02)
tc-mb's avatar
tc-mb committed
324
325
326
327
328
329
330
331
332
333
334
            if isinstance(m, nn.Linear) and m.bias is not None:
                nn.init.constant_(m.bias, 0)
        elif isinstance(m, nn.LayerNorm):
            nn.init.constant_(m.bias, 0)
            nn.init.constant_(m.weight, 1.0)

    def forward(
        self,
        x: torch.Tensor,
        tgt_sizes: torch.Tensor,
        # temporal_ids for high refresh rate videos
335
        temporal_ids=None,
tc-mb's avatar
tc-mb committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
    ) -> torch.Tensor:
        assert x.shape[0] == tgt_sizes.shape[0]
        bs = x.shape[0]

        device = x.device
        dtype = x.dtype

        patch_len = tgt_sizes[:, 0] * tgt_sizes[:, 1]

        self._adjust_pos_cache(tgt_sizes, device=device)

        temporal_pos_emb = False
        temporal_ids_flatten = None
        if temporal_ids is not None:
            # example: [[-1], [-1], [2, 6, 9]]
            temporal_ids_flatten = list(chain.from_iterable(temporal_ids))
            max_temporal_size = max(temporal_ids_flatten, default=0)
            if max_temporal_size > -1:
                temporal_pos_emb = True
            if max_temporal_size > self.max_temporal_size:
                self._adjust_temporal_pos_cache(max_temporal_size, device)

        max_patch_len = patch_len.max().item()
        assert isinstance(max_patch_len, int)

361
362
363
        key_padding_mask = torch.zeros(
            (bs, max_patch_len), dtype=torch.bool, device=device
        )
tc-mb's avatar
tc-mb committed
364
365
366
367
368
369
370
371
372
373
374
375

        x, _ = self.kv_proj(x)  # B * L * D
        x = self.ln_kv(x).permute(1, 0, 2)  # L * B * D
        q = self.ln_q(self.query)  # Q * D

        pos_embed_2d = []
        pos_embed_temporal = []
        for i in range(bs):
            tgt_h, tgt_w = tgt_sizes[i]
            if temporal_pos_emb:
                if temporal_ids_flatten[i] == -1:
                    pos_embed_temporal.append(
376
377
                        torch.zeros(self.embed_dim, dtype=dtype, device=device)
                    )
tc-mb's avatar
tc-mb committed
378
                else:
379
380
381
                    pos_embed_temporal.append(
                        self.temporal_pos_embed[temporal_ids_flatten[i]].to(dtype)
                    )  # D
tc-mb's avatar
tc-mb committed
382

383
384
385
386
            pos_embed_2d.append(
                self.pos_embed[:tgt_h, :tgt_w, :].reshape((tgt_h * tgt_w, -1)).to(dtype)
            )  # patches * D
            key_padding_mask[i, patch_len[i] :] = True
tc-mb's avatar
tc-mb committed
387
388

        pos_embed_2d = torch.nn.utils.rnn.pad_sequence(
389
390
            pos_embed_2d, batch_first=True, padding_value=0.0
        ).permute(1, 0, 2)  # BLD => L * B * D
tc-mb's avatar
tc-mb committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

        k = x
        v = x + pos_embed_2d
        if pos_embed_temporal:
            k += torch.stack(pos_embed_temporal, dim=0)
            bs = len(temporal_ids)
            merge_k = []
            merge_v = []
            merge_key_padding_mask = []

            start = 0
            for tp in temporal_ids:
                end = start + len(tp)
                # L * (end-start) * D -> (end-start) * L * D
                # -> 1 * L*(end-start) * D
406
407
408
409
410
411
                merge_k.append(
                    k[:, start:end, :].permute(1, 0, 2).reshape(-1, self.embed_dim)
                )
                merge_v.append(
                    v[:, start:end, :].permute(1, 0, 2).reshape(-1, self.embed_dim)
                )
tc-mb's avatar
tc-mb committed
412
                merge_key_padding_mask.append(
413
414
                    key_padding_mask[start:end, :].reshape(-1, 1)
                )
tc-mb's avatar
tc-mb committed
415
416
417

                start = end

418
419
420
421
422
423
            k = torch.nn.utils.rnn.pad_sequence(
                merge_k, batch_first=True, padding_value=0.0
            ).permute(1, 0, 2)  # L*(end-start)
            v = torch.nn.utils.rnn.pad_sequence(
                merge_v, batch_first=True, padding_value=0.0
            ).permute(1, 0, 2)  # L*(end-start)
tc-mb's avatar
tc-mb committed
424
            key_padding_mask = torch.nn.utils.rnn.pad_sequence(
425
426
                merge_key_padding_mask, batch_first=True, padding_value=True
            ).squeeze(-1)
tc-mb's avatar
tc-mb committed
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441

        out = self.attn(
            self._repeat(q, bs),  # Q * B * D
            k,  # L * B * D +  L * B * D
            v,
            key_padding_mask=key_padding_mask,
        )[0]
        #  out: Q * B * D
        x = out.permute(1, 0, 2)  # B * Q * D

        x = self.ln_post(x)
        x = x @ self.proj
        return x


442
def get_version_by_config(config: PretrainedConfig) -> tuple[int, ...]:
443
444
445
446
447
448
449
450
451
452
453
454
    version_float = getattr(config, "version", None)

    # The old configs do not include version number
    # TODO: Remove this after the HF repos are updated
    if version_float is None:
        if config.hidden_size == 2304 and config.query_num == 64:
            return (2, 0)
        return (2, 5)
    version_str = str(version_float)
    return tuple(int(x) for x in version_str.split("."))


455
def _minicpmv_field_config(hf_inputs: Mapping[str, torch.Tensor]):
456
457
458
459
460
461
    pixel_values = hf_inputs.get("pixel_values", torch.empty(0))
    num_images = len(pixel_values)

    video_pixel_values = hf_inputs.get("video_pixel_values", torch.empty(0))
    num_videos = len(video_pixel_values)

462
    return dict(
463
        pixel_values=MultiModalFieldConfig.batched("image"),
464
        image_sizes=MultiModalFieldConfig.batched("image"),
465
466
467
        tgt_sizes=MultiModalFieldConfig.batched("image"),
        image_embeds=MultiModalFieldConfig.batched("image"),
        video_pixel_values=MultiModalFieldConfig.batched("video"),
468
        video_image_sizes=MultiModalFieldConfig.batched("video"),
469
470
        video_tgt_sizes=MultiModalFieldConfig.batched("video"),
        video_embeds=MultiModalFieldConfig.batched("video"),
471
472
        image_token_id=MultiModalFieldConfig.shared("image", num_images),
        video_token_id=MultiModalFieldConfig.shared("video", num_videos),
473
474
475
476
477
478
479
    )


class MiniCPMVImageEmbeddingItems(DictEmbeddingItems):
    def __init__(
        self,
        data: Mapping[str, torch.Tensor],
480
481
482
483
        fields_factory: Callable[
            [Mapping[str, torch.Tensor]],
            Mapping[str, MultiModalFieldConfig],
        ],
484
485
486
487
488
    ) -> None:
        super().__init__(
            data,
            modality="image",
            required_fields={"image_embeds", "image_sizes"},
489
            fields_factory=fields_factory,
490
491
492
493
494
495
496
497
498
499
500
        )

    def get_image_size(self, index: int) -> ImageSize:
        image_size = self.get(index)["image_sizes"].tolist()
        return ImageSize(width=image_size[0], height=image_size[1])


class MiniCPMVVideoEmbeddingItems(DictEmbeddingItems):
    def __init__(
        self,
        data: Mapping[str, torch.Tensor],
501
502
503
504
        fields_factory: Callable[
            [Mapping[str, torch.Tensor]],
            Mapping[str, MultiModalFieldConfig],
        ],
505
506
507
508
509
    ) -> None:
        super().__init__(
            data,
            modality="video",
            required_fields={"video_embeds", "video_image_sizes"},
510
            fields_factory=fields_factory,
511
512
513
514
515
516
517
518
519
520
        )

    def get_frame_size(self, index: int) -> ImageSize:
        frame_size = self.get(index)["video_image_sizes"].tolist()
        return ImageSize(width=frame_size[0], height=frame_size[1])

    def get_num_frames(self, index: int) -> int:
        return len(self.get(index)["video_image_sizes"])


521
522
523
class MiniCPMVMultiModalDataParser(MultiModalDataParser):
    def _parse_image_data(
        self,
524
525
        data: dict[str, torch.Tensor] | ModalityData[ImageItem],
    ) -> ModalityDataItems[Any, Any] | None:
526
        if isinstance(data, dict):
527
528
            return MiniCPMVImageEmbeddingItems(
                data,
529
                fields_factory=_minicpmv_field_config,
530
531
            )

532
533
534
535
        return super()._parse_image_data(data)

    def _parse_video_data(
        self,
536
537
        data: dict[str, torch.Tensor] | ModalityData[VideoItem],
    ) -> ModalityDataItems[Any, Any] | None:
538
        if isinstance(data, dict):
539
540
            return MiniCPMVVideoEmbeddingItems(
                data,
541
                fields_factory=_minicpmv_field_config,
542
543
            )

544
545
546
547
548
549
550
551
552
553
        return super()._parse_video_data(data)


class MiniCPMVProcessingInfo(BaseProcessingInfo):
    image_pattern = "(<image>./</image>)"
    video_pattern = "(<video>./</video>)"

    def get_hf_config(self):
        return self.ctx.get_hf_config()

554
555
    def get_hf_processor(self, **kwargs: object):
        hf_processor = self.ctx.get_hf_processor(**kwargs)
556
557
558
559
560
561
562
563
564

        # NumPy arrays are considered as Iterable but not Sequence in
        # https://github.com/huggingface/transformers/blob/main/src/transformers/image_transforms.py#L428
        image_processor = hf_processor.image_processor  # type: ignore
        for attr in ("mean", "std"):
            val = getattr(image_processor, attr)
            if isinstance(val, np.ndarray):
                setattr(image_processor, attr, val.tolist())

565
566
        return hf_processor

567
568
    def get_image_processor(self, **kwargs: object):
        return self.get_hf_processor(**kwargs).image_processor
569
570
571
572

    def get_model_version(self):
        return get_version_by_config(self.get_hf_config())

573
    def get_supported_mm_limits(self) -> Mapping[str, int | None]:
574
        mm_limits = {"image": None}
tc-mb's avatar
tc-mb committed
575
        if self.get_model_version() in {(2, 6), (4, 0), (4, 5)}:
576
577
578
            mm_limits["video"] = None

        return mm_limits
579

580
581
582
583
584
    def get_slice_image_placeholder(
        self,
        image_size: ImageSize,
        # For MiniCPM V/O 2.6
        image_idx: int = 0,
585
        max_slice_nums: int | None = None,
586
587
588
589
        use_image_id: bool = True,
    ) -> str:
        image_processor = self.get_image_processor()
        version = self.get_model_version()
590

591
592
        if version == (2, 0) or version == (2, 5):
            return image_processor.get_slice_image_placeholder(image_size)
593

594
595
596
597
598
599
        return image_processor.get_slice_image_placeholder(
            image_size,
            image_idx=image_idx,
            max_slice_nums=max_slice_nums,
            use_image_id=use_image_id,
        )
600

601
602
603
604
    def get_sliced_grid(
        self,
        image_size: ImageSize,
        # For MiniCPM V/O 2.6
605
606
        max_slice_nums: int | None = None,
    ) -> tuple[int, int] | None:
607
608
609
610
611
612
613
614
615
616
617
618
619
620
        image_processor = self.get_image_processor()
        version = self.get_model_version()

        if version == (2, 0) or version == (2, 5):
            return image_processor.get_sliced_grid(image_size)

        if max_slice_nums is None:
            max_slice_nums = image_processor.max_slice_nums

        return image_processor.get_sliced_grid(
            image_size,
            max_slice_nums=max_slice_nums,
        )

621
622
623
    def get_num_image_tokens(
        self,
        image_size: ImageSize,
624
        max_slice_nums: int | None = None,
625
    ) -> int:
626
627
628
        image_processor = self.get_image_processor()

        grid = self.get_sliced_grid(
629
630
631
            image_size,
            max_slice_nums=max_slice_nums,
        )
632
633
634
635
        if grid is None:
            ncols = nrows = 0
        else:
            ncols, nrows = grid
636

637
        return (ncols * nrows + 1) * image_processor.image_feature_size
638
639
640

    def get_max_image_tokens(self) -> int:
        image_size = self.get_image_size_with_most_features()
641
642
643
644
        return self.get_num_image_tokens(image_size)

    def get_image_max_slice_num(self) -> int:
        return getattr(self.get_hf_config(), "max_slice_num", 9)
645
646

    def get_image_size_with_most_features(self) -> ImageSize:
647
648
649
650
651
652
653
654
655
656
657
658
        image_size = getattr(self.get_hf_config(), "image_size", 448)
        max_slice_num = self.get_image_max_slice_num()
        return ImageSize(width=image_size, height=image_size * max_slice_num)

    def get_max_video_frame_tokens(self) -> int:
        frame_size = self.get_video_frame_size_with_most_features()

        return self.get_num_image_tokens(
            frame_size,
            max_slice_nums=self.get_video_max_slice_num(),
        )

659
660
661
662
663
664
665
666
    def get_max_video_tokens(
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
    ) -> int:
        num_frames = self.get_num_frames_with_most_features(seq_len, mm_counts)
        num_video_tokens_total = self.get_max_video_frame_tokens() * num_frames
        return num_video_tokens_total
667
668
669

    def get_video_max_slice_num(self) -> int:
        return 1
670

671
    def get_video_frame_size_with_most_features(self) -> ImageSize:
672
673
674
        image_size = getattr(self.get_hf_config(), "image_size", 448)
        max_slice_num = self.get_video_max_slice_num()
        return ImageSize(width=image_size, height=image_size * max_slice_num)
675

676
677
678
679
    def get_max_video_frames(self, max_tokens: int) -> int:
        num_frame_tokens = self.get_max_video_frame_tokens()
        num_frames = max_tokens // num_frame_tokens
        return num_frames
680

681
682
683
684
685
686
687
    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)
688

689
        max_image_tokens = self.get_max_image_tokens() * max_images
690
691
692
693
        max_total_frames = self.get_max_video_frames(seq_len - max_image_tokens)
        max_frames_per_video = min(
            max_total_frames // max(max_videos, 1), _MAX_FRAMES_PER_VIDEO
        )
694

695
        return max(max_frames_per_video, 1)
696
697


698
_I = TypeVar("_I", bound=MiniCPMVProcessingInfo, default=MiniCPMVProcessingInfo)
699
700
701


class MiniCPMVDummyInputsBuilder(BaseDummyInputsBuilder[_I]):
702
703
704
705
706
707
708
709
710
711
    def get_dummy_text(self, mm_counts: Mapping[str, int]) -> str:
        num_images = mm_counts.get("image", 0)
        num_videos = mm_counts.get("video", 0)

        image_prompt_texts = self.info.image_pattern * num_images
        video_prompt_texts = self.info.video_pattern * num_videos

        return image_prompt_texts + video_prompt_texts

    def get_dummy_mm_data(
712
713
714
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
715
        mm_options: Mapping[str, BaseDummyOptions] | None = None,
716
    ) -> MultiModalDataDict:
717
718
719
        num_images = mm_counts.get("image", 0)
        num_videos = mm_counts.get("video", 0)

720
721
722
723
724
        image_width, image_height = self.info.get_image_size_with_most_features()
        video_width, video_height = self.info.get_video_frame_size_with_most_features()
        num_video_frames = self.info.get_num_frames_with_most_features(
            seq_len, mm_counts
        )
725

726
727
728
        image_overrides = mm_options.get("image") if mm_options else None
        video_overrides = mm_options.get("video") if mm_options else None

729
        return {
730
731
732
733
734
735
            "image": self._get_dummy_images(
                width=image_width,
                height=image_height,
                num_images=num_images,
                overrides=image_overrides,
            ),
736
            "video": [
737
738
739
740
741
742
743
744
                self._get_dummy_images(
                    width=video_width,
                    height=video_height,
                    num_images=num_video_frames,
                    overrides=video_overrides,
                )
            ]
            * num_videos,
745
746
747
        }


748
class MiniCPMVMultiModalProcessor(BaseMultiModalProcessor[_I]):
749
750
751
    def _get_data_parser(self) -> MultiModalDataParser:
        return MiniCPMVMultiModalDataParser()

752
    def get_image_prompt_texts(self, image_size: ImageSize, image_idx: int = 0) -> str:
753
754
755
756
        return self.info.get_slice_image_placeholder(
            image_size,
            image_idx=image_idx,
        )
757

758
759
760
761
762
763
764
765
766
767
    def get_video_prompt_texts(self, image_size: ImageSize, num_frames: int) -> str:
        return (
            self.info.get_slice_image_placeholder(
                image_size=image_size,
                image_idx=0,
                max_slice_nums=self.info.get_video_max_slice_num(),
                use_image_id=False,
            )
            * num_frames
        )
768

769
770
771
772
    def process_images(
        self,
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
773
        tok_kwargs: Mapping[str, object],
774
    ) -> Mapping[str, NestedTensors]:
775
776
777
        if (images := mm_data.get("images")) is None:
            return {}

778
779
780
781
782
        parsed_images = (
            self._get_data_parser()
            .parse_mm_data({"image": images})
            .get_items("image", (MiniCPMVImageEmbeddingItems, ImageProcessorItems))
        )
783

784
785
786
787
788
789
790
        if isinstance(parsed_images, MiniCPMVImageEmbeddingItems):
            image_inputs = {}
        else:
            image_inputs = self._base_call_hf_processor(
                prompts=[self.info.image_pattern] * len(parsed_images),
                mm_data={"images": [[image] for image in parsed_images]},
                mm_kwargs=mm_kwargs,
791
                tok_kwargs=tok_kwargs,
792
793
794
795
796
797
798
799
                out_keys={"pixel_values", "image_sizes", "tgt_sizes"},
            )

        tokenizer = self.info.get_tokenizer()
        unk_token_id = tokenizer.get_vocab()["<unk>"]
        image_inputs["image_token_id"] = torch.tensor(unk_token_id)

        return image_inputs
800

801
802
803
804
    def process_videos(
        self,
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
805
        tok_kwargs: Mapping[str, object],
806
    ) -> Mapping[str, NestedTensors]:
807
808
809
        if (videos := mm_data.get("videos")) is None:
            return {}

810
811
812
813
814
        parsed_videos = (
            self._get_data_parser()
            .parse_mm_data({"video": videos})
            .get_items("video", (MiniCPMVVideoEmbeddingItems, VideoProcessorItems))
        )
815
816
817
818
819
820

        if isinstance(parsed_videos, MiniCPMVVideoEmbeddingItems):
            video_inputs = {}
        else:
            video_inputs = self._base_call_hf_processor(
                prompts=[
821
                    self.info.image_pattern * len(video) for video in parsed_videos
822
823
824
825
                ],
                mm_data={"images": list(parsed_videos)},
                mm_kwargs={
                    **mm_kwargs,
826
                    "max_slice_nums": self.info.get_video_max_slice_num(),
827
                },
828
                tok_kwargs=tok_kwargs,
829
830
831
                out_keys={"pixel_values", "image_sizes", "tgt_sizes"},
            )

832
833
        video_inputs = {f"video_{k}": v for k, v in video_inputs.items()}

834
        tokenizer = self.info.get_tokenizer()
835
836
        unk_token_id = tokenizer.get_vocab()["<unk>"]
        video_inputs["video_token_id"] = torch.tensor(unk_token_id)
837

838
        return video_inputs
839

840
841
842
843
    def process_mm_inputs(
        self,
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
844
        tok_kwargs: Mapping[str, object],
845
    ) -> Mapping[str, NestedTensors]:
846
        return {
847
848
            **self.process_images(mm_data, mm_kwargs, tok_kwargs),
            **self.process_videos(mm_data, mm_kwargs, tok_kwargs),
849
        }
850

851
    def _base_call_hf_processor(
852
        self,
853
854
        prompts: list[str],
        mm_data: Mapping[str, Sequence[object]],
855
        mm_kwargs: Mapping[str, object],
856
        tok_kwargs: Mapping[str, object],
857
858
        *,
        out_keys: set[str],
859
    ) -> dict[str, NestedTensors]:
860
        # This processor supports zipping prompt and mm_data together
tc-mb's avatar
tc-mb committed
861
        if self.info.get_model_version() in {(2, 6), (4, 0), (4, 5)}:
862
863
864
865
            inputs = super()._call_hf_processor(
                prompt=prompts,  # type: ignore
                mm_data=mm_data,
                mm_kwargs=mm_kwargs,
866
                tok_kwargs=tok_kwargs,
867
868
869
870
871
872
873
            )
        else:
            inputs = defaultdict[str, list[torch.Tensor]](list)

            for i, prompt in enumerate(prompts):
                inputs_one = super()._call_hf_processor(
                    prompt=prompt,
874
                    mm_data={k: v[i] for k, v in mm_data.items()},
875
                    mm_kwargs=mm_kwargs,
876
                    tok_kwargs=tok_kwargs,
877
878
879
880
881
882
883
                )

                for k, v in inputs_one.items():
                    assert len(v) == 1, (k, len(v))
                    inputs[k].append(v[0])

        return {k: inputs[k] for k in out_keys}
884
885
886
887
888
889

    def _call_hf_processor(
        self,
        prompt: str,
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
890
        tok_kwargs: Mapping[str, object],
891
892
    ) -> BatchFeature:
        tokenizer = self.info.get_tokenizer()
893

894
895
        input_ids = torch.tensor([tokenizer.encode(prompt, **tok_kwargs)])
        mm_inputs = self.process_mm_inputs(mm_data, mm_kwargs, tok_kwargs)
896

897
898
899
900
901
902
        return BatchFeature(
            {
                "input_ids": input_ids,
                **mm_inputs,
            }
        )
903

904
    def _hf_processor_applies_updates(
905
906
907
908
        self,
        prompt_text: str,
        mm_items: MultiModalDataItems,
        hf_processor_mm_kwargs: Mapping[str, object],
909
        tokenization_kwargs: Mapping[str, object],
910
911
912
    ) -> bool:
        return False

913
    def _get_prompt_updates(
914
915
916
        self,
        mm_items: MultiModalDataItems,
        hf_processor_mm_kwargs: Mapping[str, object],
917
        out_mm_kwargs: MultiModalKwargsItems,
918
    ) -> Sequence[PromptUpdate]:
919
920
921
922
        placeholders = [
            ("image", self.info.image_pattern),
            ("video", self.info.video_pattern),
        ]
tc-mb's avatar
tc-mb committed
923
924
925
926
927
928

        # hard code for inconsistency of encode-decode image_pattern
        additional_placeholders = []
        tokenizer = self.info.get_tokenizer()
        for modality, pattern in placeholders:
            sub_pattern = tokenizer.decode(
929
930
                tokenizer.encode(pattern, add_special_tokens=False)
            )
tc-mb's avatar
tc-mb committed
931
932
933
            if sub_pattern != pattern:
                additional_placeholders.append((modality, sub_pattern))
        placeholders += additional_placeholders
934

935
936
        def get_image_replacement(item_idx: int):
            images = mm_items.get_items(
937
938
                "image", (MiniCPMVImageEmbeddingItems, ImageProcessorItems)
            )
939
940
941

            image_size = images.get_image_size(item_idx)

942
943
944
945
            return PromptUpdateDetails.select_text(
                self.get_image_prompt_texts(image_size, item_idx),
                "<unk>",
            )
946
947
948

        def get_video_replacement(item_idx: int):
            videos = mm_items.get_items(
949
950
                "video", (MiniCPMVVideoEmbeddingItems, VideoProcessorItems)
            )
951
952
953
954

            frame_size = videos.get_frame_size(item_idx)
            num_frames = videos.get_num_frames(item_idx)

955
956
957
958
            return PromptUpdateDetails.select_text(
                self.get_video_prompt_texts(frame_size, num_frames),
                "<unk>",
            )
959
960
961
962
963

        get_replacement = {
            "image": get_image_replacement,
            "video": get_video_replacement,
        }
964
965

        return [
966
967
968
            PromptReplacement(
                modality=modality, target=pattern, replacement=get_replacement[modality]
            )
tc-mb's avatar
tc-mb committed
969
            for modality, pattern in placeholders
970
        ]
971

972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
    def _recompute_cached_prompt_update(
        self,
        cached_update: ResolvedPromptUpdate,
        new_item_idx: int,
    ) -> ResolvedPromptUpdate:
        new_update = super()._recompute_cached_prompt_update(
            cached_update,
            new_item_idx,
        )

        if cached_update.modality == "image":
            tokenizer = self.info.get_tokenizer()
            image_processor = self.info.get_image_processor()
            version = self.info.get_model_version()

            text = _seq2text(tokenizer, cached_update.content.full)
            prev_item_idx = cached_update.item_idx

            if version == (2, 0) or version == (2, 5):
                im_start = image_processor.im_start_token
                im_end = image_processor.im_end_token
            else:
                im_start = image_processor.im_id_start
                im_end = image_processor.im_id_end

            new_update = new_update.with_content(
                PromptUpdateDetails.select_text(
                    text.replace(
                        f"{im_start}{prev_item_idx}{im_end}",
                        f"{im_start}{new_item_idx}{im_end}",
                        1,
                    ),
                    "<unk>",
1005
1006
                )
            )
1007
1008
1009

        return new_update

1010
1011
    def _get_mm_fields_config(
        self,
1012
        hf_inputs: BatchFeature,
1013
1014
        hf_processor_mm_kwargs: Mapping[str, object],
    ) -> Mapping[str, MultiModalFieldConfig]:
1015
        return _minicpmv_field_config(hf_inputs)
1016

1017
1018

class MiniCPMVBaseModel(nn.Module, SupportsMultiModal, SupportsPP):
Jee Jee Li's avatar
Jee Jee Li committed
1019
1020
1021
1022
    """
    The abstract class of MiniCPMV can only be inherited, but cannot be
    instantiated.
    """
1023

1024
1025
    supports_encoder_tp_data = True

1026
    @classmethod
1027
    def get_placeholder_str(cls, modality: str, i: int) -> str | None:
1028
1029
1030
1031
1032
1033
1034
        if modality.startswith("image"):
            return "(<image>./</image>)"
        if modality.startswith("video"):
            return "(<video>./</video>)"

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

1035
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
1036
1037
1038
        config = vllm_config.model_config.hf_config
        multimodal_config = vllm_config.model_config.multimodal_config
        quant_config = vllm_config.quant_config
1039
        self.use_data_parallel = multimodal_config.mm_encoder_tp_mode == "data"
1040
        super().__init__()
1041
1042
1043
1044
        # All MiniCPM-V models disable `tie_word_embeddings` but
        # `PretrainedConfig.tie_word_embeddings` defaults to True; we cannot
        # check `tie_word_embeddings` until vLLM integrate MiniCPM-V model
        # and config class
1045
1046
1047
        self.config = config
        self.multimodal_config = multimodal_config

1048
        self.version = get_version_by_config(self.config)
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
        self.llm = self.init_llm(
            vllm_config=vllm_config, prefix=maybe_prefix(prefix, "llm")
        )
        self.vpm = self.init_vision_module(
            config, quant_config, prefix=maybe_prefix(prefix, "vpm")
        )
        self.vision_dim = (
            self.vpm.embed_dim
            if self.version == (2, 0)
            else self.vpm.embeddings.embed_dim
        )
Alphi's avatar
Alphi committed
1060
        self.embed_dim = self.config.hidden_size
1061

1062
1063
1064
1065
1066
1067
        self.resampler = self.init_resampler(
            self.embed_dim,
            self.vision_dim,
            quant_config=quant_config,
            prefix=maybe_prefix(prefix, "resampler"),
        )
1068

1069
        self.mm_token_ids = set[int]()
1070
        self.make_empty_intermediate_tensors = self.llm.make_empty_intermediate_tensors
1071

1072
    def _parse_and_validate_vision_input(
Jee Jee Li's avatar
Jee Jee Li committed
1073
        self,
1074
        modality: str,
Jee Jee Li's avatar
Jee Jee Li committed
1075
        **kwargs: object,
1076
    ) -> MiniCPMVImageInputs | None:
1077
1078
        pixel_values = kwargs.pop("pixel_values", None)
        image_embeds = kwargs.pop("image_embeds", None)
1079

1080
        if pixel_values is None and image_embeds is None:
1081
1082
            return None

1083
1084
1085
1086
1087
1088
1089
1090
1091
        image_token_id = kwargs.pop("image_token_id")
        if image_token_id is not None:
            assert isinstance(image_token_id, torch.Tensor)
            self.mm_token_ids.add(image_token_id.flatten().unique().item())

        if image_embeds is not None:
            if not isinstance(image_embeds, (torch.Tensor, list)):
                raise ValueError(
                    f"Incorrect type of image_embeds for {modality=}. "
1092
1093
                    f"Got type: {type(image_embeds)}"
                )
1094
1095

            image_embeds_flat = flatten_bn(image_embeds)
1096

1097
            return MiniCPMVImageEmbeddingInputs(
1098
                type="image_embeds",
1099
                image_embeds=image_embeds_flat,
1100
            )
1101

1102
1103
1104
        if not isinstance(pixel_values, (torch.Tensor, list)):
            raise ValueError(
                f"Incorrect type of pixel_values for {modality=}. "
1105
1106
                f"Got type: {type(pixel_values)}"
            )
1107

1108
1109
        tgt_sizes = kwargs.pop("tgt_sizes")
        if not isinstance(tgt_sizes, (torch.Tensor, list)):
1110
1111
1112
1113
            raise ValueError(
                f"Incorrect type of tgt_sizes for {modality=}. "
                f"Got type: {type(tgt_sizes)}"
            )
1114
1115
1116
1117
1118
1119

        num_slices = [[len(p) for p in ps] for ps in pixel_values]
        num_slices_flat = flatten_bn(torch.tensor(num_slices))

        pixel_values_flat = flatten_bn(flatten_2d_lists(pixel_values))
        tgt_sizes_flat = flatten_bn(flatten_2d_lists(tgt_sizes), concat=True)
1120

1121
        return MiniCPMVImagePixelInputs(
1122
1123
            type="pixel_values",
            pixel_values=pixel_values_flat,
1124
1125
            tgt_sizes=tgt_sizes_flat,
            num_slices=num_slices_flat,
Jee Jee Li's avatar
Jee Jee Li committed
1126
        )
1127

1128
1129
1130
1131
1132
1133
    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:
1134
1135
1136
1137
            if (
                input_key in ("pixel_values", "image_embeds")
                and "images" not in modalities
            ):
1138
                modalities["images"] = self._parse_and_validate_vision_input(
1139
1140
1141
1142
1143
1144
                    "images", **kwargs
                )
            if (
                input_key in ("video_pixel_values", "video_embeds")
                and "videos" not in modalities
            ):
1145
1146
1147
1148
1149
1150
1151
1152

                def _image_key(video_key: str):
                    if video_key == "video_token_id":
                        return "image_token_id"

                    return video_key.removeprefix("video_")

                modalities["videos"] = self._parse_and_validate_vision_input(
1153
1154
                    "videos", **{_image_key(k): v for k, v in kwargs.items()}
                )
1155
1156
1157
1158
1159
1160

        return modalities

    def _process_vision_input(
        self,
        image_input: MiniCPMVImageInputs,
1161
    ) -> torch.Tensor | list[torch.Tensor] | tuple[torch.Tensor, ...]:
1162
1163
1164
1165
1166
        if image_input["type"] == "image_embeds":
            return image_input["image_embeds"]

        image_features_flat = self.get_vision_hidden_states(image_input)

1167
        num_slices = image_input["num_slices"]
1168
        return [e.flatten(0, 1) for e in image_features_flat.split(num_slices.tolist())]
1169
1170
1171

    def _process_multimodal_inputs(self, modalities: dict):
        # The result multimodal_embeddings is tuple of tensors, with each
1172
        # tensor corresponding to a multimodal data item (image or video).
1173
1174
1175
1176
1177
1178
1179
1180
        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"]
                image_features = self._process_vision_input(image_input)
1181
                multimodal_embeddings += tuple(image_features)
1182
1183
1184
            if modality == "videos":
                video_input = modalities["videos"]
                video_features = self._process_vision_input(video_input)
1185
                multimodal_embeddings += tuple(video_features)
1186
1187
1188

        return multimodal_embeddings

1189
1190
1191
    def get_language_model(self) -> torch.nn.Module:
        return self.llm

1192
    def get_multimodal_embeddings(self, **kwargs: object) -> MultiModalEmbeddings:
1193
1194
        modalities = self._parse_and_validate_multimodal_inputs(**kwargs)
        if not modalities:
1195
            return []
1196
1197
1198

        return self._process_multimodal_inputs(modalities)

1199
1200
1201
1202
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
1203
1204
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
Jee Jee Li's avatar
Jee Jee Li committed
1205
1206
        **kwargs: Any,
    ) -> torch.Tensor:
1207
        if intermediate_tensors is not None:
1208
1209
1210
            inputs_embeds = None

        hidden_states = self.llm.model(
1211
            input_ids=input_ids,
Jee Jee Li's avatar
Jee Jee Li committed
1212
1213
            positions=positions,
            intermediate_tensors=intermediate_tensors,
1214
            inputs_embeds=inputs_embeds,
Jee Jee Li's avatar
Jee Jee Li committed
1215
        )
1216
        return hidden_states
1217

1218
1219
1220
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
1221
    ) -> torch.Tensor | None:
1222
        return self.llm.compute_logits(hidden_states)
1223

1224
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
1225
1226
        loader = AutoWeightsLoader(self)
        return loader.load_weights(weights)
Jee Jee Li's avatar
Jee Jee Li committed
1227

1228
1229
1230
1231
    def get_mm_mapping(self) -> MultiModelKeys:
        """
        Get the module prefix in multimodal models
        """
1232
1233
1234
        return MultiModelKeys.from_string_field(
            language_model="llm", connector="resampler", tower_model="vpm"
        )
1235

Jee Jee Li's avatar
Jee Jee Li committed
1236
1237
    def init_llm(
        self,
1238
        vllm_config: VllmConfig,
1239
        prefix: str = "",
Jee Jee Li's avatar
Jee Jee Li committed
1240
1241
1242
    ) -> nn.Module:
        raise NotImplementedError

1243
1244
1245
    def init_vision_module(
        self,
        config: PretrainedConfig,
1246
        quant_config: QuantizationConfig | None,
1247
        prefix: str = "",
1248
    ) -> nn.Module:
Jee Jee Li's avatar
Jee Jee Li committed
1249
1250
        raise NotImplementedError

1251
1252
1253
1254
    def init_resampler(
        self,
        embed_dim: int,
        vision_dim: int,
1255
        quant_config: QuantizationConfig | None = None,
1256
1257
        prefix: str = "",
    ) -> nn.Module:
Jee Jee Li's avatar
Jee Jee Li committed
1258
1259
        raise NotImplementedError

1260
    def get_vision_hidden_states(self, data: MiniCPMVImagePixelInputs) -> torch.Tensor:
Jee Jee Li's avatar
Jee Jee Li committed
1261
1262
1263
        raise NotImplementedError


1264
class MiniCPMV2_0(MiniCPMVBaseModel):
1265
1266
    supports_encoder_tp_data = False

1267
1268
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__(vllm_config=vllm_config, prefix=prefix)
Jee Jee Li's avatar
Jee Jee Li committed
1269
1270
1271
1272
        assert self.version == (2, 0)

    def init_llm(
        self,
1273
        vllm_config: VllmConfig,
1274
        prefix: str = "",
Jee Jee Li's avatar
Jee Jee Li committed
1275
    ) -> nn.Module:
1276
        return MiniCPMForCausalLM(vllm_config=vllm_config, prefix=prefix)
Jee Jee Li's avatar
Jee Jee Li committed
1277

1278
1279
1280
    def init_vision_module(
        self,
        config: PretrainedConfig,
1281
        quant_config: QuantizationConfig | None,
1282
        prefix: str = "",
1283
    ) -> nn.Module:
1284
        # TODO: refactor vision model through timm wrapper from transformers
Jee Jee Li's avatar
Jee Jee Li committed
1285
1286
1287
1288
        try:
            import timm
        except ImportError:
            raise ImportError("Please install timm==0.9.10") from ImportError
1289

Jee Jee Li's avatar
Jee Jee Li committed
1290
1291
1292
1293
1294
1295
1296
1297
1298
        with set_default_torch_dtype(torch.float16):
            model = timm.create_model(
                "vit_so400m_patch14_siglip_384.webli",
                pretrained=False,
                num_classes=0,
                dynamic_img_size=True,
                dynamic_img_pad=True,
            )

1299
1300
        model = model.to(dtype=torch.get_default_dtype())

1301
1302
1303
1304
        if (
            isinstance(model, timm.models.VisionTransformer)
            and model.attn_pool is not None
        ):
Jee Jee Li's avatar
Jee Jee Li committed
1305
1306
1307
1308
1309
1310
1311
            model.attn_pool = torch.nn.Identity()

        if self.config.drop_vision_last_layer:
            model.blocks = model.blocks[:-1]

        return model

1312
1313
1314
1315
    def init_resampler(
        self,
        embed_dim: int,
        vision_dim: int,
1316
        quant_config: QuantizationConfig | None = None,
1317
1318
        prefix: str = "",
    ) -> nn.Module:
Jee Jee Li's avatar
Jee Jee Li committed
1319
        with set_default_torch_dtype(torch.float16):
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
            resampler = Resampler2(
                embed_dim=embed_dim,
                num_heads=embed_dim // 128,
                grid_size=int(math.sqrt(self.config.query_num)),
                kv_dim=vision_dim,
                adaptive=False,
                do_post_projection=True,
                quant_config=quant_config,
                prefix=prefix,
            )

        return resampler.to(
            device=current_platform.device_type, dtype=torch.get_default_dtype()
        )

    def get_vision_hidden_states(self, data: MiniCPMVImagePixelInputs) -> torch.Tensor:
1336
1337
1338
1339
1340
1341
1342
        pixel_values = data["pixel_values"]

        P_h, P_w = self.vpm.patch_embed.patch_size
        dtype: torch.dtype = self.vpm.pos_embed.data.dtype
        num_prefix_tokens = getattr(self.vpm, "num_prefix_tokens", 0)

        res = list[torch.Tensor]()
Jee Jee Li's avatar
Jee Jee Li committed
1343
1344
        for pixel_value in pixel_values:
            H, W = pixel_value[0].shape[-2:]
1345
            tgt_size = (math.ceil(H / P_h), math.ceil(W / P_w))
Jee Jee Li's avatar
Jee Jee Li committed
1346
            vision_embedding = self.vpm.forward_features(
1347
1348
                pixel_value.unsqueeze(0).type(dtype)
            )
Jee Jee Li's avatar
Jee Jee Li committed
1349

1350
1351
1352
            if num_prefix_tokens > 0:
                vision_embedding = vision_embedding[:, num_prefix_tokens:]
            res.append(self.resampler(vision_embedding, tgt_size))
Jee Jee Li's avatar
Jee Jee Li committed
1353

1354
        return torch.vstack(res)
Jee Jee Li's avatar
Jee Jee Li committed
1355
1356


1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
class MiniCPMV2_5(MiniCPMVBaseModel, SupportsLoRA):
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
        "gate_up_proj": [
            "gate_proj",
            "up_proj",
        ],
    }
Jee Jee Li's avatar
Jee Jee Li committed
1369

1370
1371
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__(vllm_config=vllm_config, prefix=prefix)
Jee Jee Li's avatar
Jee Jee Li committed
1372
1373
1374
1375
        assert self.version == (2, 5)

    def init_llm(
        self,
1376
        vllm_config: VllmConfig,
1377
        prefix: str = "",
Jee Jee Li's avatar
Jee Jee Li committed
1378
    ) -> nn.Module:
1379
        return LlamaForCausalLM(vllm_config=vllm_config, prefix=prefix)
Jee Jee Li's avatar
Jee Jee Li committed
1380

1381
1382
1383
    def init_vision_module(
        self,
        config: PretrainedConfig,
1384
        quant_config: QuantizationConfig | None,
1385
        prefix: str = "",
1386
    ) -> nn.Module:
1387
1388
1389
1390
1391
1392
        model = Idefics2VisionTransformer(
            config.vision_config,
            quant_config=quant_config,
            prefix=prefix,
            use_data_parallel=self.use_data_parallel,
        )
Jee Jee Li's avatar
Jee Jee Li committed
1393
1394
1395
1396
        if self.config.drop_vision_last_layer:
            model.encoder.layers = model.encoder.layers[:-1]
        return model

1397
1398
1399
1400
    def init_resampler(
        self,
        embed_dim: int,
        vision_dim: int,
1401
        quant_config: QuantizationConfig | None = None,
1402
1403
        prefix: str = "",
    ) -> nn.Module:
Jee Jee Li's avatar
Jee Jee Li committed
1404
        with set_default_torch_dtype(torch.float16):
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
            resampler = Resampler2_5(
                num_queries=self.config.query_num,
                embed_dim=embed_dim,
                num_heads=embed_dim // 128,
                kv_dim=vision_dim,
                quant_config=quant_config,
                prefix=prefix,
            )

        return resampler.to(
            device=current_platform.device_type, dtype=torch.get_default_dtype()
        )

    def get_vision_hidden_states(self, data: MiniCPMVImagePixelInputs) -> torch.Tensor:
1419
        pixel_values = data["pixel_values"]
Jee Jee Li's avatar
Jee Jee Li committed
1420
1421
        tgt_sizes = data["tgt_sizes"]

1422
1423
1424
1425
1426
        B = len(pixel_values)
        P = pixel_values[0].shape[-2]
        L = max(item.shape[-1] for item in pixel_values)
        device = pixel_values[0].device
        dtype = pixel_values[0].dtype
Jee Jee Li's avatar
Jee Jee Li committed
1427

1428
        all_pixel_values = torch.zeros((B, 3, P, L), dtype=dtype, device=device)
1429
1430
1431
        for i, pixel_values_item in enumerate(pixel_values):
            L_item = pixel_values_item.shape[-1]
            all_pixel_values[i, ..., :L_item] = pixel_values_item
Jee Jee Li's avatar
Jee Jee Li committed
1432

1433
1434
1435
        num_patches = tgt_sizes.prod(-1)
        max_patches = num_patches.max().item()
        assert isinstance(max_patches, int)
Jee Jee Li's avatar
Jee Jee Li committed
1436

1437
        patch_attn_mask = torch.zeros((B, max_patches), dtype=torch.bool, device=device)
1438
1439
        for i, num_patches_item in enumerate(num_patches):
            patch_attn_mask[i, :num_patches_item] = True
Jee Jee Li's avatar
Jee Jee Li committed
1440

1441
1442
1443
1444
1445
1446
1447
        vision_embedding = self.vpm(
            all_pixel_values,
            patch_attention_mask=patch_attn_mask.unsqueeze(1),
            tgt_sizes=None,
        )

        return self.resampler(vision_embedding, tgt_sizes)
Jee Jee Li's avatar
Jee Jee Li committed
1448
1449


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
class MiniCPMV2_6(MiniCPMVBaseModel, SupportsLoRA):
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
        "gate_up_proj": [
            "gate_proj",
            "up_proj",
        ],
    }
Jee Jee Li's avatar
Jee Jee Li committed
1462

1463
1464
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__(vllm_config=vllm_config, prefix=prefix)
1465
        assert self.version == (2, 6)
Jee Jee Li's avatar
Jee Jee Li committed
1466
1467
1468

    def init_llm(
        self,
1469
        vllm_config: VllmConfig,
1470
        prefix: str = "",
Jee Jee Li's avatar
Jee Jee Li committed
1471
    ) -> nn.Module:
1472
        return Qwen2ForCausalLM(vllm_config=vllm_config, prefix=prefix)
Jee Jee Li's avatar
Jee Jee Li committed
1473

1474
1475
1476
    def init_vision_module(
        self,
        config: PretrainedConfig,
1477
        quant_config: QuantizationConfig | None = None,
1478
        prefix: str = "",
1479
    ) -> nn.Module:
1480
1481
1482
1483
1484
1485
        model = Idefics2VisionTransformer(
            config.vision_config,
            quant_config=quant_config,
            prefix=prefix,
            use_data_parallel=self.use_data_parallel,
        )
Jee Jee Li's avatar
Jee Jee Li committed
1486
1487
1488
1489
        if self.config.drop_vision_last_layer:
            model.encoder.layers = model.encoder.layers[:-1]
        return model

1490
1491
1492
1493
    def init_resampler(
        self,
        embed_dim: int,
        vision_dim: int,
1494
        quant_config: QuantizationConfig | None = None,
1495
1496
        prefix: str = "",
    ) -> nn.Module:
Jee Jee Li's avatar
Jee Jee Li committed
1497
        with set_default_torch_dtype(torch.float16):
1498
            # The resampler in 2.6 remains consistent with the one in 2.5.
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
            resampler = Resampler2_5(
                num_queries=self.config.query_num,
                embed_dim=embed_dim,
                num_heads=embed_dim // 128,
                kv_dim=vision_dim,
                quant_config=quant_config,
                prefix=prefix,
            )

        return resampler.to(
            device=current_platform.device_type, dtype=torch.get_default_dtype()
        )

    def get_vision_hidden_states(self, data: MiniCPMVImagePixelInputs) -> torch.Tensor:
1513
        pixel_values = data["pixel_values"]
Jee Jee Li's avatar
Jee Jee Li committed
1514
1515
        tgt_sizes = data["tgt_sizes"]

1516
1517
1518
1519
1520
        B = len(pixel_values)
        P = pixel_values[0].shape[-2]
        L = max(item.shape[-1] for item in pixel_values)
        device = pixel_values[0].device
        dtype = pixel_values[0].dtype
Jee Jee Li's avatar
Jee Jee Li committed
1521

1522
        all_pixel_values = torch.zeros((B, 3, P, L), dtype=dtype, device=device)
1523
1524
1525
        for i, pixel_values_item in enumerate(pixel_values):
            L_item = pixel_values_item.shape[-1]
            all_pixel_values[i, ..., :L_item] = pixel_values_item
Jee Jee Li's avatar
Jee Jee Li committed
1526

1527
1528
1529
        num_patches = tgt_sizes.prod(-1)
        max_patches = num_patches.max().item()
        assert isinstance(max_patches, int)
Jee Jee Li's avatar
Jee Jee Li committed
1530

1531
        patch_attn_mask = torch.zeros((B, max_patches), dtype=torch.bool, device=device)
1532
1533
1534
        for i, num_patches_item in enumerate(num_patches):
            patch_attn_mask[i, :num_patches_item] = True

Jee Jee Li's avatar
Jee Jee Li committed
1535
        vision_embedding = self.vpm(
1536
1537
            all_pixel_values,
            patch_attention_mask=patch_attn_mask.unsqueeze(1),
Jee Jee Li's avatar
Jee Jee Li committed
1538
            tgt_sizes=tgt_sizes,
1539
        )
Jee Jee Li's avatar
Jee Jee Li committed
1540
1541
1542

        return self.resampler(vision_embedding, tgt_sizes)

1543
1544
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
        loader = AutoWeightsLoader(self, skip_prefixes=["apm.", "audio", "tts"])
tc-mb's avatar
tc-mb committed
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
        return loader.load_weights(weights)


class MiniCPMV4_0(MiniCPMVBaseModel, SupportsLoRA):
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
        "gate_up_proj": [
            "gate_proj",
            "up_proj",
        ],
    }

    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__(vllm_config=vllm_config, prefix=prefix)
        assert self.version == (4, 0)

    def _maybe_ignore_quant_config(self, quant_config: QuantizationConfig):
        if isinstance(quant_config, (AWQConfig, AWQMarlinConfig)):
            return None
        return quant_config

    def init_llm(
        self,
        vllm_config: VllmConfig,
        prefix: str = "",
    ) -> nn.Module:
        return LlamaForCausalLM(vllm_config=vllm_config, prefix=prefix)

    def init_vision_module(
        self,
        config: PretrainedConfig,
1580
        quant_config: QuantizationConfig | None = None,
tc-mb's avatar
tc-mb committed
1581
1582
1583
        prefix: str = "",
    ) -> nn.Module:
        quant_config = self._maybe_ignore_quant_config(quant_config)
1584
1585
1586
1587
1588
1589
        model = Idefics2VisionTransformer(
            config.vision_config,
            quant_config=quant_config,
            prefix=prefix,
            use_data_parallel=self.use_data_parallel,
        )
tc-mb's avatar
tc-mb committed
1590
1591
1592
1593
1594
1595
1596
1597
        if self.config.drop_vision_last_layer:
            model.encoder.layers = model.encoder.layers[:-1]
        return model

    def init_resampler(
        self,
        embed_dim: int,
        vision_dim: int,
1598
        quant_config: QuantizationConfig | None = None,
tc-mb's avatar
tc-mb committed
1599
1600
1601
1602
1603
        prefix: str = "",
    ) -> nn.Module:
        quant_config = self._maybe_ignore_quant_config(quant_config)
        with set_default_torch_dtype(torch.float16):
            # The resampler in 4.0 remains consistent with the one in 2.5/2.6.
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
            resampler = Resampler2_5(
                num_queries=self.config.query_num,
                embed_dim=embed_dim,
                num_heads=embed_dim // 128,
                kv_dim=vision_dim,
                quant_config=quant_config,
                prefix=prefix,
            )

        return resampler.to(
            device=current_platform.device_type, dtype=torch.get_default_dtype()
        )

    def get_vision_hidden_states(self, data: MiniCPMVImagePixelInputs) -> torch.Tensor:
tc-mb's avatar
tc-mb committed
1618
1619
1620
1621
1622
1623
1624
1625
1626
        pixel_values = data["pixel_values"]
        tgt_sizes = data["tgt_sizes"]

        B = len(pixel_values)
        P = pixel_values[0].shape[-2]
        L = max(item.shape[-1] for item in pixel_values)
        device = pixel_values[0].device
        dtype = pixel_values[0].dtype

1627
        all_pixel_values = torch.zeros((B, 3, P, L), dtype=dtype, device=device)
tc-mb's avatar
tc-mb committed
1628
1629
1630
1631
1632
1633
1634
1635
        for i, pixel_values_item in enumerate(pixel_values):
            L_item = pixel_values_item.shape[-1]
            all_pixel_values[i, ..., :L_item] = pixel_values_item

        num_patches = tgt_sizes.prod(-1)
        max_patches = num_patches.max().item()
        assert isinstance(max_patches, int)

1636
        patch_attn_mask = torch.zeros((B, max_patches), dtype=torch.bool, device=device)
tc-mb's avatar
tc-mb committed
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
        for i, num_patches_item in enumerate(num_patches):
            patch_attn_mask[i, :num_patches_item] = True

        vision_embedding = self.vpm(
            all_pixel_values,
            patch_attention_mask=patch_attn_mask.unsqueeze(1),
            tgt_sizes=tgt_sizes,
        )

        return self.resampler(vision_embedding, tgt_sizes)

1648
1649
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
        loader = AutoWeightsLoader(self, skip_prefixes=["apm.", "audio", "tts"])
tc-mb's avatar
tc-mb committed
1650
1651
        return loader.load_weights(weights)

Jee Jee Li's avatar
Jee Jee Li committed
1652

tc-mb's avatar
tc-mb committed
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
class MiniCPMV4_5(MiniCPMVBaseModel, SupportsLoRA):
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
        "gate_up_proj": [
            "gate_proj",
            "up_proj",
        ],
    }

    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__(vllm_config=vllm_config, prefix=prefix)
        assert self.version == (4, 5)

    def _maybe_ignore_quant_config(self, quant_config: QuantizationConfig):
        if isinstance(quant_config, (AWQConfig, AWQMarlinConfig)):
            return None
        return quant_config

    def init_llm(
        self,
        vllm_config: VllmConfig,
        prefix: str = "",
    ) -> nn.Module:
        return Qwen3ForCausalLM(vllm_config=vllm_config, prefix=prefix)

    def init_vision_module(
        self,
        config: PretrainedConfig,
1685
        quant_config: QuantizationConfig | None = None,
tc-mb's avatar
tc-mb committed
1686
1687
1688
        prefix: str = "",
    ) -> nn.Module:
        quant_config = self._maybe_ignore_quant_config(quant_config)
1689
1690
1691
1692
1693
1694
        model = Idefics2VisionTransformer(
            config.vision_config,
            quant_config=quant_config,
            prefix=prefix,
            use_data_parallel=self.use_data_parallel,
        )
tc-mb's avatar
tc-mb committed
1695
1696
1697
1698
1699
1700
1701
1702
        if self.config.drop_vision_last_layer:
            model.encoder.layers = model.encoder.layers[:-1]
        return model

    def init_resampler(
        self,
        embed_dim: int,
        vision_dim: int,
1703
        quant_config: QuantizationConfig | None = None,
tc-mb's avatar
tc-mb committed
1704
1705
1706
1707
1708
        prefix: str = "",
    ) -> nn.Module:
        quant_config = self._maybe_ignore_quant_config(quant_config)
        with set_default_torch_dtype(torch.float16):
            # The resampler in 4.0 remains consistent with the one in 2.5/2.6.
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
            resampler = Resampler4_5(
                num_queries=self.config.query_num,
                embed_dim=embed_dim,
                num_heads=embed_dim // 128,
                kv_dim=vision_dim,
                quant_config=quant_config,
                prefix=prefix,
            )

        return resampler.to(
            device=current_platform.device_type, dtype=torch.get_default_dtype()
        )

    def get_vision_hidden_states(self, data: MiniCPMVImagePixelInputs) -> torch.Tensor:
tc-mb's avatar
tc-mb committed
1723
1724
        pixel_values = data["pixel_values"]
        tgt_sizes = data["tgt_sizes"]
1725
        temporal_ids = data.get("temporal_ids", None)
tc-mb's avatar
tc-mb committed
1726
1727
1728
1729
1730
1731
1732

        B = len(pixel_values)
        P = pixel_values[0].shape[-2]
        L = max(item.shape[-1] for item in pixel_values)
        device = pixel_values[0].device
        dtype = pixel_values[0].dtype

1733
1734
1735
1736
        all_pixel_values = torch.zeros((B, 3, P, L), dtype=dtype, device=device)
        all_temporal_ids = (
            None if temporal_ids is None else flatten_2d_lists(temporal_ids)
        )
tc-mb's avatar
tc-mb committed
1737
1738
1739
1740
1741
1742
1743
1744
        for i, pixel_values_item in enumerate(pixel_values):
            L_item = pixel_values_item.shape[-1]
            all_pixel_values[i, ..., :L_item] = pixel_values_item

        num_patches = tgt_sizes.prod(-1)
        max_patches = num_patches.max().item()
        assert isinstance(max_patches, int)

1745
        patch_attn_mask = torch.zeros((B, max_patches), dtype=torch.bool, device=device)
tc-mb's avatar
tc-mb committed
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
        for i, num_patches_item in enumerate(num_patches):
            patch_attn_mask[i, :num_patches_item] = True

        vision_embedding = self.vpm(
            all_pixel_values,
            patch_attention_mask=patch_attn_mask.unsqueeze(1),
            tgt_sizes=tgt_sizes,
        )

        return self.resampler(vision_embedding, tgt_sizes, all_temporal_ids)

1757
1758
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
        loader = AutoWeightsLoader(self, skip_prefixes=["apm.", "audio", "tts"])
tc-mb's avatar
tc-mb committed
1759
1760
1761
        return loader.load_weights(weights)


1762
1763
1764
_SUPPORT_VERSION = {
    (2, 0): MiniCPMV2_0,
    (2, 5): MiniCPMV2_5,
1765
    (2, 6): MiniCPMV2_6,
tc-mb's avatar
tc-mb committed
1766
    (4, 0): MiniCPMV4_0,
tc-mb's avatar
tc-mb committed
1767
    (4, 5): MiniCPMV4_5,
1768
1769
1770
}


1771
1772
1773
@MULTIMODAL_REGISTRY.register_processor(
    MiniCPMVMultiModalProcessor,
    info=MiniCPMVProcessingInfo,
1774
1775
    dummy_inputs=MiniCPMVDummyInputsBuilder,
)
1776
class MiniCPMV(MiniCPMVBaseModel, SupportsMultiModal, SupportsLoRA):
Jee Jee Li's avatar
Jee Jee Li committed
1777
1778
1779
1780
1781
    """
    Different versions of MiniCPMV use different visual encoders and LLMs,
    which is not conducive to the current integration logic of LoRA and
    bitsandbytes in vLLM. Therefore, it is necessary to separate them.
    """
1782

1783
    def __new__(cls, *, vllm_config: VllmConfig, prefix: str = ""):
1784
        config = vllm_config.model_config.hf_config
Jee Jee Li's avatar
Jee Jee Li committed
1785
1786
1787
1788
1789
1790
1791
1792
1793
        if not hasattr(config, "version"):
            if config.hidden_size == 2304 and config.query_num == 64:
                version = (2, 0)
            else:
                version = (2, 5)
        else:
            version = str(config.version).split(".")
            version = tuple([int(x) for x in version])
        # Dispatch class based on version
1794
1795
        instance_cls = _SUPPORT_VERSION.get(version)
        if instance_cls is None:
tc-mb's avatar
tc-mb committed
1796
            supported_versions = ", ".join(
1797
1798
1799
1800
1801
1802
                [f"{v[0]}.{v[1]}" for v in sorted(_SUPPORT_VERSION.keys())]
            )
            raise ValueError(
                f"Currently, MiniCPMV only supports versions "
                f"{supported_versions}. Got version: {version}"
            )
1803
1804
1805
1806
1807
1808
1809

        # quant_config references base class members,
        # so update values before init is called
        cls.packed_modules_mapping.update(instance_cls.packed_modules_mapping)
        cls.embedding_modules.update(instance_cls.embedding_modules)
        cls.embedding_padding_modules += instance_cls.embedding_padding_modules
        return instance_cls(vllm_config=vllm_config, prefix=prefix)