"vllm/core/scheduler.py" did not exist on "721fa3df155e5649bbe2188517594f24f4e63523"
pixtral.py 46.7 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import math
5
from collections.abc import Iterable, Mapping, Sequence
Patrick von Platen's avatar
Patrick von Platen committed
6
from dataclasses import dataclass, fields
7
from typing import Annotated, Literal
Patrick von Platen's avatar
Patrick von Platen committed
8
9
10
11

import torch
import torch.nn as nn
import torch.nn.functional as F
12
13
from mistral_common.protocol.instruct.chunk import ImageChunk, TextChunk
from mistral_common.protocol.instruct.messages import UserMessage
14
from mistral_common.protocol.instruct.request import ChatCompletionRequest
15
from transformers import BatchFeature, PixtralVisionConfig
16
from transformers.models.pixtral.image_processing_pixtral import (
17
18
    _num_image_tokens as _get_pixtral_hf_num_image_tokens,
)
19
from transformers.models.pixtral.modeling_pixtral import (
20
21
22
23
    PixtralRotaryEmbedding,
    apply_rotary_pos_emb,
    position_ids_in_meshgrid,
)
Patrick von Platen's avatar
Patrick von Platen committed
24

25
from vllm.config import VllmConfig
26
from vllm.config.multimodal import BaseDummyOptions
27
from vllm.distributed import divide, get_tensor_model_parallel_world_size
28
from vllm.inputs import MultiModalDataDict
29
from vllm.model_executor.layers.activation import get_act_and_mul_fn
30
from vllm.model_executor.layers.conv import Conv2dLayer
Patrick von Platen's avatar
Patrick von Platen committed
31
from vllm.model_executor.layers.layernorm import RMSNorm
32
33
34
35
36
from vllm.model_executor.layers.linear import (
    MergedColumnParallelLinear,
    QKVParallelLinear,
    RowParallelLinear,
)
Patrick von Platen's avatar
Patrick von Platen committed
37
38
from vllm.model_executor.layers.quantization import QuantizationConfig
from vllm.model_executor.model_loader.weight_utils import default_weight_loader
39
from vllm.multimodal import MULTIMODAL_REGISTRY, MultiModalKwargsItems
40
41
42
43
from vllm.multimodal.inputs import (
    MultiModalFieldConfig,
    NestedTensors,
)
44
45
46
47
48
from vllm.multimodal.parse import (
    ImageProcessorItems,
    ImageSize,
    MultiModalDataItems,
)
49
from vllm.multimodal.processing import BaseDummyInputsBuilder
50
from vllm.multimodal.processing.processor import (
51
52
53
    BaseMultiModalProcessor,
    BaseProcessingInfo,
    MultiModalProcessingInfo,
54
    ProcessorInputs,
55
56
57
    PromptReplacement,
    PromptUpdate,
    PromptUpdateDetails,
58
    TimingContext,
59
)
60
from vllm.platforms import current_platform
61
from vllm.sequence import IntermediateTensors
62
63
from vllm.tokenizers import cached_tokenizer_from_config
from vllm.tokenizers.mistral import MistralTokenizer
64
65
66
67
from vllm.transformers_utils.processors.pixtral import (
    MistralCommonImageProcessor,
    MistralCommonPixtralProcessor,
)
68
from vllm.utils.collection_utils import is_list_of
69
from vllm.utils.tensor_schema import TensorSchema, TensorShape
Patrick von Platen's avatar
Patrick von Platen committed
70

71
72
from .interfaces import (
    MultiModalEmbeddings,
73
    SupportsEagle3,
74
75
76
    SupportsLoRA,
    SupportsMultiModal,
    SupportsPP,
77
    supports_eagle3,
78
79
)
from .module_mapping import MultiModelKeys
80
from .utils import StageMissingLayer, init_vllm_registered_model, maybe_prefix
81
82
83
from .vision import (
    VisionEncoderInfo,
    VisionFeatureSelectStrategy,
84
    is_vit_use_data_parallel,
85
86
    resolve_visual_encoder_outputs,
)
Patrick von Platen's avatar
Patrick von Platen committed
87

88
try:
89
    # Note: vLLM does not install xformers by default.
90
    from xformers import ops as xops
91
92

    if current_platform.is_cuda() and current_platform.has_device_capability(100):
93
94
95
96
        # Xformers FA is not compatible with B200
        USE_XFORMERS_OPS = False
    else:
        USE_XFORMERS_OPS = True
97
98
99
except ImportError:
    USE_XFORMERS_OPS = False

Patrick von Platen's avatar
Patrick von Platen committed
100
101
PATCH_MERGE = "patch_merge"

Patrick von Platen's avatar
Patrick von Platen committed
102

103
104
105
106
def _is_layer_none_or_staged(layer: nn.Module) -> bool:
    return layer is None or isinstance(layer, StageMissingLayer)


107
class PixtralImagePixelInputs(TensorSchema):
108
    """
109
110
111
112
113
    Dimensions:
        - bn: Batch size * number of images
        - c: Number of channels (3)
        - h: Height of each image
        - w: Width of each image
114

115
    The result of stacking `ImageEncoding.tokens` from each prompt.
116
    """
117

118
119
    type: Literal["pixel_values"] = "pixel_values"

120
    images: Annotated[
121
        torch.Tensor | list[torch.Tensor],
122
123
        TensorShape("bn", 3, "h", "w", dynamic_dims={"h", "w"}),
    ]
Patrick von Platen's avatar
Patrick von Platen committed
124
125


126
127
class PixtralProcessingInfo(BaseProcessingInfo):
    def get_tokenizer(self) -> MistralTokenizer:
128
        tokenizer = cached_tokenizer_from_config(self.ctx.model_config)
129
130
131
132
133
        if not isinstance(tokenizer, MistralTokenizer):
            raise ValueError("This model requires `--tokenizer-mode mistral`")

        return tokenizer

134
135
136
    def get_image_processor(self) -> MistralCommonImageProcessor:
        return MistralCommonImageProcessor(self.get_tokenizer().instruct.mm_encoder)

137
    def get_hf_processor(self, **kwargs) -> MistralCommonPixtralProcessor:
138
        return MistralCommonPixtralProcessor(
139
            tokenizer=self.get_tokenizer(),
140
            image_processor=self.get_image_processor(),
141
        )
142

143
    def get_supported_mm_limits(self) -> Mapping[str, int | None]:
144
145
146
        return {"image": None}

    def get_image_size_with_most_features(self) -> ImageSize:
147
        image_processor = self.get_image_processor()
148
        max_image_size = image_processor.mm_encoder.mm_config.max_image_size
149
150
151
152
153

        return ImageSize(width=max_image_size, height=max_image_size)


class PixtralDummyInputsBuilder(BaseDummyInputsBuilder[PixtralProcessingInfo]):
154
155
156
157
    def get_dummy_text(self, mm_counts: Mapping[str, int]) -> str:
        return ""

    def get_dummy_mm_data(
158
159
160
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
161
        mm_options: Mapping[str, BaseDummyOptions],
162
    ) -> MultiModalDataDict:
163
164
        num_images = mm_counts.get("image", 0)

165
        target_width, target_height = self.info.get_image_size_with_most_features()
166

167
        image_overrides = mm_options.get("image")
168

169
        return {
170
171
172
173
174
175
            "image": self._get_dummy_images(
                width=target_width,
                height=target_height,
                num_images=num_images,
                overrides=image_overrides,
            )
176
177
        }

178
179
180
181
    def get_dummy_processor_inputs(
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
182
        mm_options: Mapping[str, BaseDummyOptions],
183
        mm_data: MultiModalDataDict | None = None,
184
185
186
187
    ) -> ProcessorInputs:
        tokenizer = self.info.get_tokenizer()

        dummy_text = self.get_dummy_text(mm_counts)
188
189
190
191
192
193
194
195
196
        dummy_mm_data = (
            self.get_dummy_mm_data(seq_len, mm_counts, mm_options)
            if mm_data is None
            else mm_data
        )
        dummy_mm_items = self.info.parse_mm_data(dummy_mm_data)
        dummy_images = (
            [] if "image" not in dummy_mm_data else dummy_mm_items["image"].get_all()
        )
197

198
199
200
201
202
203
204
205
206
207
        request = ChatCompletionRequest(
            messages=[
                UserMessage(
                    content=[
                        TextChunk(text=dummy_text),
                        *(ImageChunk(image=image) for image in dummy_images),
                    ]
                ),
            ]
        )
208
209
210
        res = tokenizer.mistral.encode_chat_completion(request)
        dummy_tokens = res.tokens

211
        return ProcessorInputs(prompt=dummy_tokens, mm_data_items=dummy_mm_items)
212

Patrick von Platen's avatar
Patrick von Platen committed
213

214
class PixtralMultiModalProcessor(BaseMultiModalProcessor[PixtralProcessingInfo]):
215
216
217
218
219
    def _get_mm_fields_config(
        self,
        hf_inputs: Mapping[str, NestedTensors],
        hf_processor_mm_kwargs: Mapping[str, object],
    ) -> Mapping[str, MultiModalFieldConfig]:
220
        return dict(images=MultiModalFieldConfig.batched("image"))
221

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
    def _call_hf_processor(
        self,
        prompt: str,
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
        tok_kwargs: Mapping[str, object],
    ) -> BatchFeature:
        outputs = super()._call_hf_processor(
            prompt=prompt,
            mm_data=mm_data,
            mm_kwargs=mm_kwargs,
            # Avoid padding issue
            tok_kwargs={**tok_kwargs, "return_tensors": None},
        )

        # Missing batch dimension
        if is_list_of(outputs["input_ids"], int):
            outputs["input_ids"] = [outputs["input_ids"]]

        return outputs

243
244
245
246
    def _get_prompt_updates(
        self,
        mm_items: MultiModalDataItems,
        hf_processor_mm_kwargs: Mapping[str, object],
247
        out_mm_kwargs: MultiModalKwargsItems,
248
249
250
251
252
253
254
255
256
257
258
    ) -> Sequence[PromptUpdate]:
        processor = self.info.get_hf_processor(**hf_processor_mm_kwargs)

        image_break_id = processor.image_break_id
        image_token_id = processor.image_token_id
        image_end_id = processor.image_end_id

        def get_replacement(item_idx: int):
            images = mm_items.get_items("image", ImageProcessorItems)
            image_size = images.get_image_size(item_idx)

259
260
261
            _, nrows, ncols = processor.image_processor.get_number_of_image_patches(
                image_size.height,
                image_size.width,
262
            )
263
264
265
266

            tokens = ([image_token_id] * ncols + [image_break_id]) * nrows
            tokens[-1] = image_end_id

267
            return PromptUpdateDetails.select_token_id(tokens, image_token_id)
268
269
270
271
272
273
274
275
276
277
278

        return [
            PromptReplacement(
                modality="image",
                target="",  # Never match the prompt (see below note)
                replacement=get_replacement,
            ),
        ]

    def _cached_apply_hf_processor(
        self,
279
280
        inputs: ProcessorInputs,
        timing_ctx: TimingContext,
281
    ) -> tuple[list[int], MultiModalProcessingInfo, bool]:
282
        prompt_ids, mm_info, _ = super()._cached_apply_hf_processor(inputs, timing_ctx)
283
284

        # NOTE: The tokens are already inserted by the chat template
285
        return prompt_ids, mm_info, True
Patrick von Platen's avatar
Patrick von Platen committed
286

287

288
289
290
291
292
@MULTIMODAL_REGISTRY.register_processor(
    PixtralMultiModalProcessor,
    info=PixtralProcessingInfo,
    dummy_inputs=PixtralDummyInputsBuilder,
)
293
class PixtralForConditionalGeneration(
294
    nn.Module, SupportsLoRA, SupportsEagle3, SupportsMultiModal, SupportsPP
295
):
296
    @classmethod
297
    def get_placeholder_str(cls, modality: str, i: int) -> str | None:
298
299
300
301
302
        if modality.startswith("image"):
            return None

        raise ValueError("Only image modality is supported")

303
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
Patrick von Platen's avatar
Patrick von Platen committed
304
        super().__init__()
305
306
        config = vllm_config.model_config.hf_config
        multimodal_config = vllm_config.model_config.multimodal_config
Patrick von Platen's avatar
Patrick von Platen committed
307
308
309
310
311
312
313
314
315
316
317
318
319
        self.config = config
        self.multimodal_config = multimodal_config

        dataclass_fields = {field.name for field in fields(VisionEncoderArgs)}
        vision_args = {
            key: value
            for key, value in self.config.vision_config.to_dict().items()
            if key in dataclass_fields
        }

        self.vision_args = VisionEncoderArgs(**vision_args)

        # init MistralForCausalLM
320
321
322
323
324
325
        with self._mark_language_model(vllm_config):
            self.language_model = init_vllm_registered_model(
                vllm_config=vllm_config,
                hf_config=config.text_config,
                prefix=maybe_prefix(prefix, "language_model"),
            )
Patrick von Platen's avatar
Patrick von Platen committed
326

327
        with self._mark_tower_model(vllm_config, "image"):
328
329
330
331
332
            self.vision_encoder = VisionTransformer(self.vision_args)
            self.pre_mm_projector_norm = (
                RMSNorm(self.vision_args.hidden_size, eps=1e-5)
                if self.vision_args.add_pre_mm_projector_layer_norm
                else None
Patrick von Platen's avatar
Patrick von Platen committed
333
            )
334
335
336
337
338
339
340
341
342
343
344
345
            self.patch_merger = (
                PatchMerger(
                    vision_encoder_dim=self.vision_args.hidden_size,
                    spatial_merge_size=self.vision_args.spatial_merge_size,
                    use_mlp_bias=False,
                )
                if self.vision_args.mm_projector_id == PATCH_MERGE
                else None
            )
            self.vision_language_adapter = VisionLanguageAdapter(
                self.vision_args, dim=config.text_config.hidden_size
            )
