deepseek_v2.py 57.5 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

wangding zeng's avatar
wangding zeng committed
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 2023 DeepSeek-AI 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.
25
"""Inference-only DeepseekV2/DeepseekV3 model."""
26

27
28
import typing
from collections.abc import Callable, Iterable
29
from itertools import islice
wangding zeng's avatar
wangding zeng committed
30

31
32
import os
import re
wangding zeng's avatar
wangding zeng committed
33
34
import torch
from torch import nn
35
from transformers import DeepseekV2Config, DeepseekV3Config
wangding zeng's avatar
wangding zeng committed
36

37
from vllm._aiter_ops import rocm_aiter_ops
38
from vllm.attention.layer import Attention
39
from vllm.compilation.decorators import support_torch_compile
40
41
42
43
44
45
46
47
from vllm.config import CacheConfig, ParallelConfig, VllmConfig, get_current_vllm_config
from vllm.distributed import (
    get_ep_group,
    get_pp_group,
    get_tensor_model_parallel_rank,
    get_tensor_model_parallel_world_size,
    tensor_model_parallel_all_gather,
)
48
from vllm.logger import init_logger
wangding zeng's avatar
wangding zeng committed
49
from vllm.model_executor.layers.activation import SiluAndMul
50
from vllm.model_executor.layers.attention_layer_base import AttentionLayerBase
51
from vllm.model_executor.layers.fused_moe import SharedFusedMoE
52
from vllm.model_executor.layers.layernorm import LayerNorm, RMSNorm
53
54
55
from vllm.model_executor.layers.linear import (
    ColumnParallelLinear,
    MergedColumnParallelLinear,
56
    QKVParallelLinear,
57
58
59
    ReplicatedLinear,
    RowParallelLinear,
)
wangding zeng's avatar
wangding zeng committed
60
from vllm.model_executor.layers.logits_processor import LogitsProcessor
61
from vllm.model_executor.layers.mla import MLAModules, MultiHeadLatentAttentionWrapper
62
from vllm.model_executor.layers.quantization import QuantizationConfig
63
from vllm.model_executor.layers.quantization.utils.fp8_utils import (
64
65
    per_token_group_quant_fp8,
)
wangding zeng's avatar
wangding zeng committed
66
from vllm.model_executor.layers.rotary_embedding import get_rope
67
from vllm.model_executor.layers.sparse_attn_indexer import SparseAttnIndexer
wangding zeng's avatar
wangding zeng committed
68
from vllm.model_executor.layers.vocab_parallel_embedding import (
69
70
71
    ParallelLMHead,
    VocabParallelEmbedding,
)
72
from vllm.model_executor.model_loader.weight_utils import (
73
74
75
    default_weight_loader,
    maybe_remap_kv_scale_name,
)
76
from vllm.model_executor.models.utils import sequence_parallel_chunk
77
from vllm.platforms import current_platform
78
from vllm.sequence import IntermediateTensors
79
from vllm.v1.attention.backend import AttentionBackend
80
81
82
from vllm.v1.attention.backends.mla.indexer import (
    DeepseekV32IndexerBackend,
)
83
from vllm.v1.kv_cache_interface import KVCacheSpec, MLAAttentionSpec
wangding zeng's avatar
wangding zeng committed
84

85
from .interfaces import MixtureOfExperts, SupportsEagle, SupportsLoRA, SupportsPP
86
87
88
89
90
91
92
from .utils import (
    PPMissingLayer,
    is_pp_missing_parameter,
    make_empty_intermediate_tensors_factory,
    make_layers,
    maybe_prefix,
)
93

94
95
logger = init_logger(__name__)

wangding zeng's avatar
wangding zeng committed
96

97
98
99
100
101
102
103
104
105
106
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
class DeepseekAttention(nn.Module):
    """Normal MHA implementation used by Deepseek v1."""

    def __init__(
        self,
        vllm_config: VllmConfig,
        config: DeepseekV2Config | DeepseekV3Config,
        hidden_size: int,
        num_heads: int,
        max_position_embeddings: int = 8192,
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
        prefix: str = "",
        **kwargs,
    ) -> None:
        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 = config.num_key_value_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.max_position_embeddings = max_position_embeddings

        self.qkv_proj = QKVParallelLinear(
            hidden_size,
            self.head_dim,
            self.total_num_heads,
            self.total_num_kv_heads,
            bias=False,
            quant_config=quant_config,
        )

        self.o_proj = RowParallelLinear(
            self.total_num_heads * self.head_dim,
            hidden_size,
            bias=False,
            quant_config=quant_config,
        )

        self.rotary_emb = get_rope(
            self.head_dim,
            max_position=max_position_embeddings,
153
            rope_parameters=config.rope_parameters,
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
        )
        self.attn = Attention(
            self.num_heads,
            self.head_dim,
            self.scaling,
            num_kv_heads=self.num_kv_heads,
            cache_config=cache_config,
            quant_config=quant_config,
            prefix=f"{prefix}.attn",
        )

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
    ) -> 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)
        attn_output = self.attn(q, k, v)
        output, _ = self.o_proj(attn_output)
        return output

wangding zeng's avatar
wangding zeng committed
177
178
179
180
181
182
183

class DeepseekV2MLP(nn.Module):
    def __init__(
        self,
        hidden_size: int,
        intermediate_size: int,
        hidden_act: str,
184
        quant_config: QuantizationConfig | None = None,
wangding zeng's avatar
wangding zeng committed
185
        reduce_results: bool = True,
186
        is_sequence_parallel=False,
187
        prefix: str = "",
wangding zeng's avatar
wangding zeng committed
188
189
    ) -> None:
        super().__init__()
190
191
192
193
194

        # If is_sequence_parallel, the input and output tensors are sharded
        # across the ranks within the tp_group. In this case the weights are
        # replicated and no collective ops are needed.
        # Otherwise we use standard TP with an allreduce at the end.
wangding zeng's avatar
wangding zeng committed
195
        self.gate_up_proj = MergedColumnParallelLinear(
196
197
            hidden_size,
            [intermediate_size] * 2,
wangding zeng's avatar
wangding zeng committed
198
            bias=False,
199
            quant_config=quant_config,
200
            disable_tp=is_sequence_parallel,
201
202
203
204
205
            prefix=f"{prefix}.gate_up_proj",
        )
        self.down_proj = RowParallelLinear(
            intermediate_size,
            hidden_size,
wangding zeng's avatar
wangding zeng committed
206
            bias=False,
207
            quant_config=quant_config,
208
            reduce_results=reduce_results,
209
            disable_tp=is_sequence_parallel,
210
211
            prefix=f"{prefix}.down_proj",
        )
wangding zeng's avatar
wangding zeng committed
212
        if hidden_act != "silu":
213
214
215
            raise ValueError(
                f"Unsupported activation: {hidden_act}. Only silu is supported for now."
            )
wangding zeng's avatar
wangding zeng committed
216
217
218
219
220
221
222
223
224
225
226
227
        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 DeepseekV2MoE(nn.Module):
    def __init__(
        self,
228
        config: DeepseekV2Config | DeepseekV3Config,
229
        parallel_config: ParallelConfig,
230
        quant_config: QuantizationConfig | None = None,
231
        prefix: str = "",
wangding zeng's avatar
wangding zeng committed
232
233
234
    ):
        super().__init__()
        self.tp_size = get_tensor_model_parallel_world_size()
235
236
        self.tp_rank = get_tensor_model_parallel_rank()

237
        self.routed_scaling_factor = getattr(config, "routed_scaling_factor", 1.0)
238
239

        self.ep_group = get_ep_group().device_group
240
        self.ep_rank = get_ep_group().rank_in_group
241
242
243
        self.ep_size = self.ep_group.size()
        self.n_routed_experts: int = config.n_routed_experts
        self.n_shared_experts: int = config.n_shared_experts
