phi3v.py 27.7 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Copyright 2024 The vLLM team.
# Copyright 2024 Microsoft and the HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
pansicheng's avatar
pansicheng committed
17
import re
18
from collections.abc import Iterable, Mapping, Sequence
19
from typing import Any, Literal, Optional, TypedDict, Union
20
21
22

import torch
import torch.nn as nn
23
24
from transformers import (BatchFeature, CLIPVisionConfig, PretrainedConfig,
                          ProcessorMixin)
25

26
from vllm.config import VllmConfig
27
from vllm.logger import init_logger
28
from vllm.model_executor.layers.quantization import QuantizationConfig
29
30
from vllm.model_executor.layers.vocab_parallel_embedding import (
    VocabParallelEmbedding)
31
from vllm.model_executor.sampling_metadata import SamplingMetadata
32
from vllm.multimodal import MULTIMODAL_REGISTRY
33
34
from vllm.multimodal.inputs import (MultiModalDataDict, MultiModalFieldConfig,
                                    MultiModalKwargs)
35
from vllm.multimodal.parse import (ImageEmbeddingItems, ImageProcessorItems,
36
                                   ImageSize, MultiModalDataItems)
37
38
# yapf conflicts with isort for this block
# yapf: disable
39
from vllm.multimodal.processing import (BaseMultiModalProcessor,
40
                                        BaseProcessingInfo, BoundPromptUpdate,
41
                                        PlaceholderFeaturesInfo,
42
                                        PromptReplacement, PromptUpdate)
43
# yapf: enable
44
from vllm.multimodal.profiling import BaseDummyInputsBuilder
45
from vllm.sequence import IntermediateTensors
46
from vllm.utils import is_list_of
47

48
from .clip import CLIPVisionModel
49
50
from .interfaces import (MultiModalEmbeddings, SupportsMultiModal, SupportsPP,
                         SupportsQuant)
51
52
from .utils import (AutoWeightsLoader, WeightsMapper, flatten_bn,
                    init_vllm_registered_model, maybe_prefix,
53
                    merge_multimodal_embeddings)
54

55
56
logger = init_logger(__name__)

57
58
59
# Cannot find the following 2 numbers from hf config.
_IMAGE_TOKEN_ID = 32044

60
61
62
63
64
65
66
67
68
69
70
71
CLIP_VIT_LARGE_PATCH14_336_CONFIG = CLIPVisionConfig(dropout=0.0,
                                                     hidden_act="quick_gelu",
                                                     hidden_size=1024,
                                                     image_size=336,
                                                     intermediate_size=4096,
                                                     num_attention_heads=16,
                                                     num_channels=3,
                                                     num_hidden_layers=24,
                                                     patch_size=14,
                                                     projection_dim=768)


72
def _init_img_processor(hf_config: PretrainedConfig,
73
74
                        quant_config: Optional[QuantizationConfig],
                        prefix: str = "") -> CLIPVisionModel:
75
76
77
78
79
80
81
82
83
84
85
    clip_config = CLIP_VIT_LARGE_PATCH14_336_CONFIG
    layer_idx = hf_config.img_processor.get('layer_idx', -2)

    # Initialize the CLIP only up to the required feature layer
    if layer_idx < 0:
        num_hidden_layers = clip_config.num_hidden_layers + \
            layer_idx + 1
    else:
        num_hidden_layers = layer_idx + 1

    img_processor = CLIPVisionModel(
86
87
88
        clip_config,
        quant_config,
        num_hidden_layers_override=num_hidden_layers,
89
        prefix=prefix,
90
    )
91
92
93
94

    return img_processor


95
96
class Phi3VImagePixelInputs(TypedDict):
    type: Literal["pixel_values"]
97
    data: Union[torch.Tensor, list[torch.Tensor]]
98
    """
99
100
    Shape:
    `(batch_size * num_images, 1 + num_patches, num_channels, height, width)`
101

102
103
    Note that `num_patches` may be different per batch and image,
    in which case the data is passed as a list instead of a batched tensor.
104
105
106
107
    """

    image_sizes: torch.Tensor
    """
108
    Shape: `(batch_size * num_images, 2)`
109
110
111
112
113
114
115

    This should be in `(height, width)` format.
    """


