mixtral.py 20.1 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

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

import torch
from torch import nn
29
from transformers import MixtralConfig
Pierre Stock's avatar
Pierre Stock committed
30

31
from vllm.attention import Attention, AttentionMetadata
32
from vllm.compilation.decorators import support_torch_compile
33
from vllm.config import CacheConfig, VllmConfig
34
from vllm.distributed import get_pp_group, get_tensor_model_parallel_world_size
35
from vllm.model_executor.layers.fused_moe import FusedMoE
Pierre Stock's avatar
Pierre Stock committed
36
from vllm.model_executor.layers.layernorm import RMSNorm
37
from vllm.model_executor.layers.linear import (QKVParallelLinear,
Philipp Moritz's avatar
Philipp Moritz committed
38
                                               ReplicatedLinear,
Pierre Stock's avatar
Pierre Stock committed
39
                                               RowParallelLinear)
40
from vllm.model_executor.layers.logits_processor import LogitsProcessor
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
Pierre Stock's avatar
Pierre Stock committed
44
from vllm.model_executor.layers.vocab_parallel_embedding import (
45
    DEFAULT_VOCAB_PADDING_SIZE, ParallelLMHead, VocabParallelEmbedding)
46
47
from vllm.model_executor.model_loader.weight_utils import (
    default_weight_loader, maybe_remap_kv_scale_name)
Pierre Stock's avatar
Pierre Stock committed
48
from vllm.model_executor.sampling_metadata import SamplingMetadata
49
from vllm.sequence import IntermediateTensors
Pierre Stock's avatar
Pierre Stock committed
50

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

Pierre Stock's avatar
Pierre Stock committed
56

Philipp Moritz's avatar
Philipp Moritz committed
57
58
59
60
61
62
63
64
class MixtralMoE(nn.Module):
    """A tensor-parallel MoE implementation for Mixtral that shards each expert
    across all ranks.

    Each expert's weights are sharded across all ranks and a fused MoE
    kernel is used for the forward pass, and finally we reduce the outputs
    across ranks.
    """
65

66
67
68
69
70
71
72
    def __init__(self,
                 num_experts: int,
                 top_k: int,
                 hidden_size: int,
                 intermediate_size: int,
                 params_dtype: Optional[torch.dtype] = None,
                 quant_config: Optional[QuantizationConfig] = None,
73
74
                 tp_size: Optional[int] = None,
                 prefix: str = ""):
75
        super().__init__()
Philipp Moritz's avatar
Philipp Moritz committed
76
        self.hidden_size = hidden_size
77

78
        # Gate always runs at half / full precision for now.
79

80
81
        self.gate = ReplicatedLinear(hidden_size,
                                     num_experts,
82
                                     bias=False,
83
                                     params_dtype=params_dtype,
84
85
                                     quant_config=None,
                                     prefix=f"{prefix}.gate")
86

87
88
89
90
91
92
93
94
        self.experts = FusedMoE(num_experts=num_experts,
                                top_k=top_k,
                                hidden_size=hidden_size,
                                intermediate_size=intermediate_size,
                                params_dtype=params_dtype,
                                reduce_results=True,
                                renormalize=True,
                                quant_config=quant_config,
95
96
                                tp_size=tp_size,
                                prefix=f"{prefix}.experts")
97

98
    def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
99
100
        # NOTE: hidden_states can have either 1D or 2D shape.
        orig_shape = hidden_states.shape
Philipp Moritz's avatar
Philipp Moritz committed
101
        hidden_states = hidden_states.view(-1, self.hidden_size)
102
        # router_logits: (num_tokens, n_experts)
103
        router_logits, _ = self.gate(hidden_states)
104
        final_hidden_states = self.experts(hidden_states, router_logits)
105
        return final_hidden_states.view(orig_shape)
Pierre Stock's avatar
Pierre Stock committed
106
107
108
109


class MixtralAttention(nn.Module):