Patrick von Platen's avatar
Patrick von Platen committed
346

347
        self.make_empty_intermediate_tensors = (
348
349
            self.language_model.make_empty_intermediate_tensors
        )
350

351
    def _parse_and_validate_image_input(
352
        self, **kwargs: object
353
    ) -> PixtralImagePixelInputs | None:
354
355
356
357
358
359
        images = kwargs.pop("images", None)
        if images is None:
            return None

        return PixtralImagePixelInputs(
            type="pixel_values",
360
            images=images,
361
362
363
364
365
366
367
368
        )

    def _process_image_input(
        self,
        image_input: PixtralImagePixelInputs,
    ) -> tuple[torch.Tensor, ...]:
        images = image_input["images"]
        image_features = self.vision_encoder(images)
369
        feature_sizes = [image_feature.shape[0] for image_feature in image_features]
Patrick von Platen's avatar
Patrick von Platen committed
370
        image_features = torch.cat(image_features)
371
        if self.pre_mm_projector_norm is not None:
Patrick von Platen's avatar
Patrick von Platen committed
372
            image_features = self.pre_mm_projector_norm(image_features)
373
        if self.patch_merger is not None:
Patrick von Platen's avatar
Patrick von Platen committed
374
375
            patch_size = self.vision_args.patch_size
            spatial_merge_size_square = self.vision_args.spatial_merge_size**2
376
377
378
379
            img_patch_dims = [
                (img.shape[1] // patch_size, img.shape[2] // patch_size)
                for img in images
            ]
Patrick von Platen's avatar
Patrick von Platen committed
380
381
382
383
            feature_sizes = [
                feature_size // spatial_merge_size_square
                for feature_size in feature_sizes
            ]
384
385
386
            image_features = self.patch_merger(
                image_features, image_sizes=img_patch_dims
            )
Patrick von Platen's avatar
Patrick von Platen committed
387
        image_embeds = self.vision_language_adapter(image_features)
388
389
390
        image_embeds = torch.split(image_embeds, feature_sizes)
        return image_embeds

391
    def embed_multimodal(self, **kwargs: object) -> MultiModalEmbeddings:
392
        image_input = self._parse_and_validate_image_input(**kwargs)
393
        if image_input is None:
394
            return []
395

396
        return self._process_image_input(image_input)
397

Patrick von Platen's avatar
Patrick von Platen committed
398
399
    def forward(
        self,
400
        input_ids: torch.Tensor | None,
Patrick von Platen's avatar
Patrick von Platen committed
401
        positions: torch.Tensor,
402
403
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
Patrick von Platen's avatar
Patrick von Platen committed
404
        **kwargs: object,
405
    ) -> torch.Tensor | IntermediateTensors:
406
        """Run forward pass for pixtral."""
407
408
        if intermediate_tensors is not None:
            inputs_embeds = None
Patrick von Platen's avatar
Patrick von Platen committed
409

410
411
412
        hidden_states = self.language_model.model(
            input_ids, positions, intermediate_tensors, inputs_embeds=inputs_embeds
        )
Patrick von Platen's avatar
Patrick von Platen committed
413
414
415
416
417
418

        return hidden_states

    def compute_logits(
        self,
        hidden_states: torch.Tensor,
419
    ) -> torch.Tensor | None:
420
        return self.language_model.compute_logits(hidden_states)
Patrick von Platen's avatar
Patrick von Platen committed
421

422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
    def _require_language_model_eagle3(self) -> None:
        if not supports_eagle3(self.language_model):
            raise RuntimeError(
                f"EAGLE-3 speculative decoding requires the language model to "
                f"support EAGLE-3, but {type(self.language_model).__name__} does not."
            )

    def set_aux_hidden_state_layers(self, layers: tuple[int, ...]) -> None:
        self._require_language_model_eagle3()
        self.language_model.set_aux_hidden_state_layers(layers)

    def get_eagle3_aux_hidden_state_layers(self) -> tuple[int, ...]:
        self._require_language_model_eagle3()
        return self.language_model.get_eagle3_aux_hidden_state_layers()

437
438
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]):
        def is_vision_encoder_weights(weight: tuple[str, torch.Tensor]):
439
            return weight[0].startswith(("vision_encoder", "vision_tower"))
Patrick von Platen's avatar
Patrick von Platen committed
440

441
        def is_vision_lang_adapter_weights(weight: tuple[str, torch.Tensor]):
442
443
444
            return weight[0].startswith(
                ("vision_language_adapter", "multi_modal_projector")
            )
Patrick von Platen's avatar
Patrick von Platen committed
445

446
        def is_patch_merger(weight: tuple[str, torch.Tensor]):
Patrick von Platen's avatar
Patrick von Platen committed
447
448
            return weight[0].startswith("patch_merger")

449
        def is_pre_mm_projector_norm(weight: tuple[str, torch.Tensor]):
Patrick von Platen's avatar
Patrick von Platen committed
450
451
            return weight[0].startswith("pre_mm_projector_norm")

452
        # Get references to parameters for direct loading
453
454
455
456
457
        vision_encoder_dict = (
            dict(self.vision_encoder.named_parameters())
            if self.vision_encoder is not None
            else {}
        )
458
459
        patch_merger_dict = (
            dict(self.patch_merger.named_parameters())
460
461
            if self.patch_merger is not None
            else {}
462
463
464
        )
        pre_mm_projector_norm_dict = (
            dict(self.pre_mm_projector_norm.named_parameters())
465
466
467
468
469
470
471
            if self.pre_mm_projector_norm is not None
            else {}
        )
        vision_lang_adapter_dict = (
            dict(self.vision_language_adapter.named_parameters())
            if self.vision_language_adapter is not None
            else {}
472
        )
473
474
475
476
477

        def llm_weights_generator():
            # Single pass over weights
            for name, w in weights:
                if is_vision_encoder_weights((name, w)):
478
                    if _is_layer_none_or_staged(self.vision_encoder):
479
                        continue
480
                    # Load vision encoder weights directly
481
                    trimmed_name = ".".join(name.split(".")[1:])
482
483
484
485
                    param = vision_encoder_dict.get(trimmed_name)
                    if param is not None:
                        with torch.no_grad():
                            default_weight_loader(param, w)
Patrick von Platen's avatar
Patrick von Platen committed
486
                elif is_patch_merger((name, w)):
487
                    if _is_layer_none_or_staged(self.patch_merger):
488
                        continue
Patrick von Platen's avatar
Patrick von Platen committed
489
                    # Load vision patch merger weights directly
490
                    trimmed_name = ".".join(name.split(".")[1:])
Patrick von Platen's avatar
Patrick von Platen committed
491
492
493
494
                    param = patch_merger_dict[trimmed_name]
                    with torch.no_grad():
                        default_weight_loader(param, w)
                elif is_pre_mm_projector_norm((name, w)):
495
                    if _is_layer_none_or_staged(self.pre_mm_projector_norm):
496
                        continue
Patrick von Platen's avatar
Patrick von Platen committed
497
                    # Load vision pre_mm_projector_norm weights directly