244

245
        self.is_sequence_parallel = parallel_config.use_sequence_parallel_moe
246

247
        if config.hidden_act != "silu":
248
249
250
251
252
253
254
255
256
257
258
259
            raise ValueError(
                f"Unsupported activation: {config.hidden_act}. "
                "Only silu is supported for now."
            )

        self.gate = ReplicatedLinear(
            config.hidden_size,
            config.n_routed_experts,
            bias=False,
            quant_config=None,
            prefix=f"{prefix}.gate",
        )
260
        if getattr(config, "topk_method", None) == "noaux_tc":
261
            self.gate.e_score_correction_bias = nn.Parameter(
262
263
                torch.empty(config.n_routed_experts, dtype=torch.float32)
            )
264
265
266
        else:
            self.gate.e_score_correction_bias = None

267
        # Load balancing settings.
268
269
        eplb_config = parallel_config.eplb_config
        self.enable_eplb = parallel_config.enable_eplb
270

271
        self.n_redundant_experts = eplb_config.num_redundant_experts
272
        self.n_logical_experts = self.n_routed_experts
273
        self.n_physical_experts = self.n_logical_experts + self.n_redundant_experts
274
275
        self.n_local_physical_experts = self.n_physical_experts // self.ep_size

276
277
278
279
        self.physical_expert_start = self.ep_rank * self.n_local_physical_experts
        self.physical_expert_end = (
            self.physical_expert_start + self.n_local_physical_experts
        )
280

281
        self.is_rocm_aiter_moe_enabled = rocm_aiter_ops.is_fused_moe_enabled()
282
283
284
285
        self.is_fusion_moe_shared_experts_enabled = (
            rocm_aiter_ops.is_fusion_moe_shared_experts_enabled()
        )
        if config.n_shared_experts is None or self.is_fusion_moe_shared_experts_enabled:
286
287
            self.shared_experts = None
        else:
288
            intermediate_size = config.moe_intermediate_size * config.n_shared_experts
289

wangding zeng's avatar
wangding zeng committed
290
291
292
293
294
            self.shared_experts = DeepseekV2MLP(
                hidden_size=config.hidden_size,
                intermediate_size=intermediate_size,
                hidden_act=config.hidden_act,
                quant_config=quant_config,
295
                is_sequence_parallel=self.is_sequence_parallel,
296
                reduce_results=False,
297
                prefix=f"{prefix}.shared_experts",
wangding zeng's avatar
wangding zeng committed
298
299
            )

300
301
        self.experts = SharedFusedMoE(
            shared_experts=self.shared_experts,
302
            gate=self.gate,
303
304
305
306
307
308
309
310
            num_experts=config.n_routed_experts,
            top_k=config.num_experts_per_tok,
            hidden_size=config.hidden_size,
            intermediate_size=config.moe_intermediate_size,
            reduce_results=False,
            renormalize=config.norm_topk_prob,
            quant_config=quant_config,
            use_grouped_topk=True,
311
312
            num_expert_group=getattr(config, "n_group", 1),
            topk_group=getattr(config, "topk_group", 1),
313
            prefix=f"{prefix}.experts",
314
            scoring_func=getattr(config, "scoring_func", "softmax"),
315
            # we do scaling outside, set factor to 1.0 to avoid double mul
316
317
            # aiter applies routed_scaling_factor internally
            routed_scaling_factor=1.0
318
            if not self.is_rocm_aiter_moe_enabled
319
            else self.routed_scaling_factor,
320
321
322
323
            e_score_correction_bias=self.gate.e_score_correction_bias,
            enable_eplb=self.enable_eplb,
            num_redundant_experts=self.n_redundant_experts,
            is_sequence_parallel=self.is_sequence_parallel,
324
            n_shared_experts=config.n_shared_experts
325
            if self.is_fusion_moe_shared_experts_enabled
326
            else None,
327
        )
328

wangding zeng's avatar
wangding zeng committed
329
330
331
    def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
        num_tokens, hidden_dim = hidden_states.shape
        hidden_states = hidden_states.view(-1, hidden_dim)
332
333
334
335
336
337

        # Chunk the hidden states so they aren't replicated across TP ranks.
        # This avoids duplicate computation in self.experts.
        # TODO: We can replace the all_reduce at the end of attn with a
        # reduce_scatter instead of chunking here.
        if self.is_sequence_parallel:
338
            hidden_states = sequence_parallel_chunk(hidden_states)
339

340
341
342
343
344
        if self.experts.is_internal_router:
            # In this case, the gate/router runs inside the FusedMoE class
            fused_moe_out = self.experts(
                hidden_states=hidden_states, router_logits=hidden_states
            )
345
        else:
346
347
348
349
350
            # router_logits: (num_tokens, n_experts)
            router_logits, _ = self.gate(hidden_states)
            fused_moe_out = self.experts(
                hidden_states=hidden_states, router_logits=router_logits
            )
351

352
353
354
        shared_output, final_hidden_states = fused_moe_out
        if self.shared_experts is None:
            assert shared_output is None
355
356
357
358

        # Fix FP16 overflow
        # See DeepseekV2DecoderLayer for more details.
        if hidden_states.dtype != torch.float16:
359
            if not self.is_rocm_aiter_moe_enabled:
360
                final_hidden_states *= self.routed_scaling_factor
361
362
        elif self.shared_experts is not None:
            assert shared_output is not None
363
            shared_output *= 1.0 / self.routed_scaling_factor
364
365
366
367

        if self.shared_experts is not None:
            assert shared_output is not None
            final_hidden_states += shared_output
368

369
370
        if self.is_sequence_parallel:
            final_hidden_states = tensor_model_parallel_all_gather(
371
372
                final_hidden_states, 0
            )
373
374
            final_hidden_states = final_hidden_states[:num_tokens]
        elif self.tp_size > 1:
375
376
377
            final_hidden_states = self.experts.maybe_all_reduce_tensor_model_parallel(
                final_hidden_states
            )
wangding zeng's avatar
wangding zeng committed
378
379
380
381
382
383

        return final_hidden_states.view(num_tokens, hidden_dim)


def yarn_get_mscale(scale: float = 1, mscale: float = 1) -> float:
    import math
384

wangding zeng's avatar
wangding zeng committed
385
386
387
388
389
    if scale <= 1:
        return 1.0
    return 0.1 * mscale * math.log(scale) + 1.0


390
391
392
393
394
395
396
397
398
399
def _get_llama_4_scaling(
    original_max_position_embeddings: int, scaling_beta: float, positions: torch.Tensor
) -> torch.Tensor:
    scaling = 1 + scaling_beta * torch.log(
        1 + torch.floor(positions / original_max_position_embeddings)
    )
    # Broadcast over num_heads and head_dim
    return scaling[..., None, None]


wangding zeng's avatar
wangding zeng committed
400
401
402
class DeepseekV2Attention(nn.Module):
    def __init__(
        self,
403
        vllm_config: VllmConfig,
404
        config: DeepseekV2Config | DeepseekV3Config,
wangding zeng's avatar
wangding zeng committed
405
406
407
408
409
410
411
412
        hidden_size: int,
        num_heads: int,
        qk_nope_head_dim: int,
        qk_rope_head_dim: int,
        v_head_dim: int,
        q_lora_rank: int,
        kv_lora_rank: int,
        max_position_embeddings: int = 8192,
413
414
415
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
        topk_indices_buffer: torch.Tensor | None = None,
416
        prefix: str = "",
wangding zeng's avatar
wangding zeng committed
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
    ) -> None:
        super().__init__()
        self.hidden_size = hidden_size
        self.qk_nope_head_dim = qk_nope_head_dim
        self.qk_rope_head_dim = qk_rope_head_dim
        self.qk_head_dim = qk_nope_head_dim + qk_rope_head_dim
        self.v_head_dim = v_head_dim
        self.q_lora_rank = q_lora_rank
        self.kv_lora_rank = kv_lora_rank
        self.num_heads = num_heads
        tp_size = get_tensor_model_parallel_world_size()
        assert num_heads % tp_size == 0
        self.num_local_heads = num_heads // tp_size
        self.scaling = self.qk_head_dim**-0.5
        self.max_position_embeddings = max_position_embeddings
