qwen2.py 21 KB
Newer Older
Junyang Lin's avatar
Junyang Lin committed
1
2
# Adapted from
# https://github.com/huggingface/transformers/blob/v4.28.0/src/transformers/models/qwen2/modeling_qwen2.py
3
4
# Copyright 2024 The Qwen team.
# Copyright 2023 The vLLM team.
Junyang Lin's avatar
Junyang Lin committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Copyright 2022 EleutherAI and the HuggingFace Inc. team. All rights reserved.
#
# This code is based on EleutherAI's GPT-NeoX library and the GPT-NeoX
# and OPT implementations in this library. It has been modified from its
# original forms to accommodate minor architectural differences compared
# to GPT-NeoX and OPT used by the Meta AI team that trained the model.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
23
"""Inference-only Qwen2 model compatible with HuggingFace weights."""
24
from typing import Iterable, List, Optional, Tuple, Union
Junyang Lin's avatar
Junyang Lin committed
25
26
27
28
29

import torch
from torch import nn
from transformers import Qwen2Config

30
from vllm.attention import Attention, AttentionMetadata
31
from vllm.compilation.decorators import support_torch_compile
32
from vllm.config import CacheConfig, VllmConfig
33
from vllm.distributed import get_pp_group, get_tensor_model_parallel_world_size
Junyang Lin's avatar
Junyang Lin committed
34
35
from vllm.model_executor.layers.activation import SiluAndMul
from vllm.model_executor.layers.layernorm import RMSNorm
36
from vllm.model_executor.layers.linear import (MergedColumnParallelLinear,
Junyang Lin's avatar
Junyang Lin committed
37
38
                                               QKVParallelLinear,
                                               RowParallelLinear)
39
from vllm.model_executor.layers.logits_processor import LogitsProcessor
40
from vllm.model_executor.layers.pooler import Pooler, PoolingType
41
from vllm.model_executor.layers.quantization import QuantizationConfig
42
from vllm.model_executor.layers.rotary_embedding import get_rope
Joe Runde's avatar
Joe Runde committed
43
from vllm.model_executor.layers.sampler import SamplerOutput, get_sampler
Junyang Lin's avatar
Junyang Lin committed
44
from vllm.model_executor.layers.vocab_parallel_embedding import (
45
    ParallelLMHead, VocabParallelEmbedding)
46
47
from vllm.model_executor.model_loader.weight_utils import (
    default_weight_loader, maybe_remap_kv_scale_name)
48
from vllm.model_executor.pooling_metadata import PoolingMetadata
Junyang Lin's avatar
Junyang Lin committed
49
from vllm.model_executor.sampling_metadata import SamplingMetadata
50
from vllm.sequence import IntermediateTensors, PoolerOutput
Junyang Lin's avatar
Junyang Lin committed
51

52
from .interfaces import SupportsLoRA, SupportsPP
53
from .utils import (AutoWeightsLoader, PPMissingLayer, is_pp_missing_parameter,
54
55
                    make_empty_intermediate_tensors_factory, make_layers,
                    maybe_prefix)
56

Junyang Lin's avatar
Junyang Lin committed
57
58
59
60
61
62
63
64

class Qwen2MLP(nn.Module):

    def __init__(
        self,
        hidden_size: int,
        intermediate_size: int,
        hidden_act: str,
65
        quant_config: Optional[QuantizationConfig] = None,
66
        prefix: str = "",
Junyang Lin's avatar
Junyang Lin committed
67
68
69
    ) -> None:
        super().__init__()
        self.gate_up_proj = MergedColumnParallelLinear(
70
71
72
73
74
75
76
77
78
            hidden_size,
            [intermediate_size] * 2,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.gate_up_proj",
        )
        self.down_proj = RowParallelLinear(
            intermediate_size,
            hidden_size,
Junyang Lin's avatar
Junyang Lin committed
79
            bias=False,
80
81
82
            quant_config=quant_config,
            prefix=f"{prefix}.down_proj",
        )
Junyang Lin's avatar
Junyang Lin committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
        if hidden_act != "silu":
            raise ValueError(f"Unsupported activation: {hidden_act}. "
                             "Only silu is supported for now.")
        self.act_fn = SiluAndMul()

    def forward(self, x):
        gate_up, _ = self.gate_up_proj(x)
        x = self.act_fn(gate_up)
        x, _ = self.down_proj(x)
        return x