110
111
112
113
114
115
116
117
118
    def __init__(
        self,
        hidden_size: int,
        num_heads: int,
        num_kv_heads: int,
        max_position: int = 4096 * 32,
        rope_theta: float = 10000,
        cache_config: Optional[CacheConfig] = None,
        quant_config: Optional[QuantizationConfig] = None,
119
        prefix: str = "",
120
    ) -> None:
Pierre Stock's avatar
Pierre Stock committed
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
        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

143
        self.qkv_proj = QKVParallelLinear(
Pierre Stock's avatar
Pierre Stock committed
144
145
146
147
148
            hidden_size,
            self.head_dim,
            self.total_num_heads,
            self.total_num_kv_heads,
            bias=False,
149
            quant_config=quant_config,
150
            prefix=f"{prefix}.qkv_proj",
Pierre Stock's avatar
Pierre Stock committed
151
        )
152
        self.o_proj = RowParallelLinear(
Pierre Stock's avatar
Pierre Stock committed
153
154
155
            self.total_num_heads * self.head_dim,
            hidden_size,
            bias=False,
156
            quant_config=quant_config,
157
            prefix=f"{prefix}.o_proj",
Pierre Stock's avatar
Pierre Stock committed
158
159
160
161
162
163
        )
        self.rotary_emb = get_rope(
            self.head_dim,
            rotary_dim=self.head_dim,
            max_position=max_position,
            base=int(self.rope_theta),
164
            is_neox_style=True,
Pierre Stock's avatar
Pierre Stock committed
165
        )
166
167
168
169
170
        self.attn = Attention(self.num_heads,
                              self.head_dim,
                              self.scaling,
                              num_kv_heads=self.num_kv_heads,
                              cache_config=cache_config,
171
172
                              quant_config=quant_config,
                              prefix=f"{prefix}.attn")
Pierre Stock's avatar
Pierre Stock committed
173
174
175
176
177

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
178
179
        kv_cache: torch.Tensor,
        attn_metadata: AttentionMetadata,
Pierre Stock's avatar
Pierre Stock committed
180
    ) -> torch.Tensor:
181
        qkv, _ = self.qkv_proj(hidden_states)
Pierre Stock's avatar
Pierre Stock committed
182
183
        q, k, v = qkv.split([self.q_size, self.kv_size, self.kv_size], dim=-1)
        q, k = self.rotary_emb(positions, q, k)
184
        attn_output = self.attn(q, k, v, kv_cache, attn_metadata)
185
        output, _ = self.o_proj(attn_output)
Pierre Stock's avatar
Pierre Stock committed
186
187
188
189
190
191
192
        return output


class MixtralDecoderLayer(nn.Module):

    def __init__(
        self,
193
        config: MixtralConfig,
194
        cache_config: Optional[CacheConfig] = None,
195
        quant_config: Optional[QuantizationConfig] = None,
196
        prefix: str = "",
Pierre Stock's avatar
Pierre Stock committed
197
198
199
200
201
    ) -> None:
        super().__init__()
        self.hidden_size = config.hidden_size
        # Requires transformers > 4.32.0
        rope_theta = getattr(config, "rope_theta", 10000)
202
        self.self_attn = MixtralAttention(
Pierre Stock's avatar
Pierre Stock committed
203
204
205
206
207
            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,
208
            cache_config=cache_config,
209
210
            quant_config=quant_config,
            prefix=f"{prefix}.self_attn")
Philipp Moritz's avatar
Philipp Moritz committed
211
212
213
214
        self.block_sparse_moe = MixtralMoE(
            num_experts=config.num_local_experts,
            top_k=config.num_experts_per_tok,
            hidden_size=config.hidden_size,
215
            intermediate_size=config.intermediate_size,
216
217
            quant_config=quant_config,
            prefix=f"{prefix}.block_sparse_moe")
218
219
220
221
        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)