432
433
        assert topk_indices_buffer is None, (
            "topk_indices_buffer is not \
434
        supported for DeepseekV2Attention"
435
        )
wangding zeng's avatar
wangding zeng committed
436
437

        if self.q_lora_rank is not None:
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
            self.q_a_proj = ReplicatedLinear(
                self.hidden_size,
                self.q_lora_rank,
                bias=False,
                quant_config=quant_config,
                prefix=f"{prefix}.q_a_proj",
            )
            self.q_a_layernorm = RMSNorm(self.q_lora_rank, eps=config.rms_norm_eps)
            self.q_b_proj = ColumnParallelLinear(
                q_lora_rank,
                self.num_heads * self.qk_head_dim,
                bias=False,
                quant_config=quant_config,
                prefix=f"{prefix}.q_b_proj",
            )
wangding zeng's avatar
wangding zeng committed
453
        else:
454
455
456
457
458
459
460
            self.q_proj = ColumnParallelLinear(
                self.hidden_size,
                self.num_heads * self.qk_head_dim,
                bias=False,
                quant_config=quant_config,
                prefix=f"{prefix}.q_proj",
            )
wangding zeng's avatar
wangding zeng committed
461

462
463
464
465
466
        self.kv_a_proj_with_mqa = ReplicatedLinear(
            self.hidden_size,
            self.kv_lora_rank + self.qk_rope_head_dim,
            bias=False,
            quant_config=quant_config,
467
468
469
            prefix=f"{prefix}.kv_a_proj_with_mqa",
        )
        self.kv_a_layernorm = RMSNorm(self.kv_lora_rank, eps=config.rms_norm_eps)
wangding zeng's avatar
wangding zeng committed
470
471
472
473
        self.kv_b_proj = ColumnParallelLinear(
            self.kv_lora_rank,
            self.num_heads * (self.qk_nope_head_dim + self.v_head_dim),
            bias=False,
474
            quant_config=quant_config,
475
476
            prefix=f"{prefix}.kv_b_proj",
        )
wangding zeng's avatar
wangding zeng committed
477
        # O projection.
478
479
480
481
482
483
484
        self.o_proj = RowParallelLinear(
            self.num_heads * self.v_head_dim,
            self.hidden_size,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.o_proj",
        )
485
        if config.rope_parameters["rope_type"] != "default":
486
487
488
489
490
            config.rope_parameters["rope_type"] = (
                "deepseek_yarn"
                if config.rope_parameters.get("apply_yarn_scaling", True)
                else "deepseek_llama_scaling"
            )
491

492
493
494
        self.rotary_emb = get_rope(
            qk_rope_head_dim,
            max_position=max_position_embeddings,
495
            rope_parameters=config.rope_parameters,
496
497
            is_neox_style=False,
        )
wangding zeng's avatar
wangding zeng committed
498

499
500
501
502
        if (
            config.rope_parameters["rope_type"] != "default"
            and config.rope_parameters["rope_type"] == "deepseek_yarn"
        ):
503
504
            mscale_all_dim = config.rope_parameters.get("mscale_all_dim", False)
            scaling_factor = config.rope_parameters["factor"]
wangding zeng's avatar
wangding zeng committed
505
506
507
            mscale = yarn_get_mscale(scaling_factor, float(mscale_all_dim))
            self.scaling = self.scaling * mscale * mscale

508
509
510
511
512
513
514
515
516
        self.attn = Attention(
            self.num_local_heads,
            self.qk_head_dim,
            self.scaling,
            num_kv_heads=self.num_local_heads,
            cache_config=cache_config,
            quant_config=quant_config,
            prefix=f"{prefix}.attn",
        )
wangding zeng's avatar
wangding zeng committed
517
518
519
520
521

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
522
        llama_4_scaling: torch.Tensor | None,
wangding zeng's avatar
wangding zeng committed
523
524
525
526
    ) -> torch.Tensor:
        if self.q_lora_rank is not None:
            q = self.q_a_proj(hidden_states)[0]
            q = self.q_a_layernorm(q)
527
            q = self.q_b_proj(q)[0].view(-1, self.num_local_heads, self.qk_head_dim)
wangding zeng's avatar
wangding zeng committed
528
        else:
529
530
531
532
            q = self.q_proj(hidden_states)[0].view(
                -1, self.num_local_heads, self.qk_head_dim
            )
        q_nope, q_pe = q.split([self.qk_nope_head_dim, self.qk_rope_head_dim], dim=-1)
wangding zeng's avatar
wangding zeng committed
533
        latent_cache = self.kv_a_proj_with_mqa(hidden_states)[0]
534
        kv_a, _ = latent_cache.split([self.kv_lora_rank, self.qk_rope_head_dim], dim=-1)
wangding zeng's avatar
wangding zeng committed
535
        latent_cache = latent_cache.unsqueeze(1)
536
        kv_a = self.kv_a_layernorm(kv_a)
wangding zeng's avatar
wangding zeng committed
537
        kv = self.kv_b_proj(kv_a)[0]
538
        kv = kv.view(-1, self.num_local_heads, self.qk_nope_head_dim + self.v_head_dim)
wangding zeng's avatar
wangding zeng committed
539
        k_nope, v = kv.split([self.qk_nope_head_dim, self.v_head_dim], dim=-1)
540
        k_pe = latent_cache[:, :, self.kv_lora_rank :]
541

wangding zeng's avatar
wangding zeng committed
542
        q_pe, k_pe = self.rotary_emb(positions, q_pe, k_pe)
543

544
        q[..., self.qk_nope_head_dim :] = q_pe
wangding zeng's avatar
wangding zeng committed
545
        k = torch.empty_like(q)
546
547
        k[..., : self.qk_nope_head_dim] = k_nope
        k[..., self.qk_nope_head_dim :] = k_pe
548
549
550
551
552

        # Apply llama 4 scaling if provided
        if llama_4_scaling is not None:
            q *= llama_4_scaling

553
554
        # padding value to qk_head_dim for alignment
        v = torch.nn.functional.pad(
555
556
            v, [0, self.qk_head_dim - self.v_head_dim], value=0
        ).view(-1, self.num_local_heads * self.qk_head_dim)
557
        attn_output = self.attn(q, k, v)
558
559
560
        attn_output = attn_output.view(-1, self.num_local_heads, self.qk_head_dim)[
            ..., : self.v_head_dim
        ].reshape(-1, self.num_local_heads * self.v_head_dim)
wangding zeng's avatar
wangding zeng committed
561
562
563
564
        output, _ = self.o_proj(attn_output)
        return output


565
class DeepseekV32IndexerCache(torch.nn.Module, AttentionLayerBase):
566
567
568
    def __init__(
        self, head_dim: int, dtype: torch.dtype, prefix: str, cache_config: CacheConfig
    ):
569
570
571
572
573
574
575
576
577
578
579
        super().__init__()
        self.kv_cache = [torch.tensor([])]
        self.head_dim = head_dim
        self.prefix = prefix
        self.cache_config = cache_config
        self.dtype = dtype
        compilation_config = get_current_vllm_config().compilation_config
        if prefix in compilation_config.static_forward_context:
            raise ValueError(f"Duplicate layer name: {prefix}")
        compilation_config.static_forward_context[prefix] = self

580
    def get_kv_cache_spec(self, vllm_config: VllmConfig) -> KVCacheSpec:
581
582
583
584
585
586
587
        return MLAAttentionSpec(  # Only has one vector instead of K + V
            block_size=self.cache_config.block_size,
            num_kv_heads=1,
            head_size=self.head_dim,
            dtype=self.dtype,
        )

588
    def forward(self): ...
589
590
591
592
593
594

    def get_attn_backend(self) -> AttentionBackend:
        return DeepseekV32IndexerBackend


class Indexer(nn.Module):
595
596
597
    def __init__(
        self,
        vllm_config: VllmConfig,
598
        config: DeepseekV2Config | DeepseekV3Config,
599
600
        hidden_size: int,
        q_lora_rank: int,
601
602
603
        quant_config: QuantizationConfig | None,
        cache_config: CacheConfig | None,
        topk_indices_buffer: torch.Tensor | None,
604
605
        prefix: str = "",
    ):
606
607
608
609
610
611
612
613
614
615
        super().__init__()
        self.vllm_config = vllm_config
        self.config = config
        # self.indexer_cfg = config.attn_module_list_cfg[0]["attn_index"]
        self.topk_tokens = config.index_topk
        self.n_head = config.index_n_heads  # 64
        self.head_dim = config.index_head_dim  # 128
        self.rope_dim = config.qk_rope_head_dim  # 64
        self.q_lora_rank = q_lora_rank  # 1536
        # no tensor parallel, just replicated
616
617
618
619
620
621
622
623
624
625
626
627
628
629
        self.wq_b = ReplicatedLinear(
            self.q_lora_rank,
            self.head_dim * self.n_head,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.wq_b",
        )
        self.wk = ReplicatedLinear(
            hidden_size,
            self.head_dim,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.wk",
        )
630
        self.k_norm = LayerNorm(self.head_dim, eps=1e-6)
631
        self.weights_proj = ReplicatedLinear(
632
633
634
635
636
            hidden_size,
            self.n_head,
            bias=False,
            quant_config=None,
            prefix=f"{prefix}.weights_proj",
637
        )
638
639
640
641
642
643
644
645
646
647
        self.softmax_scale = self.head_dim**-0.5

        self.scale_fmt = "ue8m0"
        self.quant_block_size = 128  # TODO: get from config
        self.topk_indices_buffer = topk_indices_buffer

        # NOTE: (zyongye) we use fp8 naive cache,
        #       where we store value in fp8 and scale in fp32
        #       per self.quant_block_size element
        self.k_cache = DeepseekV32IndexerCache(
648
            head_dim=self.head_dim + self.head_dim // self.quant_block_size * 4,
649
650
            dtype=torch.uint8,
            prefix=f"{prefix}.k_cache",
651
652
            cache_config=cache_config,
        )
653
654
        self.max_model_len = vllm_config.model_config.max_model_len
        self.prefix = prefix
655
656
        from vllm.v1.attention.backends.mla.indexer import get_max_prefill_buffer_size

657
        self.max_total_seq_len = get_max_prefill_buffer_size(vllm_config)
658
659
660
661
662
663
664
665
666
667
        self.indexer_op = SparseAttnIndexer(
            self.k_cache,
            self.quant_block_size,
            self.scale_fmt,
            self.topk_tokens,
            self.head_dim,
            self.max_model_len,
            self.max_total_seq_len,
            self.topk_indices_buffer,
        )
668

669
670
671
    def forward(
        self, hidden_states: torch.Tensor, qr: torch.Tensor, positions, rotary_emb
    ) -> torch.Tensor:
672
673
674
        q, _ = self.wq_b(qr)
        q = q.view(-1, self.n_head, self.head_dim)
        q_pe, q_nope = torch.split(
675
676
            q, [self.rope_dim, self.head_dim - self.rope_dim], dim=-1
        )
677
678
679
680

        k, _ = self.wk(hidden_states)
        k = self.k_norm(k)
        k_pe, k_nope = torch.split(
681
682
            k, [self.rope_dim, self.head_dim - self.rope_dim], dim=-1
        )
683
684

        q_pe, k_pe = rotary_emb(positions, q_pe, k_pe.unsqueeze(1))
685
686
687
688
689
        # Note: RoPE (NeoX) can introduce extra leading dimensions during compilation
        # so we need to reshape back to token-flattened shapes
        q_pe = q_pe.reshape(-1, self.n_head, self.rope_dim)
        k_pe = k_pe.reshape(-1, 1, self.rope_dim)

690
691
        # `rotary_emb` is shape-preserving; `q_pe` is already
        # [num_tokens, n_head, rope_dim].
692
693
        q = torch.cat([q_pe, q_nope], dim=-1)
        # `k_pe` is [num_tokens, 1, rope_dim] (MQA).
694
        k = torch.cat([k_pe.squeeze(-2), k_nope], dim=-1)
695
696
697

        # we only quant q here since k quant is fused with cache insertion
        q = q.view(-1, self.head_dim)
698
699
700
701
702
703
        q_fp8, q_scale = per_token_group_quant_fp8(
            q,
            self.quant_block_size,
            column_major_scales=False,
            use_ue8m0=self.scale_fmt is not None,
        )
704
705
706
707
        q_fp8 = q_fp8.view(-1, self.n_head, self.head_dim)
        q_scale = q_scale.view(-1, self.n_head, 1)

        weights, _ = self.weights_proj(hidden_states)
708
709
710
        weights = (
            weights.unsqueeze(-1) * q_scale * self.softmax_scale * self.n_head**-0.5
        )
711
712
        weights = weights.squeeze(-1)

713
        return self.indexer_op(hidden_states, q_fp8, k, weights)
714
715


716
717
718
719
class DeepseekV2MLAAttention(nn.Module):
    """
    Main reference: DeepseekV2 paper, and FlashInfer Implementation
    (https://arxiv.org/abs/2405.04434 and https://github.com/flashinfer-ai/flashinfer/pull/551).
720

721
722
        For more info see MLACommonImpl in:
        vllm/v1/attention/backends/mla/utils.py
723
724
725
726
    """

    def __init__(
        self,
727
        vllm_config: VllmConfig,
728
        config: DeepseekV2Config | DeepseekV3Config,
729
730
731
732
733
        hidden_size: int,
        num_heads: int,
        qk_nope_head_dim: int,
        qk_rope_head_dim: int,
        v_head_dim: int,
734
        q_lora_rank: int | None,
735
736
        kv_lora_rank: int,
        max_position_embeddings: int = 8192,
737
738
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
739
        prefix: str = "",
740
        topk_indices_buffer: torch.Tensor | None = None,
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
    ) -> None:
        super().__init__()
        self.hidden_size = hidden_size
        self.qk_nope_head_dim = qk_nope_head_dim
        self.qk_rope_head_dim = qk_rope_head_dim
        self.qk_head_dim = qk_nope_head_dim + qk_rope_head_dim
        self.v_head_dim = v_head_dim

        self.q_lora_rank = q_lora_rank
        self.kv_lora_rank = kv_lora_rank

        self.num_heads = num_heads
        tp_size = get_tensor_model_parallel_world_size()
        assert num_heads % tp_size == 0
        self.num_local_heads = num_heads // tp_size

        self.scaling = self.qk_head_dim**-0.5
        self.max_position_embeddings = max_position_embeddings

        if self.q_lora_rank is not None:
761
            self.fused_qkv_a_proj = MergedColumnParallelLinear(
762
763
764
765
                self.hidden_size,
                [self.q_lora_rank, self.kv_lora_rank + self.qk_rope_head_dim],
                bias=False,
                quant_config=quant_config,
766
                prefix=f"{prefix}.fused_qkv_a_proj",
767
768
                disable_tp=True,
            )
769
770
771
772
773
774
        else:
            self.kv_a_proj_with_mqa = ReplicatedLinear(
                self.hidden_size,
                self.kv_lora_rank + self.qk_rope_head_dim,
                bias=False,
                quant_config=quant_config,
775
776
                prefix=f"{prefix}.kv_a_proj_with_mqa",
            )