class Qwen2Attention(nn.Module):

    def __init__(self,
                 hidden_size: int,
                 num_heads: int,
                 num_kv_heads: int,
                 max_position: int = 4096 * 32,
                 rope_theta: float = 10000,
103
                 cache_config: Optional[CacheConfig] = None,
104
                 quant_config: Optional[QuantizationConfig] = None,
105
106
                 rope_scaling: Optional[Tuple] = None,
                 prefix: str = "") -> None:
Junyang Lin's avatar
Junyang Lin committed
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
        super().__init__()
        self.hidden_size = hidden_size
        tp_size = get_tensor_model_parallel_world_size()
        self.total_num_heads = num_heads
        assert self.total_num_heads % tp_size == 0
        self.num_heads = self.total_num_heads // tp_size
        self.total_num_kv_heads = num_kv_heads
        if self.total_num_kv_heads >= tp_size:
            # Number of KV heads is greater than TP size, so we partition
            # the KV heads across multiple tensor parallel GPUs.
            assert self.total_num_kv_heads % tp_size == 0
        else:
            # Number of KV heads is less than TP size, so we replicate
            # the KV heads across multiple tensor parallel GPUs.
            assert tp_size % self.total_num_kv_heads == 0
        self.num_kv_heads = max(1, self.total_num_kv_heads // tp_size)
        self.head_dim = hidden_size // self.total_num_heads
        self.q_size = self.num_heads * self.head_dim
        self.kv_size = self.num_kv_heads * self.head_dim
        self.scaling = self.head_dim**-0.5
        self.rope_theta = rope_theta

        self.qkv_proj = QKVParallelLinear(
            hidden_size,
            self.head_dim,
            self.total_num_heads,
            self.total_num_kv_heads,
            bias=True,
135
            quant_config=quant_config,
136
            prefix=f"{prefix}.qkv_proj",
Junyang Lin's avatar
Junyang Lin committed
137
138
139
140
141
        )
        self.o_proj = RowParallelLinear(
            self.total_num_heads * self.head_dim,
            hidden_size,
            bias=False,
142
            quant_config=quant_config,
143
            prefix=f"{prefix}.o_proj",
Junyang Lin's avatar
Junyang Lin committed
144
145
146
147
148
149
150
        )

        self.rotary_emb = get_rope(
            self.head_dim,
            rotary_dim=self.head_dim,
            max_position=max_position,
            base=self.rope_theta,
151
            rope_scaling=rope_scaling,
Junyang Lin's avatar
Junyang Lin committed
152
        )
153
154
155
156
        self.attn = Attention(self.num_heads,
                              self.head_dim,
                              self.scaling,
                              num_kv_heads=self.num_kv_heads,
157
                              cache_config=cache_config,
158
159
                              quant_config=quant_config,
                              prefix=f"{prefix}.attn")
Junyang Lin's avatar
Junyang Lin committed
160
161
162
163
164

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
165
166
        kv_cache: torch.Tensor,
        attn_metadata: AttentionMetadata,
Junyang Lin's avatar
Junyang Lin committed
167
168
169
170
    ) -> torch.Tensor:
        qkv, _ = self.qkv_proj(hidden_states)
        q, k, v = qkv.split([self.q_size, self.kv_size, self.kv_size], dim=-1)
        q, k = self.rotary_emb(positions, q, k)
171
        attn_output = self.attn(q, k, v, kv_cache, attn_metadata)
Junyang Lin's avatar
Junyang Lin committed
172
173
174
175
176
177
178
179
180
        output, _ = self.o_proj(attn_output)
        return output


class Qwen2DecoderLayer(nn.Module):

    def __init__(
        self,
        config: Qwen2Config,
181
        cache_config: Optional[CacheConfig] = None,
182
        quant_config: Optional[QuantizationConfig] = None,
183
        prefix: str = "",
Junyang Lin's avatar
Junyang Lin committed
184
185
186
187
188
    ) -> None:
        super().__init__()
        self.hidden_size = config.hidden_size
        # Requires transformers > 4.32.0
        rope_theta = getattr(config, "rope_theta", 1000000)
189
        rope_scaling = getattr(config, "rope_scaling", None)
Junyang Lin's avatar
Junyang Lin committed
190
191
192
193
194
195
        self.self_attn = Qwen2Attention(
            hidden_size=self.hidden_size,
            num_heads=config.num_attention_heads,
            max_position=config.max_position_embeddings,
            num_kv_heads=config.num_key_value_heads,
            rope_theta=rope_theta,
196
            cache_config=cache_config,
197
            quant_config=quant_config,
198
199
200
            rope_scaling=rope_scaling,
            prefix=f"{prefix}.self_attn",
        )