Pierre Stock's avatar
Pierre Stock committed
222
223
224
225

    def forward(
        self,
        positions: torch.Tensor,
226
        hidden_states: torch.Tensor,
227
228
        kv_cache: torch.Tensor,
        attn_metadata: AttentionMetadata,
229
        residual: Optional[torch.Tensor],
Pierre Stock's avatar
Pierre Stock committed
230
    ) -> torch.Tensor:
231
232
233
234
235
236
237
238
        # 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(
Pierre Stock's avatar
Pierre Stock committed
239
            positions=positions,
240
            hidden_states=hidden_states,
Pierre Stock's avatar
Pierre Stock committed
241
            kv_cache=kv_cache,
242
            attn_metadata=attn_metadata,
Pierre Stock's avatar
Pierre Stock committed
243
244
        )

245
246
247
248
249
        # Fully Connected
        hidden_states, residual = self.post_attention_layernorm(
            hidden_states, residual)
        hidden_states = self.block_sparse_moe(hidden_states)
        return hidden_states, residual
Pierre Stock's avatar
Pierre Stock committed
250

251

252
@support_torch_compile
253
class MixtralModel(nn.Module):
Pierre Stock's avatar
Pierre Stock committed
254

255
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
Pierre Stock's avatar
Pierre Stock committed
256
        super().__init__()
257
258
259
260
261
262

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

Pierre Stock's avatar
Pierre Stock committed
263
        self.padding_idx = config.pad_token_id
264
265
266
267
        lora_vocab = (lora_config.lora_extra_vocab_size *
                      (lora_config.max_loras or 1)) if lora_config else 0
        self.vocab_size = config.vocab_size + lora_vocab
        self.org_vocab_size = config.vocab_size
268
269

        self.embed_tokens = VocabParallelEmbedding(
270
            self.vocab_size,
Pierre Stock's avatar
Pierre Stock committed
271
            config.hidden_size,
272
            org_num_embeddings=config.vocab_size,
Pierre Stock's avatar
Pierre Stock committed
273
        )
274
275

        self.start_layer, self.end_layer, self.layers = make_layers(
276
277
278
279
280
            config.num_hidden_layers,
            lambda prefix: MixtralDecoderLayer(
                config, cache_config, quant_config=quant_config, prefix=prefix
            ),
            prefix=f"{prefix}.layers")
281

282
        self.norm = RMSNorm(config.hidden_size, eps=config.rms_norm_eps)
283
284
285
        self.make_empty_intermediate_tensors = (
            make_empty_intermediate_tensors_factory(
                ["hidden_states", "residual"], config.hidden_size))
Pierre Stock's avatar
Pierre Stock committed
286

287
288
289
    def get_input_embeddings(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.embed_tokens(input_ids)

Pierre Stock's avatar
Pierre Stock committed
290
291
292
293
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
294
295
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
296
        intermediate_tensors: Optional[IntermediateTensors],
297
        inputs_embeds: Optional[torch.Tensor] = None,
298
    ) -> Union[torch.Tensor, IntermediateTensors]:
299
        if get_pp_group().is_first_rank:
300
301
302
303
            if inputs_embeds is not None:
                hidden_states = inputs_embeds
            else:
                hidden_states = self.get_input_embeddings(input_ids)
304
305
306
307
308
309
            residual = None
        else:
            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):
Pierre Stock's avatar
Pierre Stock committed
310
            layer = self.layers[i]
311
            hidden_states, residual = layer(positions, hidden_states,
312
313
314
315
316
317
318
                                            kv_caches[i - self.start_layer],
                                            attn_metadata, residual)
        if not get_pp_group().is_last_rank:
            return IntermediateTensors({
                "hidden_states": hidden_states,
                "residual": residual
            })
319
320
321
322
        hidden_states, _ = self.norm(hidden_states, residual)
        return hidden_states


323
class MixtralForCausalLM(nn.Module, SupportsLoRA, SupportsPP):
324
325
    fall_back_to_pt_during_load = False