class Phi3VImageEmbeddingInputs(TypedDict):
    type: Literal["image_embeds"]
116
    data: Union[torch.Tensor, list[torch.Tensor]]
117
    """Shape: `(batch_size * num_images, image_feature_size, hidden_size)`
118
119
120
121
122
123
124
125

    `hidden_size` must match the hidden size of language model backbone.
    """


Phi3VImageInputs = Union[Phi3VImagePixelInputs, Phi3VImageEmbeddingInputs]


126
127
class Phi3ImageEmbeddingBase(nn.Module):

128
    def __init__(self) -> None:
129
130
131
132
133
134
135
136
137
        super().__init__()
        self.layer_idx: int
        self.type_feature: str
        self.img_processor: CLIPVisionModel

    def get_img_features(self,
                         img_embeds: torch.FloatTensor) -> torch.FloatTensor:
        TYPE_FEATURE = self.type_feature

138
139
        # NOTE: we skip the step to select the vision feature layer since
        # this is already done inside the img_processor
140
        img_feature = self.img_processor(img_embeds)
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

        if TYPE_FEATURE == "patch":
            patch_feature = img_feature[:, 1:]
            return patch_feature

        if TYPE_FEATURE == "cls_patch":
            return img_feature

        raise NotImplementedError


# adapted from https://huggingface.co/microsoft/Phi-3-vision-128k-instruct/blob/main/image_embedding_phi3_v.py
class Phi3HDImageEmbedding(Phi3ImageEmbeddingBase):
    """Phi3 Image embedding with HD transform."""

156
157
158
159
    def __init__(self,
                 config: PretrainedConfig,
                 quant_config: Optional[QuantizationConfig],
                 prefix: str = "") -> None:
160
        super().__init__()
161
162
163
164
165

        # n_embed or hidden_size
        hidden_size = config.n_embd if hasattr(
            config, 'n_embd') else config.hidden_size

166
167
        self.img_processor = _init_img_processor(
            config, quant_config, prefix=f"{prefix}.img_processor")
168

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
        image_dim_out = config.img_processor['image_dim_out']
        self.num_img_tokens = config.img_processor['num_img_tokens']

        self.image_dim_out = image_dim_out

        # global_gn and sub_gn for hd transform, serves as line separator
        self.use_hd_transform = config.embd_layer.get('use_hd_transform',
                                                      False)
        self.with_learnable_separator = config.embd_layer.get(
            'with_learnable_separator', False)
        self.hd_transform_order = config.embd_layer.get(
            'hd_transform_order', 'glb_sub')
        # with_hd_transform and with_learnable_separator should have same value
        assert self.use_hd_transform and self.with_learnable_separator

        # 1024 * 4, merge spatial to channel dimension
        self.glb_GN = nn.Parameter(torch.empty([1, 1, self.image_dim_out * 4]))
        self.sub_GN = nn.Parameter(
            torch.empty([1, 1, 1, self.image_dim_out * 4]))

        dim_projection = hidden_size
        depth = 2
        layers = [nn.Linear(image_dim_out * 4, dim_projection)]
        for _ in range(1, depth):
            layers.extend(
                [nn.GELU(),
                 nn.Linear(dim_projection, dim_projection)])
        self.img_projection = nn.Sequential(*layers)

        self.type_feature = config.img_processor.get('type_feature', 'patch')