777
778

        if self.q_lora_rank is not None:
779
780
781
782
783
784
785
786
            self.q_a_layernorm = RMSNorm(self.q_lora_rank, eps=config.rms_norm_eps)
            self.q_b_proj = ColumnParallelLinear(
                self.q_lora_rank,
                self.num_heads * self.qk_head_dim,
                bias=False,
                quant_config=quant_config,
                prefix=f"{prefix}.q_b_proj",
            )
787
        else:
788
789
790
791
792
793
794
795
            self.q_proj = ColumnParallelLinear(
                self.hidden_size,
                self.num_heads * self.qk_head_dim,
                bias=False,
                quant_config=quant_config,
                prefix=f"{prefix}.q_proj",
            )
        self.kv_a_layernorm = RMSNorm(self.kv_lora_rank, eps=config.rms_norm_eps)
796
797
798
799
800
        self.kv_b_proj = ColumnParallelLinear(
            self.kv_lora_rank,
            self.num_heads * (self.qk_nope_head_dim + self.v_head_dim),
            bias=False,
            quant_config=quant_config,
801
802
803
804
805
806
807
808
809
            prefix=f"{prefix}.kv_b_proj",
        )
        self.o_proj = RowParallelLinear(
            self.num_heads * self.v_head_dim,
            self.hidden_size,
            bias=False,
            quant_config=quant_config,
            prefix=f"{prefix}.o_proj",
        )
810

811
        if config.rope_parameters["rope_type"] != "default":
812
813
814
815
816
817
            config.rope_parameters["rope_type"] = (
                "deepseek_yarn"
                if config.rope_parameters.get("apply_yarn_scaling", True)
                else "deepseek_llama_scaling"
            )

818
819
820
        self.rotary_emb = get_rope(
            qk_rope_head_dim,
            max_position=max_position_embeddings,
821
            rope_parameters=config.rope_parameters,
822
823
            is_neox_style=False,
        )
824
825
826
827
828

        if (
            config.rope_parameters["rope_type"] != "default"
            and config.rope_parameters["rope_type"] == "deepseek_yarn"
        ):
829
830
            mscale_all_dim = config.rope_parameters.get("mscale_all_dim", False)
            scaling_factor = config.rope_parameters["factor"]
831
832
833
            mscale = yarn_get_mscale(scaling_factor, float(mscale_all_dim))
            self.scaling = self.scaling * mscale * mscale

834
        self.is_v32 = hasattr(config, "index_topk")
835
836

        if self.is_v32:
837
838
839
            self.indexer_rope_emb = get_rope(
                qk_rope_head_dim,
                max_position=max_position_embeddings,
840
                rope_parameters=config.rope_parameters,
841
842
                is_neox_style=True,
            )
843
844
845
846
847
848
849
850
851
852
            self.indexer = Indexer(
                vllm_config,
                config,
                hidden_size,
                q_lora_rank,
                quant_config,
                cache_config,
                topk_indices_buffer,
                f"{prefix}.indexer",
            )
853
        else:
854
            self.indexer_rope_emb = None
855
856
            self.indexer = None

857
858
        mla_modules = MLAModules(
            kv_a_layernorm=self.kv_a_layernorm,
859
            kv_b_proj=self.kv_b_proj,
860
861
862
            rotary_emb=self.rotary_emb,
            o_proj=self.o_proj,
            fused_qkv_a_proj=self.fused_qkv_a_proj
863
864
            if self.q_lora_rank is not None
            else None,
865
            kv_a_proj_with_mqa=self.kv_a_proj_with_mqa
866
867
868
            if self.q_lora_rank is None
            else None,
            q_a_layernorm=self.q_a_layernorm if self.q_lora_rank is not None else None,
869
870
            q_b_proj=self.q_b_proj if self.q_lora_rank is not None else None,
            q_proj=self.q_proj if self.q_lora_rank is None else None,
871
            indexer=self.indexer,
872
            indexer_rotary_emb=self.indexer_rope_emb,
873
874
            is_sparse=self.is_v32,
            topk_indices_buffer=topk_indices_buffer,
875
        )
876

877
        self.mla_attn = MultiHeadLatentAttentionWrapper(
878
879
880
881
882
883
884
885
886
887
888
889
            self.hidden_size,
            self.num_local_heads,
            self.scaling,
            self.qk_nope_head_dim,
            self.qk_rope_head_dim,
            self.v_head_dim,
            self.q_lora_rank,
            self.kv_lora_rank,
            mla_modules,
            cache_config,
            quant_config,
            prefix,
890
891
892
893
894
895
        )

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
896
        llama_4_scaling: torch.Tensor | None,
897
    ) -> torch.Tensor:
898
        return self.mla_attn(positions, hidden_states, llama_4_scaling)
899
900


wangding zeng's avatar
wangding zeng committed
901
class DeepseekV2DecoderLayer(nn.Module):
902
903
904
905
    def __init__(
        self,
        vllm_config: VllmConfig,
        prefix: str,
906
907
        config: DeepseekV2Config | None = None,
        topk_indices_buffer: torch.Tensor | None = None,
908
    ) -> None:
wangding zeng's avatar
wangding zeng committed
909
        super().__init__()
910

911
912
        if config is None:
            config = vllm_config.model_config.hf_config
913
914
915
916
917
        model_config = vllm_config.model_config
        cache_config = vllm_config.cache_config
        quant_config = vllm_config.quant_config
        parallel_config = vllm_config.parallel_config

wangding zeng's avatar
wangding zeng committed
918
        self.hidden_size = config.hidden_size
919
        max_position_embeddings = getattr(config, "max_position_embeddings", 8192)
920
        moe_layer_freq = getattr(config, "moe_layer_freq", 1)
921
922
        # DecoderLayers are created with `make_layers` which passes the prefix
        # with the layer's index.
923
        layer_idx = int(prefix.split(sep=".")[-1])
924
        self.layer_idx = layer_idx
925
926
927
928
929
930
931
932
933
934

        # verify MLA attention specific fields
        qk_nope_head_dim = getattr(config, "qk_nope_head_dim", 0)
        qk_rope_head_dim = getattr(config, "qk_rope_head_dim", 0)
        v_head_dim = getattr(config, "v_head_dim", 0)
        kv_lora_rank = getattr(config, "kv_lora_rank", 0)
        use_mha = config.model_type == "deepseek" or all(
            dim == 0 for dim in (qk_nope_head_dim, qk_rope_head_dim)
        )

935
936
        self.use_mha = use_mha

937
938
939
        if use_mha:
            attn_cls = DeepseekAttention
        elif model_config.use_mla:
940
941
942
943
            attn_cls = DeepseekV2MLAAttention
        else:
            attn_cls = DeepseekV2Attention
        self.self_attn = attn_cls(
944
            vllm_config=vllm_config,
wangding zeng's avatar
wangding zeng committed
945
946
947
            config=config,
            hidden_size=self.hidden_size,
            num_heads=config.num_attention_heads,
948
949
950
            qk_nope_head_dim=qk_nope_head_dim,
            qk_rope_head_dim=qk_rope_head_dim,
            v_head_dim=v_head_dim,
951
            q_lora_rank=config.q_lora_rank if hasattr(config, "q_lora_rank") else None,
952
            kv_lora_rank=kv_lora_rank,
wangding zeng's avatar
wangding zeng committed
953
954
955
            max_position_embeddings=max_position_embeddings,
            cache_config=cache_config,
            quant_config=quant_config,
956
            prefix=f"{prefix}.self_attn",
957
            topk_indices_buffer=topk_indices_buffer,
wangding zeng's avatar
wangding zeng committed
958
        )
959

960
961
962
        if (
            config.n_routed_experts is not None
            and layer_idx >= config.first_k_dense_replace
963
            and layer_idx % moe_layer_freq == 0
964
        ):