498
                    trimmed_name = ".".join(name.split(".")[1:])
Patrick von Platen's avatar
Patrick von Platen committed
499
500
501
                    param = pre_mm_projector_norm_dict[trimmed_name]
                    with torch.no_grad():
                        default_weight_loader(param, w)
502
                elif is_vision_lang_adapter_weights((name, w)):
503
                    if _is_layer_none_or_staged(self.vision_language_adapter):
504
                        continue
505
                    # Load vision-language adapter weights directly
506
                    trimmed_name = ".".join(name.split(".")[1:])
507
508
509
510
                    param = vision_lang_adapter_dict.get(trimmed_name)
                    if param is not None:
                        with torch.no_grad():
                            default_weight_loader(param, w)
511
512
513
                else:
                    # LLM weights: yield them to be loaded
                    # by language_model.load_weights
514
515
                    # Strip "language_model." prefix if present (HF sharded format)
                    name = name.removeprefix("language_model.")
516
517
518
519
                    yield (name, w)

        # Now we call the language model load with the generator
        self.language_model.load_weights(llm_weights_generator())
Patrick von Platen's avatar
Patrick von Platen committed
520

521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
    def get_mm_mapping(self) -> MultiModelKeys:
        return MultiModelKeys.from_string_field(
            language_model="language_model",
            connector="vision_language_adapter",
            tower_model="vision_encoder",
        )

    def get_num_mm_encoder_tokens(self, num_image_tokens: int) -> int:
        if getattr(self, "patch_merger", None) is None:
            return num_image_tokens
        merge_size = self.vision_args.spatial_merge_size
        return num_image_tokens * (merge_size**2)

    def get_num_mm_connector_tokens(self, num_vision_tokens: int) -> int:
        if getattr(self, "patch_merger", None) is None:
            return num_vision_tokens
        merge_size = self.vision_args.spatial_merge_size
        return num_vision_tokens // (merge_size**2)

Patrick von Platen's avatar
Patrick von Platen committed
540
541
542
543
544
545
546
547
548
549
550
551
552

# Vision encoder
@dataclass
class VisionEncoderArgs:
    hidden_size: int
    num_channels: int
    image_size: int
    patch_size: int
    intermediate_size: int
    num_hidden_layers: int
    num_attention_heads: int
    rope_theta: float  # for rope-2D
    image_token_id: int
553
    adapter_bias: bool = True
Patrick von Platen's avatar
Patrick von Platen committed
554
555
556
    spatial_merge_size: int = 1
    add_pre_mm_projector_layer_norm: bool = False
    mm_projector_id: str = ""
Patrick von Platen's avatar
Patrick von Platen committed
557
558


559
def _reshape_for_broadcast(freqs_cis: torch.Tensor, x: torch.Tensor) -> torch.Tensor:
Patrick von Platen's avatar
Patrick von Platen committed
560
561
562
563
564
565
566
567
568
569
    """
    freqs_cis: complex - (seq_len, head_dim / 2)
    x: complex - (bsz, seq_len, head_dim / 2)
    """
    ndim = x.ndim
    assert ndim > 1
    assert freqs_cis.shape == (x.shape[1], x.shape[-1]), (
        freqs_cis.shape,
        (x.shape[1], x.shape[-1]),
    )
570
    shape = [d if i == 1 or i == ndim - 1 else 1 for i, d in enumerate(x.shape)]
Patrick von Platen's avatar
Patrick von Platen committed
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    return freqs_cis.view(*shape)


def precompute_freqs_cis_2d(
    dim: int,
    height: int,
    width: int,
    theta: float,
) -> torch.Tensor:
    """
    freqs_cis: 2D complex tensor of shape (height, width, dim // 2)
        to be indexed by (height, width) position tuples
    """
    # (dim / 2) frequency bases
585
    freqs = 1.0 / (theta ** (torch.arange(0, dim, 2).float() / dim))
Patrick von Platen's avatar
Patrick von Platen committed
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605

    h = torch.arange(height, device=freqs.device)
    w = torch.arange(width, device=freqs.device)

    freqs_h = torch.outer(h, freqs[::2]).float()
    freqs_w = torch.outer(w, freqs[1::2]).float()
    freqs_2d = torch.cat(
        [
            freqs_h[:, None, :].repeat(1, width, 1),
            freqs_w[None, :, :].repeat(height, 1, 1),
        ],
        dim=-1,
    )
    return torch.polar(torch.ones_like(freqs_2d), freqs_2d)


def apply_rotary_emb_vit(
    xq: torch.Tensor,
    xk: torch.Tensor,
    freqs_cis: torch.Tensor,
606
) -> tuple[torch.Tensor, torch.Tensor]:
Patrick von Platen's avatar
Patrick von Platen committed
607
608
609
610
611
612
613
614
615
616
617
618
619
    xq_ = torch.view_as_complex(xq.float().reshape(*xq.shape[:-1], -1, 2))
    xk_ = torch.view_as_complex(xk.float().reshape(*xk.shape[:-1], -1, 2))
    assert freqs_cis.dtype == torch.complex64
    freqs_cis = _reshape_for_broadcast(freqs_cis, xq_)
    xq_out = torch.view_as_real(xq_ * freqs_cis).flatten(3)
    xk_out = torch.view_as_real(xk_ * freqs_cis).flatten(3)
    return xq_out.type_as(xq), xk_out.type_as(xk)


class FeedForward(nn.Module):
    def __init__(self, args: VisionEncoderArgs):
        super().__init__()
        assert args.intermediate_size is not None
620
621
622
        self.w1 = nn.Linear(args.hidden_size, args.intermediate_size, bias=False)
        self.w2 = nn.Linear(args.intermediate_size, args.hidden_size, bias=False)
        self.w3 = nn.Linear(args.hidden_size, args.intermediate_size, bias=False)
Patrick von Platen's avatar
Patrick von Platen committed
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643

    def forward(self, x: torch.Tensor) -> torch.Tensor:
        return self.w2(F.silu(self.w1(x)) * self.w3(x))


class Attention(nn.Module):
    def __init__(self, args: VisionEncoderArgs):
        super().__init__()
        self.args = args
        assert not args.hidden_size % args.num_attention_heads
        self.n_heads = args.num_attention_heads
        self.head_dim = args.hidden_size // args.num_attention_heads

        self.wq = nn.Linear(args.hidden_size, args.hidden_size, bias=False)
        self.wk = nn.Linear(args.hidden_size, args.hidden_size, bias=False)
        self.wv = nn.Linear(args.hidden_size, args.hidden_size, bias=False)
        self.wo = nn.Linear(args.hidden_size, args.hidden_size, bias=False)

    def forward(
        self,
        x: torch.Tensor,
644
        mask: torch.Tensor,
Patrick von Platen's avatar
Patrick von Platen committed
645
646
647
648
649
650
651
652
653
654
        freqs_cis: torch.Tensor,
    ) -> torch.Tensor:
        batch, patches, _ = x.shape

        q, k, v = self.wq(x), self.wk(x), self.wv(x)
        q = q.reshape(batch, patches, self.n_heads, self.head_dim)
        k = k.reshape(batch, patches, self.n_heads, self.head_dim)
        v = v.reshape(batch, patches, self.n_heads, self.head_dim)

        q, k = apply_rotary_emb_vit(q, k, freqs_cis=freqs_cis)
