phi3v.py 26.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 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.
15
from collections.abc import Iterable, Mapping, Sequence
16
from functools import cached_property
17
from typing import List, Literal, Optional, Set, Tuple, TypedDict, Union
18
19
20

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

from vllm.attention import AttentionMetadata
25
from vllm.config import VllmConfig
26
from vllm.logger import init_logger
27
from vllm.model_executor.layers.quantization import QuantizationConfig
Joe Runde's avatar
Joe Runde committed
28
from vllm.model_executor.layers.sampler import SamplerOutput, get_sampler
29
30
from vllm.model_executor.layers.vocab_parallel_embedding import (
    VocabParallelEmbedding)
31
from vllm.model_executor.models.clip import CLIPVisionModel
32
from vllm.model_executor.sampling_metadata import SamplingMetadata
33
from vllm.multimodal import MULTIMODAL_REGISTRY
34
35
36
from vllm.multimodal.inputs import (MultiModalDataDict, MultiModalFieldConfig,
                                    MultiModalInputsV2, MultiModalKwargs,
                                    NestedTensors, PlaceholderRange)
37
from vllm.multimodal.parse import ImageEmbeddingItems, ImageProcessorItems
38
from vllm.multimodal.processing import (BaseMultiModalProcessor,
39
40
                                        MultiModalDataItems, ProcessorInputs,
                                        PromptReplacement,
41
42
                                        _BoundPromptReplacement,
                                        _PlaceholderInfo)
43
from vllm.sequence import IntermediateTensors
44
from vllm.utils import is_list_of
45

46
from .clip import dummy_image_for_clip
47
from .interfaces import SupportsMultiModal, SupportsPP
48
49
from .utils import (AutoWeightsLoader, WeightsMapper, flatten_bn,
                    init_vllm_registered_model, maybe_prefix,
50
                    merge_multimodal_embeddings)
51

52
53
logger = init_logger(__name__)

54
55
56
# Cannot find the following 2 numbers from hf config.
_IMAGE_TOKEN_ID = 32044

57
58
59
60
# Result in the max possible feature size (h:w = 16:1)
MAX_IMAGE_FEATURE_SIZE_HEIGHT = 8000
MAX_IMAGE_FEATURE_SIZE_WIDTH = 50

61
62
63
64
65
66
67
68
69
70
71
72
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)


73
def _init_img_processor(hf_config: PretrainedConfig,
74
75
                        quant_config: Optional[QuantizationConfig],
                        prefix: str = "") -> CLIPVisionModel:
76
77
78
79
80
81
82
83
84
85
86
    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(
87
88
89
        clip_config,
        quant_config,
        num_hidden_layers_override=num_hidden_layers,
90
        prefix=prefix,
91
    )
92
93
94
95

    return img_processor


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

103
104
    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.
105
106
107
108
    """

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

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


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

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


Phi3VImageInputs = Union[Phi3VImagePixelInputs, Phi3VImageEmbeddingInputs]


127
128
class Phi3ImageEmbeddingBase(nn.Module):

129
    def __init__(self) -> None:
130
131
132
133
134
135
136
137
138
        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

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

        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."""

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

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

167
168
        self.img_processor = _init_img_processor(
            config, quant_config, prefix=f"{prefix}.img_processor")
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
200
        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')