965
966
            self.mlp = DeepseekV2MoE(
                config=config,
967
                parallel_config=parallel_config,
968
969
970
                quant_config=quant_config,
                prefix=f"{prefix}.mlp",
            )
wangding zeng's avatar
wangding zeng committed
971
972
973
974
975
976
        else:
            self.mlp = DeepseekV2MLP(
                hidden_size=config.hidden_size,
                intermediate_size=config.intermediate_size,
                hidden_act=config.hidden_act,
                quant_config=quant_config,
977
                prefix=f"{prefix}.mlp",
wangding zeng's avatar
wangding zeng committed
978
            )
979
980
981
982
        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
        )
983
        self.routed_scaling_factor = getattr(config, "routed_scaling_factor", 1.0)
wangding zeng's avatar
wangding zeng committed
984
985
986
987
988

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
989
        residual: torch.Tensor | None,
990
        llama_4_scaling: torch.Tensor | None = None,
wangding zeng's avatar
wangding zeng committed
991
992
993
    ) -> torch.Tensor:
        # Self Attention
        if residual is None:
994
            residual = hidden_states.clone()
wangding zeng's avatar
wangding zeng committed
995
996
            hidden_states = self.input_layernorm(hidden_states)
        else:
997
            hidden_states, residual = self.input_layernorm(hidden_states, residual)
998
999
1000
1001
1002
1003
1004
1005

        attn_kwargs = {
            "positions": positions,
            "hidden_states": hidden_states,
        }
        if not self.use_mha:
            attn_kwargs["llama_4_scaling"] = llama_4_scaling
        hidden_states = self.self_attn(**attn_kwargs)
wangding zeng's avatar
wangding zeng committed
1006

1007
1008
1009
1010
        if (
            not isinstance(self.self_attn, DeepseekAttention)
            and hidden_states.dtype == torch.float16
        ):
1011
1012
1013
            # Fix FP16 overflow
            # We scale both hidden_states and residual before
            # rmsnorm, and rmsnorm result would not affect by scale.
1014
            hidden_states *= 1.0 / self.routed_scaling_factor
1015
1016
1017
            if self.layer_idx == 0:
                # The residual is shared by all layers, we only scale it on
                # first layer.
1018
                residual *= 1.0 / self.routed_scaling_factor
1019
1020

        # Fully Connected
1021
        hidden_states, residual = self.post_attention_layernorm(hidden_states, residual)
wangding zeng's avatar
wangding zeng committed
1022
        hidden_states = self.mlp(hidden_states)
1023

1024
        if isinstance(self.mlp, DeepseekV2MLP) and hidden_states.dtype == torch.float16:
1025
1026
1027
1028
1029
            # Fix FP16 overflow
            # Scaling the DeepseekV2MLP output, it is the input of
            # input_layernorm of next decoder layer.
            # The scaling of DeepseekV2MOE output would be done in the forward
            # of DeepseekV2MOE
1030
            hidden_states *= 1.0 / self.routed_scaling_factor
1031

wangding zeng's avatar
wangding zeng committed
1032
1033
1034
        return hidden_states, residual


1035
@support_torch_compile
wangding zeng's avatar
wangding zeng committed
1036
1037
1038
class DeepseekV2Model(nn.Module):
    fall_back_to_pt_during_load = False

1039
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
wangding zeng's avatar
wangding zeng committed
1040
        super().__init__()
1041
1042
1043

        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
1044
        self.config = config
1045
        self.device = current_platform.device_type
1046

wangding zeng's avatar
wangding zeng committed
1047
        self.vocab_size = config.vocab_size
1048
        self.is_v32 = hasattr(config, "index_topk")
1049
1050
1051
1052
1053
1054
        if self.is_v32:
            topk_tokens = config.index_topk
            topk_indices_buffer = torch.empty(
                vllm_config.scheduler_config.max_num_batched_tokens,
                topk_tokens,
                dtype=torch.int32,
1055
                device=self.device,
1056
            )
1057
1058
        else:
            topk_indices_buffer = None
wangding zeng's avatar
wangding zeng committed
1059

1060
1061
1062
1063
        if get_pp_group().is_first_rank:
            self.embed_tokens = VocabParallelEmbedding(
                config.vocab_size,
                config.hidden_size,
1064
                quant_config=quant_config,
1065
1066
                prefix=f"{prefix}.embed_tokens",
            )
1067
1068
1069
1070
        else:
            self.embed_tokens = PPMissingLayer()
        self.start_layer, self.end_layer, self.layers = make_layers(
            config.num_hidden_layers,
1071
            lambda prefix: DeepseekV2DecoderLayer(
1072
                vllm_config, prefix, topk_indices_buffer=topk_indices_buffer
1073
1074
1075
            ),
            prefix=f"{prefix}.layers",
        )
1076
1077
1078
1079
1080

        if get_pp_group().is_last_rank:
            self.norm = RMSNorm(config.hidden_size, eps=config.rms_norm_eps)
        else:
            self.norm = PPMissingLayer()
1081
1082
1083
        self.make_empty_intermediate_tensors = make_empty_intermediate_tensors_factory(
            ["hidden_states", "residual"], config.hidden_size
        )
wangding zeng's avatar
wangding zeng committed
1084

1085
    def embed_input_ids(self, input_ids: torch.Tensor) -> torch.Tensor:
1086
1087
        return self.embed_tokens(input_ids)

wangding zeng's avatar
wangding zeng committed
1088
1089
    def forward(
        self,
1090
        input_ids: torch.Tensor | None,
wangding zeng's avatar
wangding zeng committed
1091
        positions: torch.Tensor,
1092
1093
1094
        intermediate_tensors: IntermediateTensors | None,
        inputs_embeds: torch.Tensor | None = None,
    ) -> torch.Tensor | IntermediateTensors:
1095
        if get_pp_group().is_first_rank:
1096
1097
1098
            if inputs_embeds is not None:
                hidden_states = inputs_embeds
            else:
1099
                hidden_states = self.embed_input_ids(input_ids)
1100
1101
1102
1103
1104
1105
            residual = None
        else:
            assert intermediate_tensors is not None
            hidden_states = intermediate_tensors["hidden_states"]
            residual = intermediate_tensors["residual"]

1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
        # Compute llama 4 scaling once per forward pass if enabled
        llama_4_scaling_config = getattr(self.config, "llama_4_scaling", None)
        llama_4_scaling: torch.Tensor | None
        if llama_4_scaling_config is not None:
            llama_4_scaling = _get_llama_4_scaling(
                original_max_position_embeddings=llama_4_scaling_config[
                    "original_max_position_embeddings"
                ],
                scaling_beta=llama_4_scaling_config["beta"],
                positions=positions,
            )
        else:
            llama_4_scaling = None

1120
        for layer in islice(self.layers, self.start_layer, self.end_layer):
1121
1122
1123
            hidden_states, residual = layer(
                positions, hidden_states, residual, llama_4_scaling
            )
1124
1125

        if not get_pp_group().is_last_rank:
1126
1127
1128
            return IntermediateTensors(
                {"hidden_states": hidden_states, "residual": residual}
            )
1129

wangding zeng's avatar
wangding zeng committed
1130
1131
1132
1133
        hidden_states, _ = self.norm(hidden_states, residual)
        return hidden_states