655
656
657
658
659
660
661

        if USE_XFORMERS_OPS:
            out = xops.memory_efficient_attention(q, k, v, attn_bias=mask)
        else:
            q = q.transpose(1, 2)
            k = k.transpose(1, 2)
            v = v.transpose(1, 2)
662
            out = nn.functional.scaled_dot_product_attention(q, k, v, attn_mask=mask)
663
664
            out = out.transpose(1, 2)

Patrick von Platen's avatar
Patrick von Platen committed
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
        out = out.reshape(batch, patches, self.n_heads * self.head_dim)
        return self.wo(out)


class TransformerBlock(nn.Module):
    def __init__(self, args: VisionEncoderArgs):
        super().__init__()
        self.attention = Attention(args)
        self.feed_forward = FeedForward(args)
        self.attention_norm = RMSNorm(args.hidden_size, eps=1e-5)
        self.ffn_norm = RMSNorm(args.hidden_size, eps=1e-5)

    def forward(
        self,
        x: torch.Tensor,
680
        mask: torch.Tensor,
Patrick von Platen's avatar
Patrick von Platen committed
681
682
        freqs_cis: torch.Tensor,
    ) -> torch.Tensor:
683
684
685
        r = self.attention.forward(
            self.attention_norm(x), mask=mask, freqs_cis=freqs_cis
        )
Patrick von Platen's avatar
Patrick von Platen committed
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
        h = x + r
        r = self.feed_forward.forward(self.ffn_norm(h))
        out = h + r
        return out


class Transformer(nn.Module):
    def __init__(self, args: VisionEncoderArgs):
        super().__init__()
        self.layers = torch.nn.ModuleList()
        for _ in range(args.num_hidden_layers):
            self.layers.append(TransformerBlock(args))

    def forward(
        self,
        x: torch.Tensor,
702
        mask: torch.Tensor,
703
        freqs_cis: torch.Tensor | None,
Patrick von Platen's avatar
Patrick von Platen committed
704
705
706
707
708
709
    ) -> torch.Tensor:
        for layer in self.layers:
            x = layer(x, mask=mask, freqs_cis=freqs_cis)
        return x


710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
def position_meshgrid(
    patch_embeds_list: list[torch.Tensor],
) -> torch.Tensor:
    positions = torch.cat(
        [
            torch.stack(
                torch.meshgrid(
                    torch.arange(p.shape[-2]),
                    torch.arange(p.shape[-1]),
                    indexing="ij",
                ),
                dim=-1,
            ).reshape(-1, 2)
            for p in patch_embeds_list
        ]
    )
Patrick von Platen's avatar
Patrick von Platen committed
726
727
728
729
730
731
732
    return positions


class VisionTransformer(nn.Module):
    def __init__(self, args: VisionEncoderArgs):
        super().__init__()
        self.args = args
733
        self.patch_conv = Conv2dLayer(
Patrick von Platen's avatar
Patrick von Platen committed
734
735
736
737
738
739
740
741
742
743
744
            in_channels=args.num_channels,
            out_channels=args.hidden_size,
            kernel_size=args.patch_size,
            stride=args.patch_size,
            bias=False,
        )
        self.ln_pre = RMSNorm(args.hidden_size, eps=1e-5)
        self.transformer = Transformer(args)

        head_dim = self.args.hidden_size // self.args.num_attention_heads
        assert head_dim % 2 == 0, "ROPE requires even head_dim"
745
        self._freqs_cis: torch.Tensor | None = None
Patrick von Platen's avatar
Patrick von Platen committed
746
747
748
749
750
751

    @property
    def max_patches_per_side(self) -> int:
        return self.args.image_size // self.args.patch_size

    @property
752
    def device(self) -> torch.types.Device:
Patrick von Platen's avatar
Patrick von Platen committed
753
754
755
        return next(self.parameters()).device

    @property
756
    def dtype(self) -> torch.dtype:
Patrick von Platen's avatar
Patrick von Platen committed
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
        return next(self.parameters()).dtype

    @property
    def freqs_cis(self) -> torch.Tensor:
        if self._freqs_cis is None:
            self._freqs_cis = precompute_freqs_cis_2d(
                dim=self.args.hidden_size // self.args.num_attention_heads,
                height=self.max_patches_per_side,
                width=self.max_patches_per_side,
                theta=self.args.rope_theta,
            )

        if self._freqs_cis.device != self.device:
            self._freqs_cis = self._freqs_cis.to(device=self.device)

        return self._freqs_cis

    def forward(
        self,
776
        images: list[torch.Tensor],
Patrick von Platen's avatar
Patrick von Platen committed
777
778
779
    ) -> torch.Tensor:
        """
        Args:
780
            images: list of N_img images of variable sizes,
Patrick von Platen's avatar
Patrick von Platen committed
781
782
                each of shape (C, H, W)
        Returns:
783
            image_features: tensor of token features for
Patrick von Platen's avatar
Patrick von Platen committed
784
785
786
787
788
789
790
                all tokens of all images of shape (N_toks, D)
        """
        # pass images through initial convolution independently
        patch_embeds_list = [
            self.patch_conv(img.unsqueeze(0).to(self.dtype)) for img in images
        ]

791
        patch_embeds = [p.flatten(2).permute(0, 2, 1) for p in patch_embeds_list]
792
793
        embed_sizes = [p.shape[1] for p in patch_embeds]

Patrick von Platen's avatar
Patrick von Platen committed
794
        # flatten to a single sequence
795
        patch_embeds = torch.cat(patch_embeds, dim=1)
Patrick von Platen's avatar
Patrick von Platen committed
796
797
798
799
800
801
802
        patch_embeds = self.ln_pre(patch_embeds)

        # positional embeddings
        positions = position_meshgrid(patch_embeds_list).to(self.device)
        freqs_cis = self.freqs_cis[positions[:, 0], positions[:, 1]]

        # pass through Transformer with a block diagonal mask delimiting images
803
804
        if USE_XFORMERS_OPS:
            mask = xops.fmha.attn_bias.BlockDiagonalMask.from_seqlens(
805
806
                [p.shape[-2] * p.shape[-1] for p in patch_embeds_list],
            )
807
        else:
808
            from transformers.models.pixtral.modeling_pixtral import (
809
810
811
                generate_block_attention_mask,
            )

812
            mask = generate_block_attention_mask(
813
814
                [p.shape[-2] * p.shape[-1] for p in patch_embeds_list], patch_embeds
            )
Patrick von Platen's avatar
Patrick von Platen committed
815
816
        out = self.transformer(patch_embeds, mask=mask, freqs_cis=freqs_cis)

817
818
        # squeeze dim 0 and split into separate tensors for each image
        return torch.split(out.squeeze(0), embed_sizes)