201
    def forward(self, pixel_values: torch.FloatTensor,
202
                image_sizes: torch.Tensor) -> torch.FloatTensor:
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
        """
        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)

240
        batch_image_features_proj = []
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
        # 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]
258
259
260
261
262
263
264
265
266
267
268
            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
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
305

    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
306
307


308
class Phi3VMultiModalProcessor(BaseMultiModalProcessor):
309

310
311
    def get_supported_mm_limits(self) -> Mapping[str, Optional[int]]:
        return {"image": None}
312

313
314
315
316
317
318
319
320
321
322
323
324
    def _get_num_image_tokens(
        self,
        *,
        image_width: int,
        image_height: int,
    ) -> int:
        processor = self._get_hf_processor()

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

326
327
328
329
330
    def get_mm_max_tokens_per_item(self) -> Mapping[str, int]:
        max_image_tokens = self._get_num_image_tokens(
            image_width=MAX_IMAGE_FEATURE_SIZE_WIDTH,
            image_height=MAX_IMAGE_FEATURE_SIZE_HEIGHT,
        )
331

332
        return {"image": max_image_tokens}
333

334
335
336
337
338
339
340
    def _get_hf_processor(
        self,
        *,
        num_crops: Optional[int] = None,
    ) -> ProcessorMixin:
        if num_crops is not None:
            return self.ctx.get_hf_processor(num_crops=num_crops)
341

342
343
        return self.ctx.get_hf_processor()

344
    def _call_hf_processor(
345
346
        self,
        prompt: str,
347
348
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
349
    ) -> BatchFeature:
350
351
        processed_outputs = super()._call_hf_processor(
            prompt=prompt,
352
353
            mm_data=mm_data,
            mm_kwargs=mm_kwargs,
354
355
        )

356
357
358
        input_ids = processed_outputs["input_ids"]
        assert isinstance(input_ids, torch.Tensor)

359
360
361
        # 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
362
        input_ids.masked_fill_(input_ids < 0, _IMAGE_TOKEN_ID)
363

364
365
        return processed_outputs

366
367
368
369
370
371
372
373
374
375
376
    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"),
        )

377
378
379
    def _get_prompt_replacements(
        self,
        mm_items: MultiModalDataItems,
380
381
        hf_processor_mm_kwargs: Mapping[str, object],
        out_mm_kwargs: MultiModalKwargs,
382
383
384
385
    ) -> list[PromptReplacement]:
        hf_processor = self._get_hf_processor()
        image_tokens: list[str] = hf_processor.img_tokens  # type: ignore

386
387
388
        tokenizer = self._get_tokenizer()
        bos_token_id = tokenizer.bos_token_id
        assert isinstance(bos_token_id, int)
389
390

        def get_replacement_phi3v(item_idx: int):
391
392
393
394
395
396
397
398
399
400
401
402
403
            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)
                num_image_tokens = self._get_num_image_tokens(
                    image_width=image_size.width,
                    image_height=image_size.height,
                )

            return [_IMAGE_TOKEN_ID] * num_image_tokens + [bos_token_id]
404

405
406
        num_images = mm_items.get_count("image", strict=False)

407
408
409
410
411
        return [
            PromptReplacement(
                modality="image",
                target=image_token,
                replacement=get_replacement_phi3v,
412
            ) for image_token in image_tokens[:num_images]
413
414
        ]

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
    def _apply_prompt_replacements(
        self,
        token_ids: list[int],
        prompt_repls: Sequence[_BoundPromptReplacement],
        mm_item_counts: Mapping[str, int],
    ) -> tuple[list[int], str, list[_PlaceholderInfo]]:
        token_ids, text, placeholders = super()._apply_prompt_replacements(
            token_ids=token_ids,
            prompt_repls=prompt_repls,
            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:]]
            placeholders = [
                _PlaceholderInfo(p.modality, p.start_idx - 1, p.replacement)
                for p in placeholders
            ]

        return token_ids, text, placeholders

438
    def _get_dummy_mm_inputs(
439
440
        self,
        mm_counts: Mapping[str, int],
441
    ) -> ProcessorInputs:
442
        num_images = mm_counts.get("image", 0)
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457

        data = dummy_image_for_clip(
            CLIP_VIT_LARGE_PATCH14_336_CONFIG,
            num_images,
            image_width_override=MAX_IMAGE_FEATURE_SIZE_WIDTH,
            image_height_override=MAX_IMAGE_FEATURE_SIZE_HEIGHT,
        )

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

        return ProcessorInputs(
            prompt_text="".join(image_tokens[:num_images]),
            mm_data=data,
        )
458

459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
    def apply(
        self,
        prompt_text: str,
        mm_data: MultiModalDataDict,
        hf_processor_mm_kwargs: Mapping[str, object],
    ) -> MultiModalInputsV2:
        result = super().apply(prompt_text, mm_data, hf_processor_mm_kwargs)

        # Only <|image|> tokens should be considered as placeholders,
        # so we ignore the trailing bos_token_id
        result["mm_placeholders"] = {
            modality: [
                PlaceholderRange(offset=p["offset"], length=p["length"] - 1)
                for p in ps
            ]
            for modality, ps in result["mm_placeholders"].items()
        }

        return result

479

480
@MULTIMODAL_REGISTRY.register_processor(Phi3VMultiModalProcessor)
481
class Phi3VForCausalLM(nn.Module, SupportsMultiModal, SupportsPP):
482
483
484
485
486
487
488
    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.",
        })
489

490
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
491
        super().__init__()
492
493
494
        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
        multimodal_config = vllm_config.model_config.multimodal_config
495
        self.config = config
496
        self.multimodal_config = multimodal_config
497
        self.image_token_id = _IMAGE_TOKEN_ID
498

499
500
501
502
503
        self.embed_tokens = VocabParallelEmbedding(
            config.vocab_size,
            config.hidden_size,
            org_num_embeddings=config.vocab_size,
            quant_config=quant_config,
504
            prefix=maybe_prefix(prefix, "model.embed_tokens"),
505
506
507
        )

        # TODO: Optionally initializes this for supporting input embeddings.
508
        self.vision_embed_tokens = Phi3HDImageEmbedding(
509
510
511
            config,
            quant_config,
            prefix=maybe_prefix(prefix, "model.vision_embed_tokens"))
512

513
514
515
516
517
518
519
520
521
522
523
        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"],
        )

524
525
526
527
528
529
530
531
        self.make_empty_intermediate_tensors = (
            self.language_model.make_empty_intermediate_tensors)

    @cached_property
    def sampler(self):
        if hasattr(self.language_model, "sampler"):
            return self.language_model.sampler

Joe Runde's avatar
Joe Runde committed
532
        return get_sampler()
533

534
    def _validate_image_sizes(self, data: torch.Tensor) -> torch.Tensor:
535
536
537
538
539
540
541
542
543
544
545
546
547
        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)
548
549
550
551
552
553
554

        return data

    def _validate_pixel_values(
        self, data: Union[torch.Tensor, List[torch.Tensor]]
    ) -> Union[torch.Tensor, List[torch.Tensor]]:

555
556
557
558
559
560
561
562
        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))
563
                raise ValueError(
564
                    "The expected shape of pixel values per image per batch "
565
                    f"is {expected_expr}. You supplied {tuple(d.shape)}.")
566

567
568
        for d in data:
            _validate_shape(d)
569
570
571

        return data

572
    def _parse_and_validate_image_input(
573
            self, **kwargs: object) -> Optional[Phi3VImageInputs]:
574
575
        pixel_values = kwargs.pop("pixel_values", None)
        image_sizes = kwargs.pop("image_sizes", None)
576
        image_embeds = kwargs.pop("image_embeds", None)
577

578
579
580
581
582
583
584
585
        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)}")

586
            if not isinstance(image_sizes, (torch.Tensor, list)):
587
588
589
590
591
                raise ValueError("Incorrect type of image sizes. "
                                 f"Got type: {type(image_sizes)}")

            return Phi3VImagePixelInputs(
                type="pixel_values",
592
593
594
                data=self._validate_pixel_values(flatten_bn(pixel_values)),
                image_sizes=self._validate_image_sizes(
                    flatten_bn(image_sizes, concat=True)))
595
596
597
598
599

        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)}")
600

601
602
            return Phi3VImageEmbeddingInputs(
                type="image_embeds",
603
                data=flatten_bn(image_embeds),
604
605
606
607
608
609
610
611
612
613
            )

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

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

        if image_input["type"] == "image_embeds":
614
615
616
617
618
619
620
621
622
623
624
            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(
                "We expect batched 2D tensors;"
                "this can be either a list of 2D tensors or a single 3D tensor."
            )
625

626
627
628
        assert self.vision_embed_tokens is not None
        image_embeds = self.vision_embed_tokens(image_input["data"],
                                                image_input["image_sizes"])
629

630
        return image_embeds
631

632
    def get_multimodal_embeddings(self, **kwargs) -> Optional[NestedTensors]:
633
634
635
636
637
638
639
640
641
        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,
642
        multimodal_embeddings: Optional[NestedTensors] = None,
643
644
    ) -> torch.Tensor:
        inputs_embeds = self.embed_tokens(input_ids)
645
        if multimodal_embeddings is not None:
646
            inputs_embeds = merge_multimodal_embeddings(
647
                input_ids, inputs_embeds, multimodal_embeddings,
648
649
650
                self.image_token_id)
        return inputs_embeds

651
652
653
    def forward(self,
                input_ids: torch.Tensor,
                positions: torch.Tensor,
654
                kv_caches: List[torch.Tensor],
655
656
                attn_metadata: AttentionMetadata,
                intermediate_tensors: Optional[IntermediateTensors] = None,
657
                inputs_embeds: Optional[torch.Tensor] = None,
658
                **kwargs: object):
659

660
        if intermediate_tensors is not None:
661
            inputs_embeds = None
662
663
664

        # NOTE: In v1, inputs_embeds is always generated at model runner, this
        # condition is for v0 compatibility
665
        elif inputs_embeds is None:
666
            vision_embeddings = self.get_multimodal_embeddings(**kwargs)
667
668
669
            inputs_embeds = self.get_input_embeddings(input_ids,
                                                      vision_embeddings)
            input_ids = None
670

671
672
673
674
675
676
        hidden_states = self.language_model.model(input_ids,
                                                  positions,
                                                  kv_caches,
                                                  attn_metadata,
                                                  intermediate_tensors,
                                                  inputs_embeds=inputs_embeds)
677
678
679

        return hidden_states

680
681
682
683
684
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[torch.Tensor]:
685
686
        return self.language_model.compute_logits(hidden_states,
                                                  sampling_metadata)
687
688
689
690
691
692

    def sample(
        self,
        logits: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[SamplerOutput]:
693
        return self.language_model.sample(logits, sampling_metadata)
694

695
696
    def load_weights(self, weights: Iterable[Tuple[str,
                                                   torch.Tensor]]) -> Set[str]:
697
698

        loader = AutoWeightsLoader(self)
699
        autoloaded_weights = loader.load_weights(weights,
700
                                                 mapper=self.hf_to_vllm_mapper)
701
702
703

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