1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
class DeepseekV2MixtureOfExperts(MixtureOfExperts):
    moe_mlp_layers: list[DeepseekV2MoE]
    """
    List of MoE MLP layers in the model.
    """

    def extract_moe_parameters(self, example_moe: DeepseekV2MoE | None):
        if example_moe is None:
            self.num_moe_layers = 0
            self.num_expert_groups = 0
            self.num_logical_experts = 0
            self.num_physical_experts = 0
            self.num_local_physical_experts = 0
            self.num_routed_experts = 0
            self.num_shared_experts = 0
            self.num_redundant_experts = 0
            logger.warning("DeepSeekV2: No DeepseekV2MoE layer found in model.layers.")
        else:
            self.num_logical_experts = example_moe.n_logical_experts
            self.num_physical_experts = example_moe.n_physical_experts
            self.num_local_physical_experts = example_moe.n_local_physical_experts
            self.num_routed_experts = example_moe.n_routed_experts
            self.num_shared_experts = example_moe.n_shared_experts
            self.num_redundant_experts = example_moe.n_redundant_experts

    def update_physical_experts_metadata(
        self,
        num_physical_experts: int,
        num_local_physical_experts: int,
    ) -> None:
        assert self.num_local_physical_experts == num_local_physical_experts
        self.num_physical_experts = num_physical_experts
        self.num_local_physical_experts = num_local_physical_experts
        self.num_redundant_experts = num_physical_experts - self.num_logical_experts
        for moe in self.moe_mlp_layers:
            moe.n_local_physical_experts = num_local_physical_experts
            moe.n_physical_experts = num_physical_experts
            moe.n_redundant_experts = self.num_redundant_experts
            moe.experts.update_expert_map()


class DeepseekV2ForCausalLM(
1176
    nn.Module, SupportsPP, DeepseekV2MixtureOfExperts, SupportsLoRA, SupportsEagle
1177
):
1178
1179
1180
    packed_modules_mapping = {
        "gate_up_proj": ["gate_proj", "up_proj"],
    }
1181
    model_cls = DeepseekV2Model
wangding zeng's avatar
wangding zeng committed
1182

1183
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
wangding zeng's avatar
wangding zeng committed
1184
        super().__init__()
1185
1186
        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
wangding zeng's avatar
wangding zeng committed
1187
1188
        self.config = config
        self.quant_config = quant_config
1189

1190
1191
1192
1193
1194
1195
1196
1197
1198
        qk_nope_head_dim = getattr(config, "qk_nope_head_dim", 0)
        qk_rope_head_dim = getattr(config, "qk_rope_head_dim", 0)
        self.use_mha = config.model_type == "deepseek" or all(
            dim == 0 for dim in (qk_nope_head_dim, qk_rope_head_dim)
        )

        if self.use_mha:
            self.packed_modules_mapping["qkv_proj"] = ["q_proj", "k_proj", "v_proj"]

1199
1200
1201
1202
        # `packed_modules_mapping` needs to be modified before
        # initializing DeepseekV2Model, as it is passed inplace to
        # quantization config init and may be used to select the
        # quant_method for relevant layers during initialization.
1203
1204
1205
        self.fuse_qkv_a_proj = (
            hasattr(config, "q_lora_rank") and config.q_lora_rank is not None
        )
1206
1207
1208
1209
1210
1211
        if self.fuse_qkv_a_proj:
            self.packed_modules_mapping["fused_qkv_a_proj"] = [
                "q_a_proj",
                "kv_a_proj_with_mqa",
            ]

1212
        self.model = self.model_cls(
1213
1214
            vllm_config=vllm_config, prefix=maybe_prefix(prefix, "model")
        )
1215
        if get_pp_group().is_last_rank:
1216
1217
1218
1219
1220
1221
            self.lm_head = ParallelLMHead(
                config.vocab_size,
                config.hidden_size,
                quant_config=quant_config,
                prefix=maybe_prefix(prefix, "lm_head"),
            )
1222
1223
        else:
            self.lm_head = PPMissingLayer()
wangding zeng's avatar
wangding zeng committed
1224
        self.logits_processor = LogitsProcessor(config.vocab_size)
1225
        self.make_empty_intermediate_tensors = (
1226
1227
            self.model.make_empty_intermediate_tensors
        )
1228
1229
1230
1231
1232
        # Set MoE hyperparameters
        self.num_moe_layers = (
            self.config.num_hidden_layers - self.config.first_k_dense_replace
        )
        self.set_moe_parameters()
1233
1234
1235
        self.quant_method = None
        if quant_config is not None:
            self.quant_method=quant_config.get_name()
1236
1237

    def set_moe_parameters(self):
1238
1239
        self.expert_weights = []

1240
        self.num_expert_groups = getattr(self.config, "n_group", 1)
1241

1242
1243
        self.moe_layers = []
        self.moe_mlp_layers = []
1244
        example_moe = None
1245
        for layer in self.model.layers:
1246
1247
1248
            if isinstance(layer, PPMissingLayer):
                continue

1249
1250
            assert isinstance(layer, DeepseekV2DecoderLayer)
            if isinstance(layer.mlp, DeepseekV2MoE):
1251
1252
                # Pick last one layer since the first ones may be dense layers.
                example_moe = layer.mlp
1253
                self.moe_mlp_layers.append(layer.mlp)
1254
1255
                self.moe_layers.append(layer.mlp.experts)

1256
        self.extract_moe_parameters(example_moe)
wangding zeng's avatar
wangding zeng committed
1257

1258
1259
    def embed_input_ids(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.model.embed_input_ids(input_ids)
1260

wangding zeng's avatar
wangding zeng committed
1261
1262
    def forward(
        self,
1263
        input_ids: torch.Tensor | None,
wangding zeng's avatar
wangding zeng committed
1264
        positions: torch.Tensor,
1265
1266
1267
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
    ) -> torch.Tensor | IntermediateTensors:
1268
1269
1270
        hidden_states = self.model(
            input_ids, positions, intermediate_tensors, inputs_embeds
        )
wangding zeng's avatar
wangding zeng committed
1271
1272
        return hidden_states

1273
1274
1275
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
1276
    ) -> torch.Tensor | None:
1277
        logits = self.logits_processor(self.lm_head, hidden_states)
wangding zeng's avatar
wangding zeng committed
1278
1279
        return logits

1280
1281
1282
1283
    def get_expert_mapping(self) -> list[tuple[str, str, int, str]]:
        # Params for weights, fp8 weight scales, fp8 activation scales
        # (param_name, weight_name, expert_id, shard_id)
        return SharedFusedMoE.make_expert_params_mapping(
1284
            self,
1285
1286
1287
1288
1289
1290
1291
            ckpt_gate_proj_name="gate_proj",
            ckpt_down_proj_name="down_proj",
            ckpt_up_proj_name="up_proj",
            num_experts=self.config.n_routed_experts,
            num_redundant_experts=0,
        )

1292
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
1293
1294
1295
        rocm_aiter_moe_shared_expert_enabled = (
            rocm_aiter_ops.is_fusion_moe_shared_experts_enabled()
        )
wangding zeng's avatar
wangding zeng committed
1296
1297
1298
1299
        stacked_params_mapping = [
            # (param_name, shard_name, shard_id)
            ("gate_up_proj", "gate_proj", 0),
            ("gate_up_proj", "up_proj", 1),
1300
1301
        ]
        mla_params_mapping = [
1302
1303
            ("fused_qkv_a_proj", "q_a_proj", 0),
            ("fused_qkv_a_proj", "kv_a_proj_with_mqa", 1),
wangding zeng's avatar
wangding zeng committed
1304
        ]
1305
1306
1307
1308
1309
1310
1311
1312
1313
        mha_params_mapping = [
            ("qkv_proj", "q_proj", "q"),
            ("qkv_proj", "k_proj", "k"),
            ("qkv_proj", "v_proj", "v"),
        ]
        if self.use_mha:
            stacked_params_mapping.extend(mha_params_mapping)
        else:
            stacked_params_mapping.extend(mla_params_mapping)
wangding zeng's avatar
wangding zeng committed
1314

1315
1316
        # Params for weights, fp8 weight scales, fp8 activation scales
        # (param_name, weight_name, expert_id, shard_id)