Junyang Lin's avatar
Junyang Lin committed
201
202
203
204
        self.mlp = Qwen2MLP(
            hidden_size=self.hidden_size,
            intermediate_size=config.intermediate_size,
            hidden_act=config.hidden_act,
205
            quant_config=quant_config,
206
            prefix=f"{prefix}.mlp",
Junyang Lin's avatar
Junyang Lin committed
207
208
209
210
211
212
213
214
215
216
        )
        self.input_layernorm = RMSNorm(config.hidden_size,
                                       eps=config.rms_norm_eps)
        self.post_attention_layernorm = RMSNorm(config.hidden_size,
                                                eps=config.rms_norm_eps)

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
217
218
        kv_cache: torch.Tensor,
        attn_metadata: AttentionMetadata,
Junyang Lin's avatar
Junyang Lin committed
219
220
221
222
223
224
225
226
227
228
229
230
231
        residual: Optional[torch.Tensor],
    ) -> Tuple[torch.Tensor, torch.Tensor]:
        # Self Attention
        if residual is None:
            residual = hidden_states
            hidden_states = self.input_layernorm(hidden_states)
        else:
            hidden_states, residual = self.input_layernorm(
                hidden_states, residual)
        hidden_states = self.self_attn(
            positions=positions,
            hidden_states=hidden_states,
            kv_cache=kv_cache,
232
            attn_metadata=attn_metadata,
Junyang Lin's avatar
Junyang Lin committed
233
234
235
236
237
238
239
240
241
        )

        # Fully Connected
        hidden_states, residual = self.post_attention_layernorm(
            hidden_states, residual)
        hidden_states = self.mlp(hidden_states)
        return hidden_states, residual


242
@support_torch_compile
Junyang Lin's avatar
Junyang Lin committed
243
244
class Qwen2Model(nn.Module):

245
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
Junyang Lin's avatar
Junyang Lin committed
246
        super().__init__()
247
248
249
250
251

        config = vllm_config.model_config.hf_config
        cache_config = vllm_config.cache_config
        quant_config = vllm_config.quant_config

252
253
254
255
256
257
258
259
260
261
262
263
        # TODO (@robertgshaw2): see if this can be moved out
        if (cache_config.sliding_window is not None
                and hasattr(config, "max_window_layers")):
            raise ValueError("Sliding window for some but all layers is not "
                             "supported. This model uses sliding window "
                             "but `max_window_layers` = {} is less than "
                             "`num_hidden_layers` = {}. Please open an issue "
                             "to discuss this feature.".format(
                                 config.max_window_layers,
                                 config.num_hidden_layers,
                             ))

Junyang Lin's avatar
Junyang Lin committed
264
265
266
267
        self.config = config
        self.padding_idx = config.pad_token_id
        self.vocab_size = config.vocab_size

268
269
270
271
272
273
        if get_pp_group().is_first_rank or (config.tie_word_embeddings
                                            and get_pp_group().is_last_rank):
            self.embed_tokens = VocabParallelEmbedding(
                config.vocab_size,
                config.hidden_size,
                quant_config=quant_config,
274
                prefix=f"{prefix}.embed_tokens",
275
276
277
278
            )
        else:
            self.embed_tokens = PPMissingLayer()

279
280
281
282
        self.start_layer, self.end_layer, self.layers = make_layers(
            config.num_hidden_layers,
            lambda prefix: Qwen2DecoderLayer(config=config,
                                             cache_config=cache_config,
283
284
                                             quant_config=quant_config,
                                             prefix=f"{prefix}.layers"),
285
286
287
            prefix=f"{prefix}.layers",
        )

288
289
290
        self.make_empty_intermediate_tensors = (
            make_empty_intermediate_tensors_factory(
                ["hidden_states", "residual"], config.hidden_size))
291
292
293
294
        if get_pp_group().is_last_rank:
            self.norm = RMSNorm(config.hidden_size, eps=config.rms_norm_eps)
        else:
            self.norm = PPMissingLayer()
Junyang Lin's avatar
Junyang Lin committed
295