Terry's avatar
Terry committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
    packed_modules_mapping = {
        "qkv_proj": [
            "q_proj",
            "k_proj",
            "v_proj",
        ],
    }

    # LoRA specific attributes
    embedding_modules = {
        "embed_tokens": "input_embeddings",
        "lm_head": "output_embeddings",
    }
    embedding_padding_modules = ["lm_head"]
340

341
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
342
        super().__init__()
343
344
345
        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
        lora_config = vllm_config.lora_config
346
        self.config = config
347
        self.lora_config = lora_config
348
        self.quant_config = quant_config
349

350
351
        self.model = MixtralModel(vllm_config=vllm_config,
                                  prefix=maybe_prefix(prefix, "model"))
Terry's avatar
Terry committed
352
353
354
355
356
357
358
359
360
361
362
        self.unpadded_vocab_size = config.vocab_size
        if lora_config:
            self.unpadded_vocab_size += lora_config.lora_extra_vocab_size
        self.lm_head = ParallelLMHead(
            self.unpadded_vocab_size,
            config.hidden_size,
            org_num_embeddings=config.vocab_size,
            padding_size=DEFAULT_VOCAB_PADDING_SIZE
            # We need bigger padding if using lora for kernel
            # compatibility
            if not lora_config else lora_config.lora_vocab_padding_size,
363
            quant_config=quant_config,
Terry's avatar
Terry committed
364
        )
365
366
        if self.config.tie_word_embeddings:
            self.lm_head.weight = self.model.embed_tokens.weight
367
368
        self.logits_processor = LogitsProcessor(self.unpadded_vocab_size,
                                                config.vocab_size)
Joe Runde's avatar
Joe Runde committed
369
        self.sampler = get_sampler()
370
371
        self.make_empty_intermediate_tensors = (
            self.model.make_empty_intermediate_tensors)
372

373
374
375
    def get_input_embeddings(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.model.get_input_embeddings(input_ids)

376
377
378
379
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
380
381
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
382
        intermediate_tensors: Optional[IntermediateTensors] = None,
383
        inputs_embeds: Optional[torch.Tensor] = None,
384
    ) -> Union[torch.Tensor, IntermediateTensors]:
385
        hidden_states = self.model(input_ids, positions, kv_caches,
386
387
                                   attn_metadata, intermediate_tensors,
                                   inputs_embeds)
Pierre Stock's avatar
Pierre Stock committed
388
389
        return hidden_states

390
391
392
393
394
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[torch.Tensor]:
395
        logits = self.logits_processor(self.lm_head, hidden_states,
396
397
398
                                       sampling_metadata)
        return logits

Pierre Stock's avatar
Pierre Stock committed
399
400
    def sample(
        self,
401
        logits: Optional[torch.Tensor],
Pierre Stock's avatar
Pierre Stock committed
402
        sampling_metadata: SamplingMetadata,
403
    ) -> Optional[SamplerOutput]:
404
        next_tokens = self.sampler(logits, sampling_metadata)
Pierre Stock's avatar
Pierre Stock committed
405
406
        return next_tokens

407
408
    def load_weights(self, weights: Iterable[Tuple[str,
                                                   torch.Tensor]]) -> Set[str]:
Pierre Stock's avatar
Pierre Stock committed
409
410
        stacked_params_mapping = [
            # (param_name, shard_name, shard_id)
411
412
413
            ("qkv_proj", "q_proj", "q"),
            ("qkv_proj", "k_proj", "k"),
            ("qkv_proj", "v_proj", "v"),
Pierre Stock's avatar
Pierre Stock committed
414
        ]
415

416
417
418
419
420
421
422
        # Params for weights, fp8 weight scales, fp8 activation scales
        # (param_name, weight_name, expert_id, shard_id)
        expert_params_mapping = FusedMoE.make_expert_params_mapping(
            ckpt_gate_proj_name="w1",
            ckpt_down_proj_name="w2",
            ckpt_up_proj_name="w3",
            num_experts=self.config.num_local_experts)