200
    def forward(self, pixel_values: torch.FloatTensor,
201
                image_sizes: torch.Tensor) -> torch.FloatTensor:
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
        """
        process image and return vision embeddings.

        pixel_values: (num_images, num_crops, c, h, w)
        output: (num_images, num_img_tokens, hidden_size)
        """
        num_images, num_crops, c, h, w = pixel_values.shape
        pixel_values = pixel_values.flatten(0, 1)
        img_features = self.get_img_features(pixel_values)
        img_features = img_features.reshape(num_images, num_crops, -1,
                                            self.image_dim_out)
        image_features_proj = self.hd_feature_transform(
            img_features, image_sizes)
        return image_features_proj

    def hd_feature_transform(self, image_features, image_sizes):
        """
        image_features: (num_images, num_crops+1, 24*24, 1024)
        """
        assert (
            self.hd_transform_order == 'sub_glb'
        ), f'hd_transform_order `{self.hd_transform_order}` not implemented'
        if isinstance(self.img_projection, nn.Sequential):
            target_device = self.img_projection[0].bias.device
            target_dtype = self.img_projection[0].bias.dtype
        else:  # It's a single nn.Linear layer
            target_device = self.img_projection.bias.device
            target_dtype = self.img_projection.bias.dtype

        global_image_features = image_features[:,
                                               0]  # (num_images, 24*24, 1024)
        # global feature can be viewed as a special HD case with num_crops 1x1
        global_image_features_hd = self.reshape_hd_patches_2x2merge(
            global_image_features, 1, 1)
        global_image_features_hd_newline = self.add_image_newline(
            global_image_features_hd)

239
        batch_image_features_proj = []
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
        # need a for loop to process each image because of different image sizes
        # (patch arrangement is different for each image)
        for i, img_size in enumerate(image_sizes):
            h, w = img_size
            h_crop = h // 336
            w_crop = w // 336
            num_crops = h_crop * w_crop

            # NOTE: real num_crops is padded
            # (num_crops, 24*24, 1024)
            sub_image_features = image_features[i, 1:1 + num_crops]
            sub_image_features_hd = self.reshape_hd_patches_2x2merge(
                sub_image_features, h_crop, w_crop)
            sub_image_features_hd_newline = self.add_image_newline(
                sub_image_features_hd)

            # [sub features, separator, global features]