296
297
298
    def get_input_embeddings(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.embed_tokens(input_ids)

Junyang Lin's avatar
Junyang Lin committed
299
300
301
302
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
303
304
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
305
306
        intermediate_tensors: Optional[IntermediateTensors] = None,
        inputs_embeds: Optional[torch.Tensor] = None,
307
    ) -> Union[torch.Tensor, IntermediateTensors]:
308
309
310
311
312
313
        if get_pp_group().is_first_rank:
            if inputs_embeds is not None:
                hidden_states = inputs_embeds
            else:
                hidden_states = self.embed_tokens(input_ids)
            residual = None
314
        else:
315
316
317
318
            assert intermediate_tensors is not None
            hidden_states = intermediate_tensors["hidden_states"]
            residual = intermediate_tensors["residual"]
        for i in range(self.start_layer, self.end_layer):
Junyang Lin's avatar
Junyang Lin committed
319
320
321
322
            layer = self.layers[i]
            hidden_states, residual = layer(
                positions,
                hidden_states,
323
                kv_caches[i - self.start_layer],
324
                attn_metadata,
Junyang Lin's avatar
Junyang Lin committed
325
326
                residual,
            )
327
328
329
330
331
        if not get_pp_group().is_last_rank:
            return IntermediateTensors({
                "hidden_states": hidden_states,
                "residual": residual
            })
Junyang Lin's avatar
Junyang Lin committed
332
333
334
        hidden_states, _ = self.norm(hidden_states, residual)
        return hidden_states

335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
    def load_weights(self, weights: Iterable[Tuple[str, torch.Tensor]]):
        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),
        ]
        params_dict = dict(self.named_parameters(remove_duplicate=False))
        for name, loaded_weight in weights:
            if "rotary_emb.inv_freq" in name:
                continue
            for (param_name, weight_name, shard_id) in stacked_params_mapping:
                if weight_name not in name:
                    continue
                name = name.replace(weight_name, param_name)
                # Skip loading extra bias for GPTQ models.
                if name.endswith(".bias") and name not in params_dict:
                    continue
                if is_pp_missing_parameter(name, self):
                    continue
                param = params_dict[name]
                weight_loader = param.weight_loader
                weight_loader(param, loaded_weight, shard_id)
                break
            else:
                # Skip loading extra bias for GPTQ models.
                if name.endswith(".bias") and name not in params_dict:
                    continue
                # Remapping the name of FP8 kv-scale.
                name = maybe_remap_kv_scale_name(name, params_dict)
                if name is None:
                    continue
                if is_pp_missing_parameter(name, self):
                    continue
                param = params_dict[name]
                weight_loader = getattr(param, "weight_loader",
                                        default_weight_loader)
                weight_loader(param, loaded_weight)

Junyang Lin's avatar
Junyang Lin committed
376

377
class Qwen2ForCausalLM(nn.Module, SupportsLoRA, SupportsPP):
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
        "gate_up_proj": [
            "gate_proj",
            "up_proj",
        ],
    }

    # LoRA specific attributes
    supported_lora_modules = [
        "qkv_proj",
        "o_proj",
        "gate_up_proj",
        "down_proj",
    ]
    embedding_modules = {}
    embedding_padding_modules = []
chenqianfzh's avatar
chenqianfzh committed
399
400
401
402
403
404
405
406
407
408
409

    # BitandBytes specific attributes
    default_bitsandbytes_target_modules = [
        ".gate_proj.",
        ".down_proj.",
        ".up_proj.",
        ".q_proj.",
        ".k_proj.",
        ".v_proj.",
        ".o_proj.",
    ]
410
411
412
413
414
415
416
417
    bitsandbytes_stacked_params_mapping = {
        # shard_name, weight_name, index
        "q_proj": ("qkv_proj", 0),
        "k_proj": ("qkv_proj", 1),
        "v_proj": ("qkv_proj", 2),
        "gate_proj": ("gate_up_proj", 0),
        "up_proj": ("gate_up_proj", 1),
    }
Junyang Lin's avatar
Junyang Lin committed
418

419
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
420
421
422
423
        super().__init__()
        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
        lora_config = vllm_config.lora_config
424
        pooler_config = vllm_config.model_config.pooler_config
425

Junyang Lin's avatar
Junyang Lin committed
426
        self.config = config
427
428
        self.lora_config = lora_config

429
        self.quant_config = quant_config
430
        self.model = Qwen2Model(vllm_config=vllm_config,
431
                                prefix=maybe_prefix(prefix, "model"))
432