Patrick von Platen's avatar
Patrick von Platen committed
819
820
821
822
823
824
825
826
827


class VisionLanguageAdapter(nn.Module):
    def __init__(self, args: VisionEncoderArgs, dim: int):
        super().__init__()
        assert isinstance(args, VisionEncoderArgs)
        self.w_in = nn.Linear(
            args.hidden_size,
            dim,
828
            bias=args.adapter_bias,
Patrick von Platen's avatar
Patrick von Platen committed
829
830
        )
        self.gelu = nn.GELU()
831
        self.w_out = nn.Linear(dim, dim, bias=args.adapter_bias)
Patrick von Platen's avatar
Patrick von Platen committed
832
833
834

    def forward(self, x: torch.Tensor) -> torch.Tensor:
        return self.w_out(self.gelu(self.w_in(x)))
835
836


Patrick von Platen's avatar
Patrick von Platen committed
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
class PatchMerger(nn.Module):
    """
    Learned merging of spatial_merge_size ** 2 patches
    """

    def __init__(
        self,
        vision_encoder_dim: int,
        spatial_merge_size: int,
        use_mlp_bias: bool = False,
    ) -> None:
        super().__init__()

        mlp_input_dim = vision_encoder_dim * (spatial_merge_size**2)

        self.spatial_merge_size = spatial_merge_size
        self.mlp_input_dim = mlp_input_dim

        self.merging_layer = nn.Linear(
            mlp_input_dim,
            vision_encoder_dim,
            bias=use_mlp_bias,
        )

861
862
863
    def forward(
        self, x: torch.Tensor, image_sizes: list[tuple[int, int]]
    ) -> torch.Tensor:
Patrick von Platen's avatar
Patrick von Platen committed
864
865
866
867
868
869
        # image_sizes specified in tokens
        assert sum([h * w for h, w in image_sizes]) == len(x)

        # x is (N, vision_encoder_dim)
        x = self.permute(x, image_sizes)

870
871
        # x is (N / spatial_merge_size ** 2,
        #       vision_encoder_dim * spatial_merge_size ** 2)
Patrick von Platen's avatar
Patrick von Platen committed
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
        x = self.merging_layer(x)

        # x is (N / spatial_merge_size ** 2, vision_encoder_dim)
        return x

    def permute(
        self,
        x: torch.Tensor,
        image_sizes: list[tuple[int, int]],
    ) -> torch.Tensor:
        """
        Args:
            x: (N, D) where N is flattened and concatenated patch tokens
                for all images
            image_sizes: list of tuple of (height, width) in tokens for
                each image
        Returns:
            image_features: reorders patch tokens so each grid of
                (spatial_merge_size, spatial_merge_size) is contiguous.
                now (N / spatial_merge_size ** 2, D * spatial_merge_size ** 2)
        """

        sub_grids = get_sub_grids(
895
            x=x, image_sizes=image_sizes, spatial_merge_size=self.spatial_merge_size
Patrick von Platen's avatar
Patrick von Platen committed
896
897
898
899
        )  # list of [d x sub_grid_size x sub_grid_size x n_patches]
        permuted_tensor: list[torch.Tensor] = []
        for grid in sub_grids:
            n_patches = grid.shape[-1]
900
901
902
            permuted_tensor.append(
                grid.view(-1, n_patches).t()
            )  # n_patches x d * sub_grid_size * sub_grid_size
Patrick von Platen's avatar
Patrick von Platen committed
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
        return torch.cat(
            permuted_tensor, dim=0
        )  # (N / spatial_merge_size ** 2, d * spatial_merge_size ** 2)


def get_sub_grids(
    x: torch.Tensor,
    image_sizes: list[tuple[int, int]],
    spatial_merge_size: int,
) -> list[torch.Tensor]:
    # image_sizes specified in tokens
    tokens_per_image = [h * w for h, w in image_sizes]
    d = x.shape[-1]
    all_img_sub_grids: list[torch.Tensor] = []
    sub_grid_size = spatial_merge_size

    for image_index, image_tokens in enumerate(x.split(tokens_per_image)):
        # Reshape image_tokens into a 2D grid
        h, w = image_sizes[image_index]
922
923
924
925
926
927
        image_grid = image_tokens.view(h, w, d).permute(2, 0, 1)[
            None, :, :, :
        ]  # 1 x d x h x w
        sub_grids = torch.nn.functional.unfold(
            image_grid, kernel_size=sub_grid_size, stride=sub_grid_size
        )
Patrick von Platen's avatar
Patrick von Platen committed
928
        sub_grids = sub_grids.view(
929
930
            1, d, sub_grid_size, sub_grid_size, -1
        )  # 1 x d x sub_grid_size x sub_grid_size x n_patches
Patrick von Platen's avatar
Patrick von Platen committed
931
932
933
934
935
936

        all_img_sub_grids.append(sub_grids[0])

    return all_img_sub_grids


937
938
939
940
941
942
943
944
#### HF Transformers version of Pixtral ####
# Based off https://github.com/huggingface/transformers/blob/d7950bff82b18c823193d17d72188c5e46d06c83/src/transformers/models/pixtral/modeling_pixtral.py
# This model follows the Llava family, meaning image embeddings are placed
# instead of the `[IMG]` token placeholders.
# The model uses [`PixtralVisionModel`] for its vision encoder,
# and [`MistralForCausalLM`] for its language decoder.


945
946
947
948
949
950
951
class PixtralHFEncoderInfo(VisionEncoderInfo[PixtralVisionConfig]):
    def get_num_image_tokens(
        self,
        *,
        image_width: int,
        image_height: int,
    ) -> int:
952
953
954
        ncols, nrows = self.get_patch_grid_size(
            image_width=image_width,
            image_height=image_height,
955
        )
956
        return ncols * nrows
957

958
959
960
961
    def get_image_size(self) -> int:
        return self.vision_config.image_size

    def get_patch_size(self) -> int:
962
963
964
        # spatial_merge_size is needed for Mistral3
        spatial_merge_size = getattr(self.hf_config, "spatial_merge_size", 1)
        return self.vision_config.patch_size * spatial_merge_size
965
966

    def get_patch_grid_length(self) -> int:
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
        image_size, patch_size = self.get_image_size(), self.get_patch_size()

        # Since interpolation is applied, the image size need not be divisible
        # assert image_size % patch_size == 0
        return image_size // patch_size

    # Adapted from: https://github.com/huggingface/transformers/blob/v4.49.0/src/transformers/models/pixtral/image_processing_pixtral.py#L99
    def get_patch_grid_size(
        self,
        *,
        image_width: int,
        image_height: int,
    ) -> tuple[int, int]:
        max_width = max_height = self.get_image_size()
        patch_width = patch_height = self.get_patch_size()

        ratio = max(image_width / max_width, image_height / max_height)

        if ratio > 1:
986
987
            image_width = int(math.floor(image_width / ratio))
            image_height = int(math.floor(image_height / ratio))