Philipp Moritz's avatar
Philipp Moritz committed
423

Pierre Stock's avatar
Pierre Stock committed
424
        params_dict = dict(self.named_parameters())
425
        loaded_params: Set[str] = set()
426
        for name, loaded_weight in weights:
Pierre Stock's avatar
Pierre Stock committed
427
428
            if "rotary_emb.inv_freq" in name:
                continue
Philipp Moritz's avatar
Philipp Moritz committed
429

430
431
            if (self.quant_config is not None and
                (scale_name := self.quant_config.get_cache_scale(name))):
432
                # Loading kv cache quantization scales
433
434
435
436
437
438
439
440
441
                param = params_dict[scale_name]
                weight_loader = getattr(param, "weight_loader",
                                        default_weight_loader)
                loaded_weight = (loaded_weight if loaded_weight.dim() == 0 else
                                 loaded_weight[0])
                weight_loader(param, loaded_weight)
                loaded_params.add(scale_name)
                continue

Pierre Stock's avatar
Pierre Stock committed
442
443
444
            for (param_name, weight_name, shard_id) in stacked_params_mapping:
                if weight_name not in name:
                    continue
CHU Tianxiang's avatar
CHU Tianxiang committed
445
446
                name = name.replace(weight_name, param_name)
                # Skip loading extra bias for GPTQ models.
447
448
                if ((name.endswith(".bias") or name.endswith("_bias"))
                        and name not in params_dict):
CHU Tianxiang's avatar
CHU Tianxiang committed
449
                    continue
450
451
452
                # Skip layers on other devices.
                if is_pp_missing_parameter(name, self):
                    continue
453
454
455
456
457
                if name.endswith("scale"):
                    # Remapping the name of FP8 kv-scale.
                    name = maybe_remap_kv_scale_name(name, params_dict)
                    if name is None:
                        continue
CHU Tianxiang's avatar
CHU Tianxiang committed
458
                param = params_dict[name]
Pierre Stock's avatar
Pierre Stock committed
459
460
461
462
                weight_loader = param.weight_loader
                weight_loader(param, loaded_weight, shard_id)
                break
            else:
463
464
                for mapping in expert_params_mapping:
                    param_name, weight_name, expert_id, shard_id = mapping
Philipp Moritz's avatar
Philipp Moritz committed
465
466
467
                    if weight_name not in name:
                        continue
                    name = name.replace(weight_name, param_name)
468
469
470
                    # Skip layers on other devices.
                    if is_pp_missing_parameter(name, self):
                        continue
471
472
473
                    if ((name.endswith(".bias") or name.endswith("_bias"))
                            and name not in params_dict):
                        continue
Philipp Moritz's avatar
Philipp Moritz committed
474
475
476
477
                    param = params_dict[name]
                    weight_loader = param.weight_loader
                    weight_loader(param,
                                  loaded_weight,
478
                                  name,
479
                                  shard_id=shard_id,
Philipp Moritz's avatar
Philipp Moritz committed
480
481
482
483
                                  expert_id=expert_id)
                    break
                else:
                    # Skip loading extra bias for GPTQ models.
484
485
                    if ((name.endswith(".bias") or name.endswith("_bias"))
                            and name not in params_dict):
Philipp Moritz's avatar
Philipp Moritz committed
486
                        continue
487
488
489
                    # Skip layers on other devices.
                    if is_pp_missing_parameter(name, self):
                        continue
490
                    # Remapping the name of FP8 kv-scale.
491
492
493
494
                    name = maybe_remap_kv_scale_name(name, params_dict)
                    if name is None:
                        continue

Philipp Moritz's avatar
Philipp Moritz committed
495
496
497
498
                    param = params_dict[name]
                    weight_loader = getattr(param, "weight_loader",
                                            default_weight_loader)
                    weight_loader(param, loaded_weight)
499
500
            loaded_params.add(name)
        return loaded_params