433
        if config.tie_word_embeddings:
434
            self.lm_head = self.model.embed_tokens
435
        else:
436
            self.lm_head = ParallelLMHead(config.vocab_size,
437
                                          config.hidden_size,
438
439
440
                                          quant_config=quant_config,
                                          prefix=maybe_prefix(
                                              prefix, "lm_head"))
441

442
        self.logits_processor = LogitsProcessor(config.vocab_size)
Joe Runde's avatar
Joe Runde committed
443
        self.sampler = get_sampler()
444
445
446
447
448
449
450
451
452

        # The same model class supports both language generation and embedding
        # because the architecture name is the same
        self._pooler = Pooler.from_config_with_defaults(
            pooler_config,
            pooling_type=PoolingType.LAST,
            normalize=True,
            softmax=False)

453
454
        self.make_empty_intermediate_tensors = (
            self.model.make_empty_intermediate_tensors)
Junyang Lin's avatar
Junyang Lin committed
455

456
457
458
    def get_input_embeddings(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.model.get_input_embeddings(input_ids)

Junyang Lin's avatar
Junyang Lin committed
459
460
461
462
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
463
464
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
465
        intermediate_tensors: Optional[IntermediateTensors] = None,
466
        inputs_embeds: Optional[torch.Tensor] = None,
467
    ) -> Union[torch.Tensor, IntermediateTensors]:
Junyang Lin's avatar
Junyang Lin committed
468
        hidden_states = self.model(input_ids, positions, kv_caches,
469
470
                                   attn_metadata, intermediate_tensors,
                                   inputs_embeds)
Junyang Lin's avatar
Junyang Lin committed
471
472
        return hidden_states

473
474
475
476
477
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[torch.Tensor]:
478
        logits = self.logits_processor(self.lm_head, hidden_states,
479
480
481
                                       sampling_metadata)
        return logits

Junyang Lin's avatar
Junyang Lin committed
482
483
    def sample(
        self,
484
        logits: torch.Tensor,
Junyang Lin's avatar
Junyang Lin committed
485
486
        sampling_metadata: SamplingMetadata,
    ) -> Optional[SamplerOutput]:
487
        next_tokens = self.sampler(logits, sampling_metadata)
Junyang Lin's avatar
Junyang Lin committed
488
489
        return next_tokens

490
491
492
493
494
495
496
    def pooler(
        self,
        hidden_states: torch.Tensor,
        pooling_metadata: PoolingMetadata,
    ) -> Optional[PoolerOutput]:
        return self._pooler(hidden_states, pooling_metadata)

497
    def load_weights(self, weights: Iterable[Tuple[str, torch.Tensor]]):
498
499
500
501
502
503
        loader = AutoWeightsLoader(
            self,
            skip_prefixes=(["lm_head."]
                           if self.config.tie_word_embeddings else None),
        )
        loader.load_weights(weights)
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570


class Qwen2EmbeddingModel(nn.Module, SupportsLoRA, SupportsPP):
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
        "gate_up_proj": [
            "gate_proj",
            "up_proj",
        ],
    }

    # LoRA specific attributes
    supported_lora_modules = [
        "qkv_proj",
        "o_proj",
        "gate_up_proj",
        "down_proj",
    ]
    embedding_modules = {}
    embedding_padding_modules = []

    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__()
        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
        lora_config = vllm_config.lora_config
        pooler_config = vllm_config.model_config.pooler_config

        self.config = config
        self.lora_config = lora_config

        self.quant_config = quant_config
        self.model = Qwen2Model(vllm_config=vllm_config,
                                prefix=maybe_prefix(prefix, "model"))

        self._pooler = Pooler.from_config_with_defaults(
            pooler_config,
            pooling_type=PoolingType.MEAN,
            normalize=True,
            softmax=False)

    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
        intermediate_tensors: Optional[IntermediateTensors] = None,
    ) -> torch.Tensor:
        return self.model(input_ids, positions, kv_caches, attn_metadata,
                          intermediate_tensors)

    def pooler(
        self,
        hidden_states: torch.Tensor,
        pooling_metadata: PoolingMetadata,
    ) -> Optional[PoolerOutput]:
        return self._pooler(hidden_states, pooling_metadata)

    def load_weights(self, weights: Iterable[Tuple[str, torch.Tensor]]):
        loader = AutoWeightsLoader(self,
                                   ignore_unexpected_prefixes=["lm_head."])
        loader.load_weights(weights)