988
989
990
991
992
993
994

        nrows, ncols = _get_pixtral_hf_num_image_tokens(
            (image_height, image_width),
            (patch_height, patch_width),
        )  # type: ignore

        return ncols, nrows
995
996
997


class PixtralHFMLP(nn.Module):
998
999
1000
    def __init__(
        self,
        config: PixtralVisionConfig,
1001
        quant_config: QuantizationConfig | None = None,
1002
1003
1004
        *,
        prefix: str = "",
    ) -> None:
1005
        super().__init__()
1006

1007
        use_data_parallel = is_vit_use_data_parallel()
1008

1009
        assert config.intermediate_size is not None
1010
1011
1012
1013
1014
        self.gate_up_proj = MergedColumnParallelLinear(
            input_size=config.hidden_size,
            output_sizes=[config.intermediate_size] * 2,
            bias=False,
            quant_config=quant_config,
1015
            prefix=f"{prefix}.gate_up_proj",
1016
            disable_tp=use_data_parallel,
1017
1018
1019
1020
1021
1022
1023
        )
        self.down_proj = RowParallelLinear(
            input_size=config.intermediate_size,
            output_size=config.hidden_size,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.down_proj",
1024
            disable_tp=use_data_parallel,
1025
        )
1026
        self.act_and_mul = get_act_and_mul_fn(config.hidden_act)
1027
1028

    def forward(self, x: torch.Tensor) -> torch.Tensor:
1029
1030
1031
1032
        gate_up, _ = self.gate_up_proj(x)
        x = self.act_and_mul(gate_up)
        x, _ = self.down_proj(x)
        return x
1033
1034
1035


class PixtralHFAttention(nn.Module):
1036
1037
1038
    def __init__(
        self,
        config: PixtralVisionConfig,
1039
        quant_config: QuantizationConfig | None = None,
1040
1041
1042
        *,
        prefix: str = "",
    ) -> None:
1043
        super().__init__()
1044

1045
1046
        self.config = config
        assert not config.hidden_size % config.num_attention_heads
1047
        self.total_num_heads = config.num_attention_heads
1048
        self.head_dim = config.hidden_size // config.num_attention_heads
1049
        assert self.total_num_heads * self.head_dim == config.hidden_size
1050

1051
        use_data_parallel = is_vit_use_data_parallel()
1052
1053
1054
        self.qkv_proj = QKVParallelLinear(
            hidden_size=config.hidden_size,
            head_size=self.head_dim,
1055
            total_num_heads=self.total_num_heads,
1056
1057
1058
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.qkv_proj",
1059
            disable_tp=use_data_parallel,
1060
1061
1062
1063
1064
1065
1066
        )
        self.o_proj = RowParallelLinear(
            input_size=config.hidden_size,
            output_size=config.hidden_size,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.o_proj",
1067
1068
1069
1070
1071
            disable_tp=use_data_parallel,
        )

        self.tp_size = (
            1 if use_data_parallel else get_tensor_model_parallel_world_size()
1072
        )
1073
        self.n_heads = divide(config.num_attention_heads, self.tp_size)
1074
1075
1076
1077

    def forward(
        self,
        hidden_states: torch.Tensor,
1078
        attention_mask: torch.Tensor,
1079
        position_embeddings: torch.Tensor,
1080
    ) -> tuple[torch.Tensor, torch.Tensor | None]:
1081
        batch, patches, _ = hidden_states.size()
1082

1083
1084
        qkv_states, _ = self.qkv_proj(hidden_states)
        q, k, v = qkv_states.chunk(3, dim=-1)
1085

1086
1087
1088
        # Transpose q and k to apply HF's Rotary Position Embedding
        q = q.view(batch, patches, self.n_heads, self.head_dim).transpose(1, 2)
        k = k.view(batch, patches, self.n_heads, self.head_dim).transpose(1, 2)
1089
        v = v.view(batch, patches, self.n_heads, self.head_dim)
1090
        cos, sin = position_embeddings
1091
        q, k = apply_rotary_pos_emb(q, k, cos, sin, unsqueeze_dim=0)
1092

1093
1094
1095
1096
        if USE_XFORMERS_OPS:
            # Transpose q and k back for attention
            q = q.transpose(1, 2).contiguous()
            k = k.transpose(1, 2).contiguous()
1097
            out = xops.memory_efficient_attention(q, k, v, attn_bias=attention_mask)
1098
        else:
1099
            v = v.transpose(1, 2)
1100
            out = nn.functional.scaled_dot_product_attention(
1101
1102
                q, k, v, attn_mask=attention_mask
            )
1103
            out = out.transpose(1, 2)
1104

1105
        out = out.reshape(batch, patches, self.n_heads * self.head_dim)
1106
        attn_output, _ = self.o_proj(out)
1107

1108
        return attn_output, None
1109
1110
1111


class PixtralHFTransformerBlock(nn.Module):
1112
1113
1114
    def __init__(
        self,
        config: PixtralVisionConfig,
1115
        quant_config: QuantizationConfig | None = None,
1116
1117
1118
        *,
        prefix: str = "",
    ) -> None:
1119
        super().__init__()
1120

1121
        self.attention_norm = RMSNorm(config.hidden_size, eps=1e-5)
1122
        self.attention = PixtralHFAttention(
1123
1124
1125
            config,
            quant_config=quant_config,
            prefix=f"{prefix}.attention",
1126
1127
        )
        self.feed_forward = PixtralHFMLP(
1128
1129
1130
            config,
            quant_config=quant_config,
            prefix=f"{prefix}.feed_forward",
1131
        )
1132
1133
1134
1135
1136
        self.ffn_norm = RMSNorm(config.hidden_size, eps=1e-5)

    def forward(
        self,
        hidden_states: torch.Tensor,
1137
        attention_mask: torch.Tensor,
1138
1139
        position_embeddings: torch.Tensor,
    ) -> torch.Tensor:
1140
1141
1142
1143
1144
        r, _ = self.attention.forward(
            self.attention_norm(hidden_states),
            attention_mask=attention_mask,
            position_embeddings=position_embeddings,
        )
1145
1146
1147
1148
1149
1150
1151
        h = hidden_states + r
        r = self.feed_forward.forward(self.ffn_norm(h))
        out = h + r
        return out


class PixtralHFTransformer(nn.Module):
1152
1153
1154
    def __init__(
        self,
        config: PixtralVisionConfig,
1155
        quant_config: QuantizationConfig | None = None,
1156
        *,
1157
        num_hidden_layers_override: int | None = None,
1158
1159
        prefix: str = "",
    ) -> None:
1160
        super().__init__()
1161
1162
1163
1164
1165
1166

        if num_hidden_layers_override is None:
            num_hidden_layers = config.num_hidden_layers
        else:
            num_hidden_layers = num_hidden_layers_override

1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
        self.layers = nn.ModuleList(
            [
                PixtralHFTransformerBlock(
                    config=config,
                    quant_config=quant_config,
                    prefix=f"{prefix}.layers.{layer_idx}",
                )
                for layer_idx in range(num_hidden_layers)
            ]
        )