1317
        expert_params_mapping = SharedFusedMoE.make_expert_params_mapping(
1318
            self,
1319
1320
1321
            ckpt_gate_proj_name="gate_proj",
            ckpt_down_proj_name="down_proj",
            ckpt_up_proj_name="up_proj",
1322
1323
1324
            num_experts=self.config.n_routed_experts
            + (
                self.config.n_shared_experts
1325
                if rocm_aiter_moe_shared_expert_enabled
1326
1327
                else 0
            ),
1328
1329
            num_redundant_experts=self.num_redundant_experts,
        )
1330

wangding zeng's avatar
wangding zeng committed
1331
        params_dict = dict(self.named_parameters())
1332
        loaded_params: set[str] = set()
wangding zeng's avatar
wangding zeng committed
1333
1334
1335
        for name, loaded_weight in weights:
            if "rotary_emb.inv_freq" in name:
                continue
1336

1337
1338
1339
            spec_layer = get_spec_layer_idx_from_weight_name(self.config, name)
            if spec_layer is not None:
                continue  # skip spec decode layers for main model
1340

1341
1342
            is_fusion_moe_shared_experts_layer = (
                rocm_aiter_moe_shared_expert_enabled and ("mlp.shared_experts" in name)
1343
1344
            )

1345
            for param_name, weight_name, shard_id in stacked_params_mapping:
1346
                # Skip non-stacked layers and experts (experts handled below).
wangding zeng's avatar
wangding zeng committed
1347
1348
                if weight_name not in name:
                    continue
1349
1350
1351
1352
1353
1354
                # We have mlp.experts[0].gate_proj in the checkpoint.
                # Since we handle the experts below in expert_params_mapping,
                # we need to skip here BEFORE we update the name, otherwise
                # name will be updated to mlp.experts[0].gate_up_proj, which
                # will then be updated below in expert_params_mapping
                # for mlp.experts[0].gate_gate_up_proj, which breaks load.
1355
                if ("mlp.experts." in name) and name not in params_dict:
1356
                    continue
1357
                if is_fusion_moe_shared_experts_layer:
1358
                    continue
1359
                name_mapped = name.replace(weight_name, param_name)
1360
1361
1362

                # QKV fusion is optional, fall back to normal
                # weight loading if it's not enabled
1363
                # if go with fusion option, then update name
1364
1365
1366
                if (
                    param_name == "fused_qkv_a_proj"
                ) and name_mapped not in params_dict:
1367
                    continue
1368
1369
                else:
                    name = name_mapped
wangding zeng's avatar
wangding zeng committed
1370
1371
1372
                # Skip loading extra bias for GPTQ models.
                if name.endswith(".bias") and name not in params_dict:
                    continue
1373
1374
1375
1376

                if is_pp_missing_parameter(name, self):
                    continue

wangding zeng's avatar
wangding zeng committed
1377
1378
1379
1380
1381
                param = params_dict[name]
                weight_loader = param.weight_loader
                weight_loader(param, loaded_weight, shard_id)
                break
            else:
1382
                is_expert_weight = False
1383
1384
1385
1386
1387
1388
1389
1390
1391
                # Special handling: when AITER fusion_shared_experts is enabled,
                # checkpoints may provide a single widened shared_experts tensor
                # without explicit expert indices
                # (e.g. ...mlp.shared_experts.gate_proj.weight).
                # For models with multiple shared experts, split that tensor
                # evenly into per-shared-expert slices and load them into
                # appended expert slots mlp.experts.{n_routed_experts + j}.*
                # accordingly.
                num_chunks = 1
1392
                if is_fusion_moe_shared_experts_layer:
1393
1394
1395
1396
                    num_chunks = getattr(self.config, "n_shared_experts", 1) or 1
                    # Determine split axis based on op type
                    # gate/up: ColumnParallel → split along dim 0
                    # down: RowParallel → split along dim 1
1397
1398
1399
1400
1401
                    split_dim = (
                        1
                        if ("down_proj.weight" in name and loaded_weight.ndim > 1)
                        else 0
                    )
1402
1403
1404
1405
                    total = loaded_weight.shape[split_dim]
                    assert total % num_chunks == 0, (
                        f"Shared expert weight dim {total} "
                        f"not divisible by num_chunks {num_chunks}"
1406
                    )
1407
1408
1409
1410
1411
1412
                    chunk_size = total // num_chunks

                for j in range(num_chunks):
                    chunk_name = name
                    weight_to_load = loaded_weight

1413
                    if is_fusion_moe_shared_experts_layer:
1414
1415
1416
1417
1418
                        chunk_slice = slice(j * chunk_size, (j + 1) * chunk_size)
                        if loaded_weight.ndim == 1:
                            weight_to_load = loaded_weight[chunk_slice]
                        elif split_dim == 0:
                            weight_to_load = loaded_weight[chunk_slice, :]
1419
                        else:
1420
                            weight_to_load = loaded_weight[:, chunk_slice]
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
                        # Synthesize an expert-style name so expert mapping
                        # can route it
                        chunk_name = name.replace(
                            "mlp.shared_experts",
                            f"mlp.experts.{self.config.n_routed_experts + j}",
                        )

                    # Use expert_params_mapping to locate the destination
                    # param and delegate to its expert-aware weight_loader
                    # with expert_id.
                    for mapping in expert_params_mapping:
                        param_name, weight_name, expert_id, shard_id = mapping
                        if weight_name not in chunk_name:
                            continue

                        # Anyway, this is an expert weight and should not be
                        # attempted to load as other weights later
                        is_expert_weight = True

                        # Do not modify `name` since the loop may continue here
                        # Instead, create a new variable
                        name_mapped = chunk_name.replace(weight_name, param_name)

                        if is_pp_missing_parameter(name_mapped, self):
                            continue

                        param = params_dict[name_mapped]
                        # We should ask the weight loader to return success or
                        # not here since otherwise we may skip experts with
                        # other available replicas.
                        weight_loader = typing.cast(
                            Callable[..., bool], param.weight_loader
                        )
                        success = weight_loader(
                            param,
                            weight_to_load,
                            name_mapped,
                            shard_id=shard_id,
                            expert_id=expert_id,
                            return_success=True,
                        )
                        if success:
1463
                            if not is_fusion_moe_shared_experts_layer:
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
                                name = name_mapped
                            else:
                                loaded_params.add(name_mapped)
                            break
                    else:
                        if is_expert_weight:
                            # We've checked that this is an expert weight
                            # However it's not mapped locally to this rank
                            # So we simply skip it
                            continue

                        # 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
1486

zhuwenwen's avatar
zhuwenwen committed
1487
                        param = params_dict[name]
1488
1489
1490
1491
                        weight_loader = getattr(
                            param, "weight_loader", default_weight_loader
                        )
                        weight_loader(param, loaded_weight)
1492
            if not is_fusion_moe_shared_experts_layer:
1493
                loaded_params.add(name)
zhuwenwen's avatar
zhuwenwen committed
1494
        
1495
        return loaded_params
1496
1497


1498
1499
1500
1501
class DeepseekForCausalLM(DeepseekV2ForCausalLM):
    pass


1502
1503
class DeepseekV3ForCausalLM(DeepseekV2ForCausalLM):
    pass
1504
1505


1506
1507
# Compatibility with
# https://huggingface.co/deepseek-ai/DeepSeek-V3-Base/blob/main/configuration_deepseek.py
1508
def get_spec_layer_idx_from_weight_name(
1509
1510
    config: DeepseekV2Config | DeepseekV3Config, weight_name: str
) -> int | None:
1511
1512
1513
1514
    if (
        hasattr(config, "num_nextn_predict_layers")
        and config.num_nextn_predict_layers > 0
    ):
1515
1516
        layer_idx = config.num_hidden_layers
        for i in range(config.num_nextn_predict_layers):
1517
            if weight_name.startswith(f"model.layers.{layer_idx + i}."):
1518
1519
                return layer_idx + i
    return None