nemotron_h.py 30.7 KB
Newer Older
Luis Vega's avatar
Luis Vega committed
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
Luis Vega's avatar
Luis Vega committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Adapted from https://github.com/vllm-project/vllm/blob/94d8ec8d2bcb4ec55e33022b313c7e978edf05e1/vllm/model_executor/models/bamba.py
# Copyright 2024 HuggingFace Inc. team. All rights reserved.
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Inference-only NemotronH model."""
20

21
22
import typing
from collections.abc import Callable, Iterable
23
from itertools import islice
Luis Vega's avatar
Luis Vega committed
24
25
26
27
28

import torch
from torch import nn

from vllm.attention.layer import Attention
29
from vllm.compilation.decorators import support_torch_compile
30
from vllm.config import CacheConfig, ModelConfig, VllmConfig
31
32
33
from vllm.config.parallel import ParallelConfig
from vllm.distributed import get_ep_group, get_tensor_model_parallel_world_size
from vllm.distributed.communication_op import tensor_model_parallel_all_gather
Luis Vega's avatar
Luis Vega committed
34
35
from vllm.distributed.parallel_state import get_pp_group
from vllm.model_executor.layers.activation import ReLUSquaredActivation
36
37
from vllm.model_executor.layers.fused_moe import FusedMoE, SharedFusedMoE
from vllm.model_executor.layers.fused_moe.utils import activation_without_mul
Luis Vega's avatar
Luis Vega committed
38
from vllm.model_executor.layers.layernorm import RMSNorm
39
40
41
from vllm.model_executor.layers.linear import (
    ColumnParallelLinear,
    QKVParallelLinear,
42
    ReplicatedLinear,
43
44
    RowParallelLinear,
)
Luis Vega's avatar
Luis Vega committed
45
from vllm.model_executor.layers.logits_processor import LogitsProcessor
46
from vllm.model_executor.layers.mamba.mamba_mixer2 import MambaMixer2
47
from vllm.model_executor.layers.mamba.mamba_utils import (
48
49
50
    MambaStateDtypeCalculator,
    MambaStateShapeCalculator,
)
Luis Vega's avatar
Luis Vega committed
51
52
from vllm.model_executor.layers.quantization import QuantizationConfig
from vllm.model_executor.layers.vocab_parallel_embedding import (
53
54
55
56
    DEFAULT_VOCAB_PADDING_SIZE,
    ParallelLMHead,
    VocabParallelEmbedding,
)
57
from vllm.model_executor.model_loader.weight_utils import (
58
59
60
61
62
63
    default_weight_loader,
    maybe_remap_kv_scale_name,
)
from vllm.model_executor.models.interfaces import (
    HasInnerState,
    IsHybrid,
64
    MixtureOfExperts,
65
    SupportsLoRA,
66
    SupportsMambaPrefixCaching,
67
68
69
    SupportsPP,
    SupportsQuant,
)
Luis Vega's avatar
Luis Vega committed
70
from vllm.model_executor.models.utils import (
71
72
    AutoWeightsLoader,
    WeightsMapper,
73
    is_pp_missing_parameter,
74
75
76
    make_empty_intermediate_tensors_factory,
    make_layers,
    maybe_prefix,
77
    sequence_parallel_chunk,
78
)
Luis Vega's avatar
Luis Vega committed
79
80
81
82
83
84
85
86
from vllm.sequence import IntermediateTensors
from vllm.transformers_utils.configs import NemotronHConfig


class NemotronHMLP(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
87
        intermediate_size: int,
88
        quant_config: QuantizationConfig | None = None,
Luis Vega's avatar
Luis Vega committed
89
        bias: bool = False,
90
91
        reduce_results: bool = True,
        is_sequence_parallel: bool = False,
92
        prefix: str = "",
Luis Vega's avatar
Luis Vega committed
93
94
    ) -> None:
        super().__init__()
95

96
        self.up_proj = ColumnParallelLinear(
Luis Vega's avatar
Luis Vega committed
97
            input_size=config.hidden_size,
98
            output_size=intermediate_size,
Luis Vega's avatar
Luis Vega committed
99
100
            bias=bias,
            quant_config=quant_config,
101
            disable_tp=is_sequence_parallel,
102
            prefix=f"{prefix}.up_proj",
Luis Vega's avatar
Luis Vega committed
103
104
        )
        self.down_proj = RowParallelLinear(
105
            input_size=intermediate_size,
Luis Vega's avatar
Luis Vega committed
106
107
108
            output_size=config.hidden_size,
            bias=bias,
            quant_config=quant_config,
109
110
            reduce_results=reduce_results,
            disable_tp=is_sequence_parallel,
111
            prefix=f"{prefix}.down_proj",
Luis Vega's avatar
Luis Vega committed
112
113
114
115
116
117
118
119
120
121
        )
        self.act_fn = ReLUSquaredActivation()

    def forward(self, x: torch.Tensor):
        x, _ = self.up_proj(x)
        x = self.act_fn(x)
        x, _ = self.down_proj(x)
        return x


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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
class NemotronHMoE(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
        quant_config: QuantizationConfig | None = None,
        parallel_config: ParallelConfig | None = None,
        prefix: str = "",
    ):
        super().__init__()
        self.tp_size = get_tensor_model_parallel_world_size()
        self.routed_scaling_factor = config.routed_scaling_factor

        self.ep_group = get_ep_group().device_group
        self.ep_rank = self.ep_group.rank()
        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

        self.is_sequence_parallel = parallel_config.use_sequence_parallel_moe

        self.gate = ReplicatedLinear(
            config.hidden_size,
            config.n_routed_experts,
            bias=False,
            params_dtype=torch.float32,
            quant_config=None,
            prefix=f"{prefix}.gate",
        )

        self.gate.e_score_correction_bias = nn.Parameter(
            torch.empty(config.n_routed_experts, dtype=torch.float32)
        )
        # Load balancing settings.
        self.enable_eplb = parallel_config.enable_eplb

        self.n_redundant_experts = parallel_config.eplb_config.num_redundant_experts  # noqa: E501
        self.n_logical_experts = self.n_routed_experts
        self.n_physical_experts = self.n_logical_experts + self.n_redundant_experts
        self.n_local_physical_experts = self.n_physical_experts // self.ep_size

        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
        )

        if config.n_shared_experts is None or config.n_shared_experts == 0:
            self.shared_experts = None
        else:
            intermediate_size = (
                config.moe_shared_expert_intermediate_size * config.n_shared_experts
            )

            self.shared_experts = NemotronHMLP(
                config=config,
                intermediate_size=intermediate_size,
                quant_config=quant_config,
                reduce_results=False,
                is_sequence_parallel=self.is_sequence_parallel,
                prefix=f"{prefix}.shared_experts",
            )

        self.experts = SharedFusedMoE(
            shared_experts=self.shared_experts,
            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,
            num_expert_group=config.n_group,
            topk_group=config.topk_group,
            prefix=f"{prefix}.experts",
            scoring_func="sigmoid",
            e_score_correction_bias=self.gate.e_score_correction_bias,
            activation=activation_without_mul(config.mlp_hidden_act),
            is_act_and_mul=False,  # non-gated MoE
            enable_eplb=self.enable_eplb,
            num_redundant_experts=self.n_redundant_experts,
            is_sequence_parallel=self.is_sequence_parallel,
        )

    def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
        num_tokens, hidden_dim = hidden_states.shape
        hidden_states = hidden_states.view(-1, hidden_dim)

        if self.is_sequence_parallel:
            hidden_states = sequence_parallel_chunk(hidden_states)

        # router_logits: (num_tokens, n_experts)
        router_logits, _ = self.gate(hidden_states.to(dtype=torch.float32))

        fused_moe_out = self.experts(
            hidden_states=hidden_states, router_logits=router_logits
        )

        shared_output, final_hidden_states = fused_moe_out

        # Fix FP16 overflow
        # See DeepseekV2DecoderLayer for more details.
        if hidden_states.dtype != torch.float16:
            final_hidden_states *= self.routed_scaling_factor
        elif self.shared_experts is not None:
            assert shared_output is not None
            shared_output *= 1.0 / self.routed_scaling_factor

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

        if self.is_sequence_parallel:
            final_hidden_states = tensor_model_parallel_all_gather(
                final_hidden_states, 0
            )
            final_hidden_states = final_hidden_states[:num_tokens]
        elif self.tp_size > 1:
            final_hidden_states = self.experts.maybe_all_reduce_tensor_model_parallel(
                final_hidden_states
            )

        return final_hidden_states.view(num_tokens, hidden_dim)


Luis Vega's avatar
Luis Vega committed
246
247
248
249
250
class NemotronHMLPDecoderLayer(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
        layer_idx: int,
251
252
253
        model_config: ModelConfig | None = None,
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
254
        parallel_config: ParallelConfig | None = None,
Luis Vega's avatar
Luis Vega committed
255
256
257
258
259
        prefix: str = "",
    ) -> None:
        super().__init__()
        self.config = config

260
261
262
263
264
265
266
267
268
269
        hybrid_override_pattern = config.hybrid_override_pattern
        mlp_index = hybrid_override_pattern[: layer_idx + 1].count("-") - 1
        if isinstance(config.intermediate_size, list):
            if len(config.intermediate_size) == 1:
                intermediate_size = config.intermediate_size[0]
            else:
                intermediate_size = config.intermediate_size[mlp_index]
        else:
            intermediate_size = config.intermediate_size

270
271
        self.mixer = NemotronHMLP(
            config,
272
            intermediate_size=intermediate_size,
273
274
275
276
            quant_config=quant_config,
            bias=config.mlp_bias,
            prefix=f"{prefix}.mixer",
        )
Luis Vega's avatar
Luis Vega committed
277

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
        self.norm = RMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)

    def forward(
        self,
        hidden_states: torch.Tensor,
        residual: torch.Tensor | None,
        **kwargs,
    ):
        if residual is None:
            residual = hidden_states
            hidden_states = self.norm(hidden_states)
        else:
            hidden_states, residual = self.norm(hidden_states, residual)

        hidden_states = self.mixer(hidden_states)
        return hidden_states, residual


class NemotronHMoEDecoderLayer(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
        layer_idx: int,
        model_config: ModelConfig | None = None,
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
        parallel_config: ParallelConfig | None = None,
        prefix: str = "",
    ) -> None:
        super().__init__()
        self.config = config

        self.mixer = NemotronHMoE(
            config,
            quant_config=quant_config,
            parallel_config=parallel_config,
            prefix=f"{prefix}.mixer",
        )

        self.norm = RMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
Luis Vega's avatar
Luis Vega committed
318
319
320
321

    def forward(
        self,
        hidden_states: torch.Tensor,
322
        residual: torch.Tensor | None,
Luis Vega's avatar
Luis Vega committed
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
        **kwargs,
    ):
        if residual is None:
            residual = hidden_states
            hidden_states = self.norm(hidden_states)
        else:
            hidden_states, residual = self.norm(hidden_states, residual)

        hidden_states = self.mixer(hidden_states)
        return hidden_states, residual


class NemotronHMambaDecoderLayer(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
        layer_idx: int,
340
341
342
        model_config: ModelConfig | None = None,
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
343
        parallel_config: ParallelConfig | None = None,
Luis Vega's avatar
Luis Vega committed
344
345
346
347
348
349
350
351
        prefix: str = "",
    ) -> None:
        super().__init__()
        self.config = config
        self.mixer = MambaMixer2(
            hidden_size=config.hidden_size,
            ssm_state_size=config.ssm_state_size,
            conv_kernel_size=config.conv_kernel,
352
            intermediate_size=config.mamba_num_heads * config.mamba_head_dim,
Luis Vega's avatar
Luis Vega committed
353
354
355
356
357
            use_conv_bias=config.use_conv_bias,
            use_bias=config.use_bias,
            n_groups=config.n_groups,
            num_heads=config.mamba_num_heads,
            head_dim=config.mamba_head_dim,
358
            rms_norm_eps=config.layer_norm_epsilon,
Luis Vega's avatar
Luis Vega committed
359
            activation=config.mamba_hidden_act,
360
361
            model_config=model_config,
            cache_config=cache_config,
Luis Vega's avatar
Luis Vega committed
362
            quant_config=quant_config,
363
            prefix=f"{prefix}.mixer",
Luis Vega's avatar
Luis Vega committed
364
365
        )

366
        self.norm = RMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
Luis Vega's avatar
Luis Vega committed
367
368
369
370

    def forward(
        self,
        hidden_states: torch.Tensor,
371
        residual: torch.Tensor | None,
Luis Vega's avatar
Luis Vega committed
372
373
374
375
376
377
378
379
        **kwargs,
    ):
        if residual is None:
            residual = hidden_states
            hidden_states = self.norm(hidden_states)
        else:
            hidden_states, residual = self.norm(hidden_states, residual)

380
        output = torch.empty_like(hidden_states)
381
        self.mixer(hidden_states, output)
382
        return output, residual
Luis Vega's avatar
Luis Vega committed
383
384
385
386
387
388
389


class NemotronHAttention(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
        layer_idx: int,
390
391
392
        model_config: ModelConfig | None = None,
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
Luis Vega's avatar
Luis Vega committed
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
        prefix: str = "",
    ) -> None:
        super().__init__()
        self.hidden_size = config.hidden_size
        tp_size = get_tensor_model_parallel_world_size()
        self.total_num_heads = config.num_attention_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)
411
412
413
414
        if hasattr(config, "head_dim") and config.head_dim is not None:
            self.head_dim = config.head_dim
        else:
            self.head_dim = config.hidden_size // self.total_num_heads
Luis Vega's avatar
Luis Vega committed
415
416
417
418
419
420
421
422
423
424
425
        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.qkv_proj = QKVParallelLinear(
            config.hidden_size,
            self.head_dim,
            self.total_num_heads,
            self.total_num_kv_heads,
            bias=False,
            quant_config=quant_config,
426
            prefix=f"{prefix}.qkv_proj",
Luis Vega's avatar
Luis Vega committed
427
428
429
430
431
432
        )
        self.o_proj = RowParallelLinear(
            self.total_num_heads * self.head_dim,
            config.hidden_size,
            bias=False,
            quant_config=quant_config,
433
            prefix=f"{prefix}.o_proj",
Luis Vega's avatar
Luis Vega committed
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
        )

        self.attn = Attention(
            self.num_heads,
            self.head_dim,
            self.scaling,
            num_kv_heads=self.num_kv_heads,
            cache_config=cache_config,
            prefix=f"{prefix}.attn",
        )

    def forward(
        self,
        hidden_states: torch.Tensor,
        **kwargs,
    ) -> torch.Tensor:
        qkv, _ = self.qkv_proj(hidden_states)
        q, k, v = qkv.split([self.q_size, self.kv_size, self.kv_size], dim=-1)
        attn_output = self.attn(q, k, v)
        output, _ = self.o_proj(attn_output)
        return output


class NemotronHAttentionDecoderLayer(nn.Module):
    def __init__(
        self,
        config: NemotronHConfig,
        layer_idx: int,
462
463
464
        model_config: ModelConfig | None = None,
        cache_config: CacheConfig | None = None,
        quant_config: QuantizationConfig | None = None,
465
        parallel_config: ParallelConfig | None = None,
Luis Vega's avatar
Luis Vega committed
466
467
468
469
470
471
472
        prefix: str = "",
    ) -> None:
        super().__init__()

        self.mixer = NemotronHAttention(
            config,
            layer_idx,
473
            model_config,
Luis Vega's avatar
Luis Vega committed
474
475
            cache_config,
            quant_config,
476
            prefix=f"{prefix}.mixer",
Luis Vega's avatar
Luis Vega committed
477
478
        )

479
        self.norm = RMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
Luis Vega's avatar
Luis Vega committed
480
481
482
483
484

    def forward(
        self,
        positions: torch.Tensor,
        hidden_states: torch.Tensor,
485
        residual: torch.Tensor | None,
Luis Vega's avatar
Luis Vega committed
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
        **kwargs,
    ):
        if residual is None:
            residual = hidden_states
            hidden_states = self.norm(hidden_states)
        else:
            hidden_states, residual = self.norm(hidden_states, residual)

        hidden_states = self.mixer(hidden_states=hidden_states)
        return hidden_states, residual


ALL_DECODER_LAYER_TYPES = {
    "M": NemotronHMambaDecoderLayer,
    "-": NemotronHMLPDecoderLayer,
    "*": NemotronHAttentionDecoderLayer,
502
    "E": NemotronHMoEDecoderLayer,
Luis Vega's avatar
Luis Vega committed
503
504
505
}


506
@support_torch_compile
Luis Vega's avatar
Luis Vega committed
507
508
509
510
511
class NemotronHModel(nn.Module):
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        super().__init__()

        config: NemotronHConfig = vllm_config.model_config.hf_config
512
        model_config = vllm_config.model_config
Luis Vega's avatar
Luis Vega committed
513
514
        cache_config = vllm_config.cache_config
        quant_config = vllm_config.quant_config
515
        parallel_config = vllm_config.parallel_config
Luis Vega's avatar
Luis Vega committed
516
517
518
        lora_config = vllm_config.lora_config

        self.config = config
519
520
521
522
523
        lora_vocab = (
            (lora_config.lora_extra_vocab_size * (lora_config.max_loras or 1))
            if lora_config
            else 0
        )
Luis Vega's avatar
Luis Vega committed
524
525
526
527
528
529
530
531
532
        self.vocab_size = config.vocab_size + lora_vocab
        self.org_vocab_size = config.vocab_size

        self.embed_tokens = VocabParallelEmbedding(
            self.vocab_size,
            config.hidden_size,
            org_num_embeddings=config.vocab_size,
        )

533
534
        self.has_moe = "E" in config.hybrid_override_pattern

Luis Vega's avatar
Luis Vega committed
535
536
537
        def get_layer(prefix: str):
            layer_idx = int(prefix.rsplit(".", 1)[1])
            layer_class = ALL_DECODER_LAYER_TYPES[
538
539
                config.hybrid_override_pattern[layer_idx]
            ]
Luis Vega's avatar
Luis Vega committed
540
            return layer_class(
541
542
543
544
                config=config,
                layer_idx=layer_idx,
                model_config=model_config,
                cache_config=cache_config,
Luis Vega's avatar
Luis Vega committed
545
                quant_config=quant_config,
546
                parallel_config=parallel_config,
Luis Vega's avatar
Luis Vega committed
547
548
549
550
                prefix=prefix,
            )

        self.start_layer, self.end_layer, self.layers = make_layers(
551
552
            len(config.hybrid_override_pattern), get_layer, prefix=f"{prefix}.layers"
        )
553
        self.make_empty_intermediate_tensors = make_empty_intermediate_tensors_factory(
554
555
            ["hidden_states", "residual"], config.hidden_size
        )
Luis Vega's avatar
Luis Vega committed
556

557
        self.norm_f = RMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
Luis Vega's avatar
Luis Vega committed
558
559
560
561
562
563
564
565

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

    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
566
567
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
568
    ) -> torch.Tensor | IntermediateTensors:
Luis Vega's avatar
Luis Vega committed
569
570
571
572
573
574
575
576
577
578
579
        if get_pp_group().is_first_rank:
            if inputs_embeds is not None:
                hidden_states = inputs_embeds
            else:
                hidden_states = self.get_input_embeddings(input_ids)
            residual = None
        else:
            assert intermediate_tensors is not None
            hidden_states = intermediate_tensors["hidden_states"]
            residual = intermediate_tensors["residual"]

580
        for layer in islice(self.layers, self.start_layer, self.end_layer):
Luis Vega's avatar
Luis Vega committed
581
582
583
584
585
586
587
            hidden_states, residual = layer(
                positions=positions,
                hidden_states=hidden_states,
                residual=residual,
            )

        if not get_pp_group().is_last_rank:
588
589
590
            return IntermediateTensors(
                {"hidden_states": hidden_states, "residual": residual}
            )
Luis Vega's avatar
Luis Vega committed
591
592
593
        hidden_states, _ = self.norm_f(hidden_states, residual)
        return hidden_states

594
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
595
596
597
598
599
600
        stacked_params_mapping = [
            # (param_name, shard_name, shard_id)
            ("qkv_proj", "q_proj", "q"),
            ("qkv_proj", "k_proj", "k"),
            ("qkv_proj", "v_proj", "v"),
        ]
Luis Vega's avatar
Luis Vega committed
601

602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
        if self.has_moe:
            # (param_name, weight_name, expert_id, shard_id)
            expert_params_mapping = FusedMoE.make_expert_params_mapping(
                # - FusedMoe.w1 (aka gate_proj) should be up_proj since that's
                #   what the activation is applied to
                # - FusedMoe.w3 (aka up_proj) should be ignored since we're
                #   using non-gated MoE
                ckpt_gate_proj_name="up_proj",
                ckpt_down_proj_name="down_proj",
                ckpt_up_proj_name="",
                num_experts=self.config.n_routed_experts,
                num_redundant_experts=getattr(self, "num_redundant_experts", 0),
            )
        else:
            expert_params_mapping = []

Luis Vega's avatar
Luis Vega committed
618
619
620
        params_dict = dict(self.named_parameters())
        loaded_params: set[str] = set()
        for name, loaded_weight in weights:
621
622
623
624
625
626
627
628
629
630
631
632
633
634
            if "scale" in name:
                # Remapping the name of FP8 kv-scale.
                name = maybe_remap_kv_scale_name(name, params_dict)
                if name is None:
                    continue

            # load stacked params
            for param_name, weight_name, shard_id in stacked_params_mapping:
                if weight_name not in name:
                    continue
                name = name.replace(weight_name, param_name)
                # Skip loading extra bias for GPTQ models.
                if name.endswith(".bias") and name not in params_dict:
                    continue
Luis Vega's avatar
Luis Vega committed
635

636
637
638
                if is_pp_missing_parameter(name, self):
                    continue

Luis Vega's avatar
Luis Vega committed
639
640
                param = params_dict[name]
                weight_loader = param.weight_loader
641
642
643
                weight_loader(param, loaded_weight, shard_id)
                break

Luis Vega's avatar
Luis Vega committed
644
645
            # load other params
            else:
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
                is_expert_weight = False
                for mapping in expert_params_mapping:
                    param_name, weight_name, expert_id, shard_id = mapping
                    if weight_name not in 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 = 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,
                        loaded_weight,
                        name_mapped,
                        shard_id=shard_id,
                        expert_id=expert_id,
                        return_success=True,
                    )
                    if success:
                        name = name_mapped
                        break
                else:
                    if is_expert_weight:
                        continue

684
685
686
                    if is_pp_missing_parameter(name, self):
                        continue

687
688
689
690
691
                    param = params_dict[name]
                    weight_loader = getattr(
                        param, "weight_loader", default_weight_loader
                    )
                    weight_loader(param, loaded_weight)
Luis Vega's avatar
Luis Vega committed
692
693
694
695
696

            loaded_params.add(name)
        return loaded_params


697
class NemotronHForCausalLM(
698
699
700
701
702
703
704
    nn.Module,
    HasInnerState,
    SupportsLoRA,
    SupportsPP,
    IsHybrid,
    SupportsQuant,
    MixtureOfExperts,
705
    SupportsMambaPrefixCaching,
706
):
707
708
    hf_to_vllm_mapper = WeightsMapper(
        orig_to_new_prefix={"backbone": "model"},
709
        orig_to_new_substr={"A_log": "A", "embeddings": "embed_tokens"},
710
711
    )

Luis Vega's avatar
Luis Vega committed
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
    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"]

727
728
729
730
731
732
733
734
735
736
737
    @classmethod
    def get_mamba_state_dtype_from_config(
        cls,
        vllm_config: "VllmConfig",
    ) -> tuple[torch.dtype, torch.dtype]:
        return MambaStateDtypeCalculator.mamba2_state_dtype(
            vllm_config.model_config.dtype,
            vllm_config.cache_config.mamba_cache_dtype,
            vllm_config.cache_config.mamba_ssm_cache_dtype,
        )

738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
    @classmethod
    def get_mamba_state_shape_from_config(
        cls,
        vllm_config: "VllmConfig",
    ) -> tuple[tuple[int, int], tuple[int, int, int]]:
        """Calculate shapes for Mamba's convolutional and state caches.

        Args:
            vllm_config: vLLM config

        Returns:
            Tuple containing:
            - conv_state_shape: Shape for convolutional state cache
            - temporal_state_shape: Shape for state space model cache
        """
        parallel_config = vllm_config.parallel_config
        hf_config = vllm_config.model_config.hf_config
755
        intermediate_size = hf_config.mamba_num_heads * hf_config.mamba_head_dim
756

757
        return MambaStateShapeCalculator.mamba2_state_shape(
758
759
760
761
762
763
764
765
766
            intermediate_size=intermediate_size,
            tp_world_size=parallel_config.tensor_parallel_size,
            n_groups=hf_config.n_groups,
            num_heads=hf_config.mamba_num_heads,
            head_dim=hf_config.mamba_head_dim,
            state_size=hf_config.ssm_state_size,
            conv_kernel=hf_config.conv_kernel,
        )

Luis Vega's avatar
Luis Vega committed
767
768
769
770
771
772
773
774
775
776
777
778
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
        config = vllm_config.model_config.hf_config
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        lora_config = vllm_config.lora_config
        scheduler_config = vllm_config.scheduler_config

        self.quant_config = vllm_config.quant_config

        super().__init__()
        self.config = config
        self.scheduler_config = scheduler_config
779
780
781
        self.model = NemotronHModel(
            vllm_config=vllm_config, prefix=maybe_prefix(prefix, "model")
        )
Luis Vega's avatar
Luis Vega committed
782
783
784
785
786
787
788
789
790
791
        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
792
793
            if not lora_config
            else lora_config.lora_vocab_padding_size,
794
            prefix=maybe_prefix(prefix, "lm_head"),
Luis Vega's avatar
Luis Vega committed
795
796
        )

797
798
799
        self.logits_processor = LogitsProcessor(
            self.unpadded_vocab_size, config.vocab_size
        )
Luis Vega's avatar
Luis Vega committed
800

801
802
803
        self.make_empty_intermediate_tensors = (
            self.model.make_empty_intermediate_tensors
        )
Luis Vega's avatar
Luis Vega committed
804

805
806
807
808
809
        # Set MoE hyperparameters
        if self.model.has_moe:
            self.expert_weights = []
            self.num_expert_groups = config.n_group

810
            self.moe_layers = []
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
            example_moe = None
            for layer in self.model.layers:
                if isinstance(layer, NemotronHMoEDecoderLayer):
                    # Pick last one layer since the first ones
                    # may be dense layers.
                    example_moe = layer.mixer
                    self.moe_layers.append(layer.mixer.experts)

            self.num_moe_layers = len(self.moe_layers)
            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  # noqa: E501
            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 layer in self.model.layers:
            if isinstance(layer, NemotronHMoEDecoderLayer):
                moe = layer.mixer
                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()

Luis Vega's avatar
Luis Vega committed
844
845
846
    def get_input_embeddings(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.model.get_input_embeddings(input_ids)

847
848
849
850
    def forward(
        self,
        input_ids: torch.Tensor,
        positions: torch.Tensor,
851
852
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
853
854
855
856
857
        **kwargs,
    ):
        hidden_states = self.model(
            input_ids, positions, intermediate_tensors, inputs_embeds
        )
Luis Vega's avatar
Luis Vega committed
858
859
860
861
862
863

        return hidden_states

    def compute_logits(
        self,
        hidden_states: torch.Tensor,
864
    ) -> torch.Tensor | None:
865
        logits = self.logits_processor(self.lm_head, hidden_states)
Luis Vega's avatar
Luis Vega committed
866
867
        return logits

868
    def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
Luis Vega's avatar
Luis Vega committed
869
        loader = AutoWeightsLoader(self)
870
        return loader.load_weights(weights, mapper=self.hf_to_vllm_mapper)