1177
1178
1179
1180

    def forward(
        self,
        x: torch.Tensor,
1181
        attention_mask: torch.Tensor,
1182
        position_embeddings: torch.Tensor,
1183
        return_all_hidden_states: bool,
1184
    ) -> torch.Tensor:
1185
        hidden_states_pool = [x]
1186

1187
1188
        for layer in self.layers:
            x = layer(x, attention_mask, position_embeddings)
1189
1190
1191
1192
1193
1194
            if return_all_hidden_states:
                hidden_states_pool.append(x)
        # If we have multiple feature sample layers, we return all hidden
        # states in order and grab the ones we need by index.
        if return_all_hidden_states:
            return hidden_states_pool
1195
1196
1197
1198
        return x


class PixtralHFVisionModel(nn.Module):
1199
1200
1201
    def __init__(
        self,
        config: PixtralVisionConfig,
1202
        quant_config: QuantizationConfig | None = None,
1203
        *,
1204
1205
        num_hidden_layers_override: int | None = None,
        require_post_norm: bool | None = None,
1206
1207
        prefix: str = "",
    ) -> None:
1208
1209
1210
        super().__init__()

        self.config = config
1211

1212
        self.patch_conv = Conv2dLayer(
1213
1214
1215
1216
1217
1218
1219
            in_channels=config.num_channels,
            out_channels=config.hidden_size,
            kernel_size=config.patch_size,
            stride=config.patch_size,
            bias=False,
        )
        self.ln_pre = RMSNorm(config.hidden_size, eps=1e-5)
1220
1221
        self.transformer = PixtralHFTransformer(
            config,
1222
            quant_config=quant_config,
1223
1224
1225
1226
1227
1228
1229
1230
1231
            num_hidden_layers_override=num_hidden_layers_override,
            prefix=f"{prefix}.transformer",
        )

        num_hidden_layers = config.num_hidden_layers
        if len(self.transformer.layers) > config.num_hidden_layers:
            raise ValueError(
                f"The original encoder only has {num_hidden_layers} "
                f"layers, but you requested {len(self.transformer.layers)} "
1232
1233
                "layers."
            )
1234
1235
1236
1237
1238

        if require_post_norm is True:
            msg = "PixtralHFVisionModel does not have post-layernorm"
            raise ValueError(msg)

1239
1240
        self.dtype = next(self.parameters()).dtype
        self.device = next(self.parameters()).device
1241
        self.patch_positional_embedding = PixtralRotaryEmbedding(config, self.device)
1242
1243
1244

    def forward(
        self,
1245
        pixel_values: list[torch.Tensor],
1246
        *,
1247
1248
        select_layers: list[int] | None = None,
        feature_select_strategy: VisionFeatureSelectStrategy | None = None,
1249
    ) -> tuple[torch.Tensor, ...]:
1250
1251
        """
        Args:
1252
1253
1254
1255
            pixel_values: Each image to be processed will be a separate tensor
                in pixel_values. This means it will be a list of tensors
                because multiple requests batched can have multiple images,
                each with their own shape potentially
1256
            select_layers: Layer indices whose features should be
1257
1258
                concatenated and used as the visual encoder output. If none
                are provided, the last layer is used.
1259

1260
1261
1262
1263
1264
1265
        Returns:
            image_features: tensor of token features for
                all tokens of all images of shape (N_toks, D)
        """
        # pass images through initial convolution independently
        patch_embeds_list = [
1266
            self.patch_conv(img.unsqueeze(0).to(self.dtype)) for img in pixel_values
1267
1268
        ]

1269
        patch_embeds = [p.flatten(2).permute(0, 2, 1) for p in patch_embeds_list]
1270
1271
        embed_sizes = [p.shape[1] for p in patch_embeds]

1272
        # flatten to a single sequence
1273
        patch_embeds = torch.cat(patch_embeds, dim=1)
1274
1275
1276
1277
1278
        patch_embeds = self.ln_pre(patch_embeds)

        # positional embeddings
        position_ids = position_ids_in_meshgrid(
            patch_embeds_list,
1279
1280
1281
            max_width=self.config.image_size // self.config.patch_size,
        ).to(self.device)
        position_embedding = self.patch_positional_embedding(patch_embeds, position_ids)
1282
1283
1284

        if USE_XFORMERS_OPS:
            attention_mask = xops.fmha.attn_bias.BlockDiagonalMask.from_seqlens(
1285
1286
                [p.shape[-2] * p.shape[-1] for p in patch_embeds_list],
            )
1287
1288
        else:
            from transformers.models.pixtral.modeling_pixtral import (
1289
1290
1291
                generate_block_attention_mask,
            )

1292
            attention_mask = generate_block_attention_mask(
1293
1294
                [p.shape[-2] * p.shape[-1] for p in patch_embeds_list], patch_embeds
            )
1295

1296
1297
1298
1299
        out = self.transformer(
            patch_embeds,
            attention_mask,
            position_embedding,
1300
1301
            return_all_hidden_states=select_layers is not None,
        )
1302

1303
1304
1305
1306
1307
1308
1309
        out = resolve_visual_encoder_outputs(
            out,
            None,
            select_layers=select_layers,
            max_possible_layers=self.config.num_hidden_layers,
            feature_select_strategy=feature_select_strategy,
        )
1310

1311
        # squeeze dim 0 and split into separate tensors for each image
1312
        return torch.split(out.squeeze(0), embed_sizes)
1313
1314
1315

    # (TODO) Add prefix argument for filtering out weights to be loaded
    #        ref: https://github.com/vllm-project/vllm/pull/7186#discussion_r1734163986
1316
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
1317
1318
1319
1320
1321
1322
1323
1324
        stacked_params_mapping = [
            # (param_name, shard_name, shard_id)
            (".qkv_proj", ".q_proj", "q"),
            (".qkv_proj", ".k_proj", "k"),
            (".qkv_proj", ".v_proj", "v"),
            (".gate_up_proj", ".gate_proj", 0),
            (".gate_up_proj", ".up_proj", 1),
        ]
1325
        params_dict = dict(self.named_parameters())
1326
        loaded_params: set[str] = set()
1327
        layer_count = len(self.transformer.layers)
1328
1329

        for name, loaded_weight in weights:
1330
1331
1332
1333
1334
1335
            # omit layers when num_hidden_layers_override is set
            if name.startswith("transformer.layers"):
                layer_idx = int(name.split(".")[2])
                if layer_idx >= layer_count:
                    continue

1336
            for param_name, weight_name, shard_id in stacked_params_mapping:
1337
1338
                if weight_name not in name:
                    continue
1339
1340
                name = name.replace(weight_name, param_name)
                param = params_dict[name]
1341
1342
1343
1344
1345
                weight_loader = param.weight_loader
                weight_loader(param, loaded_weight, shard_id)
                break
            else:
                param = params_dict[name]
1346
                weight_loader = getattr(param, "weight_loader", default_weight_loader)
1347
                weight_loader(param, loaded_weight)
1348
1349
            loaded_params.add(name)
        return loaded_params