257
258
259
260
261
262
263
264
265
266
267
            image_embeddings = torch.cat([
                sub_image_features_hd_newline.squeeze(
                    0),  # (h_crop*12*(w_crop*12+1), 4096)
                self.glb_GN.squeeze(0),
                global_image_features_hd_newline[i],
            ])
            img_proj = self.img_projection(
                image_embeddings.to(target_device, target_dtype))
            batch_image_features_proj.append(img_proj)

        return batch_image_features_proj
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

    def reshape_hd_patches_2x2merge(self, image_features, h_crop, w_crop):
        """
        image_features: (num_images*num_crops, 24*24, 1024)
        output: (num_images, h_crop*12, w_crop*12, 4096)
        where h_crop*w_crop == num_crops
        """
        N, L, C = image_features.shape
        assert L == 576 and C == 1024 and N % (h_crop * w_crop) == 0
        num_images = N // (h_crop * w_crop)
        H = int(L**0.5)
        image_features_hd = (
            image_features.reshape(N, H, H, C)  # N, 24, 24, 1024
            .reshape(N, H // 2, 2, H // 2, 2, C)  # N, 12, 2, 12, 2, 1024
            .permute(0, 1, 3, 2, 4, 5)  # N, 12, 12, 2, 2, 1024
            .reshape(N, -1, 4 * C)  # N, 144, 4096
            .reshape(num_images, h_crop, w_crop, H // 2, H // 2,
                     -1)  # n_img, h_crop, w_crop, 12, 12, 4096
            .permute(0, 1, 3, 2, 4, 5)  # n_img, h_crop, 12, w_crop, 12, 4096
            .reshape(num_images, h_crop * H // 2, w_crop * H // 2,
                     4 * C)  # n_img, h_crop*12, w_crop*12, 4096
        )
        return image_features_hd

    def add_image_newline(self, image_features_hd):
        """
        image_features_hd: (num_images, h_crop*12, w_crop*12, 4096)
        output: (num_images, (h_crop*12) * (w_crop*12+1), 4096)
        """
        num_images, h, w, hid_dim = image_features_hd.shape
        # add the newline token to the HD image feature patches
        newline_embeddings = self.sub_GN.expand(num_images, h, -1,
                                                -1)  # (n_img, h, 1, hid_dim)
        image_features_hd_newline = torch.cat(
            [image_features_hd, newline_embeddings],
            dim=2).reshape(num_images, -1, hid_dim)
        return image_features_hd_newline
305
306


307
class Phi3VProcessingInfo(BaseProcessingInfo):
308

309
    def get_hf_processor(
310
311
312
        self,
        *,
        num_crops: Optional[int] = None,
313
        **kwargs: object,
314
315
    ) -> ProcessorMixin:
        if num_crops is not None:
316
            kwargs["num_crops"] = num_crops
317

318
        return self.ctx.get_hf_processor(**kwargs)
319

320
321
322
    def get_supported_mm_limits(self) -> Mapping[str, Optional[int]]:
        return {"image": None}

323
324
325
326
327
    def get_num_image_tokens(
        self,
        *,
        image_width: int,
        image_height: int,
328
        processor: Optional[ProcessorMixin] = None,
329
330
331
332
333
334
335
336
337
338
    ) -> int:
        if processor is None:
            processor = self.get_hf_processor()

        return processor.calc_num_image_tokens_from_image_size(  # type: ignore
            width=image_width,
            height=image_height,
        )

    def get_image_size_with_most_features(self) -> ImageSize:
339
340
341
        # Result in the max possible feature size (h:w = 16:1)
        return ImageSize(height=8000, width=50)

342
343
344

class Phi3VDummyInputsBuilder(BaseDummyInputsBuilder[Phi3VProcessingInfo]):

345
346
347
348
349
350
351
352
353
    def get_dummy_text(self, mm_counts: Mapping[str, int]) -> str:
        num_images = mm_counts.get("image", 0)

        hf_processor = self.info.get_hf_processor()
        image_tokens: list[str] = hf_processor.img_tokens  # type: ignore

        return "".join(image_tokens[:num_images])

    def get_dummy_mm_data(
354
        self,
355
356
        seq_len: int,
        mm_counts: Mapping[str, int],
357
    ) -> MultiModalDataDict:
358
        num_images = mm_counts.get("image", 0)
359

360
361
        target_width, target_height = \
            self.info.get_image_size_with_most_features()
362

363
        return {
364
365
366
367
368
369
370
            "image":
            self._get_dummy_images(width=target_width,
                                   height=target_height,
                                   num_images=num_images)
        }


371
class Phi3VMultiModalProcessor(BaseMultiModalProcessor[Phi3VProcessingInfo]):
372

373
    def _call_hf_processor(
374
375
        self,
        prompt: str,
376
377
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
378
    ) -> BatchFeature:
379
380
        processed_outputs = super()._call_hf_processor(
            prompt=prompt,
381
382
            mm_data=mm_data,
            mm_kwargs=mm_kwargs,
383
384
        )

385
386
387
        input_ids = processed_outputs["input_ids"]
        assert isinstance(input_ids, torch.Tensor)

388
389
390
        # Phi3v processor has inserted -1, -2 etc as placeholder in prompt_ids,
        # which will cause OverflowError when decoding the prompt_ids.
        # Therefore, we need to do an early replacement here
391
        input_ids.masked_fill_(input_ids < 0, _IMAGE_TOKEN_ID)
392

393
394
        return processed_outputs

395
396
397
398
399
400
401
402
403
404
405
    def _get_mm_fields_config(
        self,
        hf_inputs: BatchFeature,
        hf_processor_mm_kwargs: Mapping[str, object],
    ) -> Mapping[str, MultiModalFieldConfig]:
        return dict(
            pixel_values=MultiModalFieldConfig.batched("image"),
            image_sizes=MultiModalFieldConfig.batched("image"),
            image_embeds=MultiModalFieldConfig.batched("image"),
        )

406
    def _get_prompt_updates(
407
408
        self,
        mm_items: MultiModalDataItems,
409
        hf_processor_mm_kwargs: Mapping[str, Any],
410
        out_mm_kwargs: MultiModalKwargs,
411
    ) -> Sequence[PromptUpdate]:
412
        hf_processor = self.info.get_hf_processor(**hf_processor_mm_kwargs)
413
414
415
        image_tokens: list[str] = hf_processor.img_tokens  # type: ignore

        def get_replacement_phi3v(item_idx: int):
416
417
418
419
420
421
422
            images = mm_items.get_items(
                "image", (ImageEmbeddingItems, ImageProcessorItems))

            if isinstance(images, ImageEmbeddingItems):
                num_image_tokens = images.get_feature_size(item_idx)
            else:
                image_size = images.get_image_size(item_idx)
423
                num_image_tokens = self.info.get_num_image_tokens(
424
425
                    image_width=image_size.width,
                    image_height=image_size.height,
426
                    processor=hf_processor,
427
428
                )

429
            return [_IMAGE_TOKEN_ID] * num_image_tokens
430

431
432
        num_images = mm_items.get_count("image", strict=False)

433
434
435
436
437
        return [
            PromptReplacement(
                modality="image",
                target=image_token,
                replacement=get_replacement_phi3v,
438
            ) for image_token in image_tokens[:num_images]
439
440
        ]

441
    def _apply_prompt_updates(
442
443
        self,
        token_ids: list[int],
444
        mm_prompt_updates: Mapping[str, Sequence[BoundPromptUpdate]],
445
        mm_item_counts: Mapping[str, int],
446
    ) -> tuple[list[int], str, Mapping[str, list[PlaceholderFeaturesInfo]]]:
pansicheng's avatar
pansicheng committed
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
        # align to hf behavior when there are images
        if len(mm_item_counts):
            tokenizer = self.info.get_tokenizer()
            # to decode token_ids to the original text, we need to
            # 1. remove the first bos token
            # 2. remove space after each special token
            #    introduced by the tokenizer
            if len(token_ids) and token_ids[0] == tokenizer.bos_token_id:
                token_ids = token_ids[1:]
            text = tokenizer.decode(token_ids)
            for special_tokens in tokenizer.special_tokens_map.values():
                if isinstance(special_tokens, str):
                    text = text.replace(f"{special_tokens} ", special_tokens)
                elif isinstance(special_tokens, list):
                    for special_token in special_tokens:
                        text = text.replace(f"{special_token} ", special_token)
            # perform hf behavior
            # https://huggingface.co/microsoft/Phi-3.5-vision-instruct/blob/64f88b6/processing_phi3_v.py#L407
            pattern = r"<\|image_\d+\|>"
            prompt_chunks = [
                tokenizer(chunk).input_ids
                for chunk in re.split(pattern, text)
            ]
            image_tags = [
                tokenizer(chunk, add_special_tokens=False).input_ids
                for chunk in re.findall(pattern, text)
            ]
            if len(prompt_chunks) > len(image_tags):
                image_tags.append([])
            token_ids = [
                e for sublist in zip(prompt_chunks, image_tags)
                for ele in sublist for e in ele
            ]

481
        token_ids, text, placeholders = super()._apply_prompt_updates(
482
            token_ids=token_ids,
483
            mm_prompt_updates=mm_prompt_updates,
484
485
486
487
488
489
490
            mm_item_counts=mm_item_counts,
        )

        # Keep the behavior in line with HF processor
        if text.startswith("<s> <|image|>"):
            text = text.replace("<s> <|image|>", "<s><|image|>", 1)
            token_ids = [token_ids[0], *token_ids[2:]]
491
492
            placeholders = {
                modality: [
493
                    PlaceholderFeaturesInfo(
494
495
496
                        modality=p.modality,
                        item_idx=p.item_idx,
                        start_idx=p.start_idx - 1,
497
                        tokens=p.tokens,
498
                        is_embed=p.is_embed,
499
500
501
502
                    ) for p in ps
                ]
                for modality, ps in placeholders.items()
            }
503
504
505

        return token_ids, text, placeholders

506

507
508
509
@MULTIMODAL_REGISTRY.register_processor(Phi3VMultiModalProcessor,
                                        info=Phi3VProcessingInfo,
                                        dummy_inputs=Phi3VDummyInputsBuilder)
510
511
class Phi3VForCausalLM(nn.Module, SupportsMultiModal, SupportsPP,
                       SupportsQuant):
512
513
514
515
516
517
518
    hf_to_vllm_mapper = WeightsMapper(
        orig_to_new_prefix={
            "model.vision_embed_tokens.wte": "embed_tokens",
            "model.vision_embed_tokens.": "vision_embed_tokens.",
            "lm_head.": "language_model.lm_head.",
            "model.": "language_model.model.",
        })
519

520
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
521
        super().__init__()
522
523
        config = vllm_config.model_config.hf_config
        multimodal_config = vllm_config.model_config.multimodal_config
524
        self.config = config
525
        self.multimodal_config = multimodal_config
526
        self.image_token_id = _IMAGE_TOKEN_ID
527

528
529
530
531
        self.embed_tokens = VocabParallelEmbedding(
            config.vocab_size,
            config.hidden_size,
            org_num_embeddings=config.vocab_size,
532
            quant_config=self.quant_config,
533
            prefix=maybe_prefix(prefix, "model.embed_tokens"),
534
535
536
        )

        # TODO: Optionally initializes this for supporting input embeddings.
537
        self.vision_embed_tokens = Phi3HDImageEmbedding(
538
            config,
539
            self.quant_config,
540
            prefix=maybe_prefix(prefix, "model.vision_embed_tokens"))
541

542
543
544
545
546
547
548
549
550
551
552
        self.language_model = init_vllm_registered_model(
            vllm_config=vllm_config,
            # The prefix is empty intentionally because default prefix of
            # LlamaForCausalLM is "model"
            prefix="",
            # We don't directly initialize vLLM's LlamaForCausalLM so we
            # can automatically apply embedding wrapper if this model is
            # initialized as an embedding model
            architectures=["LlamaForCausalLM"],
        )

553
554
555
        self.make_empty_intermediate_tensors = (
            self.language_model.make_empty_intermediate_tensors)

556
    def _validate_image_sizes(self, data: torch.Tensor) -> torch.Tensor:
557
558
559
560
561
562
563
564
565
566
567
568
569
        expected_dims = (2, )

        def _validate_shape(d: torch.Tensor):
            actual_dims = tuple(d.shape)

            if actual_dims != expected_dims:
                expected_expr = str(expected_dims)
                raise ValueError(
                    f"The expected shape of image sizes per image per batch "
                    f"is {expected_expr}. You supplied {tuple(d.shape)}.")

        for d in data:
            _validate_shape(d)
570
571
572
573

        return data

    def _validate_pixel_values(
574
575
        self, data: Union[torch.Tensor, list[torch.Tensor]]
    ) -> Union[torch.Tensor, list[torch.Tensor]]:
576

577
578
579
580
581
582
583
584
        h = w = CLIP_VIT_LARGE_PATCH14_336_CONFIG.image_size
        expected_dims = (3, h, w)

        def _validate_shape(d: torch.Tensor):
            actual_dims = tuple(d.shape[1:])

            if actual_dims != expected_dims:
                expected_expr = ("num_patches", *map(str, expected_dims))
585
                raise ValueError(
586
                    "The expected shape of pixel values per image per batch "
587
                    f"is {expected_expr}. You supplied {tuple(d.shape)}.")
588

589
590
        for d in data:
            _validate_shape(d)
591
592
593

        return data

594
    def _parse_and_validate_image_input(
595
            self, **kwargs: object) -> Optional[Phi3VImageInputs]:
596
597
        pixel_values = kwargs.pop("pixel_values", None)
        image_sizes = kwargs.pop("image_sizes", None)
598
        image_embeds = kwargs.pop("image_embeds", None)
599

600
601
602
603
604
605
606
607
        if pixel_values is None and image_embeds is None:
            return None

        if pixel_values is not None:
            if not isinstance(pixel_values, (torch.Tensor, list)):
                raise ValueError("Incorrect type of pixel values. "
                                 f"Got type: {type(pixel_values)}")

608
            if not isinstance(image_sizes, (torch.Tensor, list)):
609
610
611
612
613
                raise ValueError("Incorrect type of image sizes. "
                                 f"Got type: {type(image_sizes)}")

            return Phi3VImagePixelInputs(
                type="pixel_values",
614
615
616
                data=self._validate_pixel_values(flatten_bn(pixel_values)),
                image_sizes=self._validate_image_sizes(
                    flatten_bn(image_sizes, concat=True)))
617
618
619
620
621

        if image_embeds is not None:
            if not isinstance(image_embeds, torch.Tensor):
                raise ValueError("Incorrect type of image embeddings. "
                                 f"Got type: {type(image_embeds)}")
622

623
624
            return Phi3VImageEmbeddingInputs(
                type="image_embeds",
625
                data=flatten_bn(image_embeds),
626
627
628
629
630
631
632
633
634
635
            )

        raise AssertionError("This line should be unreachable.")

    def _process_image_input(
        self,
        image_input: Phi3VImageInputs,
    ) -> torch.Tensor:

        if image_input["type"] == "image_embeds":
636
637
638
639
640
641
642
643
            image_data = image_input["data"]
            if is_list_of(image_data, torch.Tensor):
                # it's already a list of tensors
                return image_data
            if len(image_data.shape) == 3:
                # 3D tensor
                return list(torch.unbind(image_data, dim=0))
            raise ValueError(
644
                "We expect batched 2D tensors; "
645
646
                "this can be either a list of 2D tensors or a single 3D tensor."
            )
647

648
649
650
        assert self.vision_embed_tokens is not None
        image_embeds = self.vision_embed_tokens(image_input["data"],
                                                image_input["image_sizes"])
651

652
        return image_embeds
653

654
655
656
    def get_language_model(self) -> torch.nn.Module:
        return self.language_model

657
    def get_multimodal_embeddings(
658
            self, **kwargs: object) -> Optional[MultiModalEmbeddings]:
659
660
661
662
663
664
665
666
667
        image_input = self._parse_and_validate_image_input(**kwargs)
        if image_input is None:
            return None
        vision_embeddings = self._process_image_input(image_input)
        return vision_embeddings

    def get_input_embeddings(
        self,
        input_ids: torch.Tensor,
668
        multimodal_embeddings: Optional[MultiModalEmbeddings] = None,
669
670
    ) -> torch.Tensor:
        inputs_embeds = self.embed_tokens(input_ids)
671
        if multimodal_embeddings is not None:
672
            inputs_embeds = merge_multimodal_embeddings(
673
                input_ids, inputs_embeds, multimodal_embeddings,
674
675
676
                self.image_token_id)
        return inputs_embeds

677
678
679
680
    def forward(self,
                input_ids: torch.Tensor,
                positions: torch.Tensor,
                intermediate_tensors: Optional[IntermediateTensors] = None,
681
                inputs_embeds: Optional[torch.Tensor] = None,
682
                **kwargs: object):
683

684
        if intermediate_tensors is not None:
685
            inputs_embeds = None
686
687
688

        # NOTE: In v1, inputs_embeds is always generated at model runner, this
        # condition is for v0 compatibility
689
        elif inputs_embeds is None:
690
            vision_embeddings = self.get_multimodal_embeddings(**kwargs)
691
692
693
            inputs_embeds = self.get_input_embeddings(input_ids,
                                                      vision_embeddings)
            input_ids = None
694

695
696
697
698
        hidden_states = self.language_model.model(input_ids,
                                                  positions,
                                                  intermediate_tensors,
                                                  inputs_embeds=inputs_embeds)
699
700
701

        return hidden_states

702
703
704
705
706
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[torch.Tensor]:
707
708
        return self.language_model.compute_logits(hidden_states,
                                                  sampling_metadata)
709

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

        loader = AutoWeightsLoader(self)
714
        autoloaded_weights = loader.load_weights(weights,
715
                                                 mapper=self.hf_to_vllm_mapper)
716
717
718

        # The HF config doesn't specify whether these are tied,
        # so we detect it this way
719
        if "embed_tokens.weight" not in autoloaded_weights:
720
            self.embed_tokens = self.language_model.model.embed_tokens
721
722
            autoloaded_weights.add("embed_tokens.weight")
        return autoloaded_weights