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

import torch
from torch import nn
from transformers import LlamaConfig

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

55
from .interfaces import SupportsLoRA, SupportsPP
56
from .utils import (AutoWeightsLoader, PPMissingLayer, is_pp_missing_parameter,
57
58
                    make_empty_intermediate_tensors_factory, make_layers,
                    maybe_prefix)
59

Woosuk Kwon's avatar
Woosuk Kwon committed
60
61

class LlamaMLP(nn.Module):
62

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

    def forward(self, x):
93
94
        x, _ = self.gate_up_proj(x)
        x = self.act_fn(x)
Woosuk Kwon's avatar
Woosuk Kwon committed
95
96
97
98
99
100
101
102
        x, _ = self.down_proj(x)
        return x


class LlamaAttention(nn.Module):

    def __init__(
        self,
103
        config: LlamaConfig,
104
105
106
107
108
109
        hidden_size: int,
        num_heads: int,
        num_kv_heads: int,
        rope_theta: float = 10000,
        rope_scaling: Optional[Dict[str, Any]] = None,
        max_position_embeddings: int = 8192,
110
        quant_config: Optional[QuantizationConfig] = None,
111
        bias: bool = False,
112
        cache_config: Optional[CacheConfig] = None,
113
        prefix: str = "",
114
    ) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
115
        super().__init__()
116
        self.hidden_size = hidden_size
Zhuohan Li's avatar
Zhuohan Li committed
117
        tp_size = get_tensor_model_parallel_world_size()
118
        self.total_num_heads = num_heads
Zhuohan Li's avatar
Zhuohan Li committed
119
120
        assert self.total_num_heads % tp_size == 0
        self.num_heads = self.total_num_heads // tp_size
121
        self.total_num_kv_heads = num_kv_heads
122
123
124
125
126
127
128
129
130
        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)
131
132
133
        # MistralConfig has an optional head_dim introduced by Mistral-Nemo
        self.head_dim = getattr(config, "head_dim",
                                self.hidden_size // self.total_num_heads)
Zhuohan Li's avatar
Zhuohan Li committed
134
135
        self.q_size = self.num_heads * self.head_dim
        self.kv_size = self.num_kv_heads * self.head_dim
136
        self.scaling = self.head_dim**-0.5
137
138
        self.rope_theta = rope_theta
        self.max_position_embeddings = max_position_embeddings
Woosuk Kwon's avatar
Woosuk Kwon committed
139

140
        self.qkv_proj = QKVParallelLinear(
141
142
143
144
            hidden_size=hidden_size,
            head_size=self.head_dim,
            total_num_heads=self.total_num_heads,
            total_num_kv_heads=self.total_num_kv_heads,
145
            bias=bias,
146
            quant_config=quant_config,
147
            prefix=f"{prefix}.qkv_proj",
Woosuk Kwon's avatar
Woosuk Kwon committed
148
        )
149

150
        self.o_proj = RowParallelLinear(
151
152
            input_size=self.total_num_heads * self.head_dim,
            output_size=hidden_size,
153
            bias=bias,
154
            quant_config=quant_config,
155
            prefix=f"{prefix}.o_proj",
Woosuk Kwon's avatar
Woosuk Kwon committed
156
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
157

158
159
160
161
        is_neox_style = True
        if quant_config is not None and quant_config.get_name() == "gguf":
            is_neox_style = False

162
163
164
165
166
167
        self.rotary_emb = get_rope(
            self.head_dim,
            rotary_dim=self.head_dim,
            max_position=max_position_embeddings,
            base=rope_theta,
            rope_scaling=rope_scaling,
168
            is_neox_style=is_neox_style,
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,
177
            prefix=f"{prefix}.attn",
178
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
179
180
181

    def forward(
        self,
182
        positions: torch.Tensor,
Woosuk Kwon's avatar
Woosuk Kwon committed
183
        hidden_states: torch.Tensor,
184
185
        kv_cache: torch.Tensor,
        attn_metadata: AttentionMetadata,
Woosuk Kwon's avatar
Woosuk Kwon committed
186
    ) -> torch.Tensor:
187
        qkv, _ = self.qkv_proj(hidden_states)
Zhuohan Li's avatar
Zhuohan Li committed
188
        q, k, v = qkv.split([self.q_size, self.kv_size, self.kv_size], dim=-1)
189
        q, k = self.rotary_emb(positions, q, k)
190
        attn_output = self.attn(q, k, v, kv_cache, attn_metadata)
Woosuk Kwon's avatar
Woosuk Kwon committed
191
192
193
194
195
196
        output, _ = self.o_proj(attn_output)
        return output


class LlamaDecoderLayer(nn.Module):

197
198
199
    def __init__(
        self,
        config: LlamaConfig,
200
        cache_config: Optional[CacheConfig] = None,
201
        quant_config: Optional[QuantizationConfig] = None,
202
        prefix: str = "",
203
    ) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
204
205
        super().__init__()
        self.hidden_size = config.hidden_size
206
207
        rope_theta = getattr(config, "rope_theta", 10000)
        rope_scaling = getattr(config, "rope_scaling", None)
208
209
210
211
        if rope_scaling is not None and getattr(
                config, "original_max_position_embeddings", None):
            rope_scaling["original_max_position_embeddings"] = (
                config.original_max_position_embeddings)
212
213
        max_position_embeddings = getattr(config, "max_position_embeddings",
                                          8192)
214
215
216
217
        # Support abacusai/Smaug-72B-v0.1 with attention_bias
        # Support internlm/internlm-7b with bias
        attention_bias = getattr(config, "attention_bias", False) or getattr(
            config, "bias", False)
Woosuk Kwon's avatar
Woosuk Kwon committed
218
        self.self_attn = LlamaAttention(
219
            config=config,
220
221
            hidden_size=self.hidden_size,
            num_heads=config.num_attention_heads,
222
223
            num_kv_heads=getattr(config, "num_key_value_heads",
                                 config.num_attention_heads),
224
225
226
            rope_theta=rope_theta,
            rope_scaling=rope_scaling,
            max_position_embeddings=max_position_embeddings,
227
            quant_config=quant_config,
228
            bias=attention_bias,
229
            cache_config=cache_config,
230
            prefix=f"{prefix}.self_attn",
Woosuk Kwon's avatar
Woosuk Kwon committed
231
232
        )
        self.mlp = LlamaMLP(
233
234
235
            hidden_size=self.hidden_size,
            intermediate_size=config.intermediate_size,
            hidden_act=config.hidden_act,
236
            quant_config=quant_config,
237
            bias=getattr(config, "mlp_bias", False),
238
            prefix=f"{prefix}.mlp",
Woosuk Kwon's avatar
Woosuk Kwon committed
239
        )
240
241
242
243
        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)
Woosuk Kwon's avatar
Woosuk Kwon committed
244
245
246

    def forward(
        self,
247
        positions: torch.Tensor,
Woosuk Kwon's avatar
Woosuk Kwon committed
248
        hidden_states: torch.Tensor,
249
250
        kv_cache: torch.Tensor,
        attn_metadata: AttentionMetadata,
251
252
        residual: Optional[torch.Tensor],
    ) -> Tuple[torch.Tensor, torch.Tensor]:
Woosuk Kwon's avatar
Woosuk Kwon committed
253
        # Self Attention
254
255
256
257
258
259
        if residual is None:
            residual = hidden_states
            hidden_states = self.input_layernorm(hidden_states)
        else:
            hidden_states, residual = self.input_layernorm(
                hidden_states, residual)
260
261
262
263
        hidden_states = self.self_attn(positions=positions,
                                       hidden_states=hidden_states,
                                       kv_cache=kv_cache,
                                       attn_metadata=attn_metadata)
Woosuk Kwon's avatar
Woosuk Kwon committed
264
265

        # Fully Connected
266
267
        hidden_states, residual = self.post_attention_layernorm(
            hidden_states, residual)
Woosuk Kwon's avatar
Woosuk Kwon committed
268
        hidden_states = self.mlp(hidden_states)
269
        return hidden_states, residual
Woosuk Kwon's avatar
Woosuk Kwon committed
270
271


272
@support_torch_compile
Woosuk Kwon's avatar
Woosuk Kwon committed
273
274
class LlamaModel(nn.Module):

275
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
Woosuk Kwon's avatar
Woosuk Kwon committed
276
        super().__init__()
277
278
279
280
281
282

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

Woosuk Kwon's avatar
Woosuk Kwon committed
283
284
        self.config = config
        self.padding_idx = config.pad_token_id
285
286
287
288
        lora_vocab = (lora_config.lora_extra_vocab_size *
                      (lora_config.max_loras or 1)) if lora_config else 0
        self.vocab_size = config.vocab_size + lora_vocab
        self.org_vocab_size = config.vocab_size
289
290
291
292
293
294
        if get_pp_group().is_first_rank or (config.tie_word_embeddings
                                            and get_pp_group().is_last_rank):
            self.embed_tokens = VocabParallelEmbedding(
                self.vocab_size,
                config.hidden_size,
                org_num_embeddings=config.vocab_size,
295
                quant_config=quant_config,
296
297
298
            )
        else:
            self.embed_tokens = PPMissingLayer()
299
        self.start_layer, self.end_layer, self.layers = make_layers(
300
            config.num_hidden_layers,
301
302
303
304
            lambda prefix: LlamaDecoderLayer(config=config,
                                             cache_config=cache_config,
                                             quant_config=quant_config,
                                             prefix=prefix),
305
306
            prefix=f"{prefix}.layers",
        )
307
308
309
310
        if get_pp_group().is_last_rank:
            self.norm = RMSNorm(config.hidden_size, eps=config.rms_norm_eps)
        else:
            self.norm = PPMissingLayer()
Woosuk Kwon's avatar
Woosuk Kwon committed
311

312
313
314
315
        self.make_empty_intermediate_tensors = (
            make_empty_intermediate_tensors_factory(
                ["hidden_states", "residual"], config.hidden_size))

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

Woosuk Kwon's avatar
Woosuk Kwon committed
319
320
    def forward(
        self,
321
        input_ids: Optional[torch.Tensor],
322
        positions: torch.Tensor,
323
324
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
325
        intermediate_tensors: Optional[IntermediateTensors],
326
        inputs_embeds: Optional[torch.Tensor] = None,
327
328
329
330
331
332
333
    ) -> Union[torch.Tensor, IntermediateTensors]:
        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
334
        else:
335
336
337
338
339
            assert intermediate_tensors is not None
            hidden_states = intermediate_tensors["hidden_states"]
            residual = intermediate_tensors["residual"]

        for i in range(self.start_layer, self.end_layer):
Woosuk Kwon's avatar
Woosuk Kwon committed
340
            layer = self.layers[i]
341
342
343
            hidden_states, residual = layer(positions, hidden_states,
                                            kv_caches[i - self.start_layer],
                                            attn_metadata, residual)
344
345
346
347
348
349
350

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

351
        hidden_states, _ = self.norm(hidden_states, residual)
Woosuk Kwon's avatar
Woosuk Kwon committed
352
353
        return hidden_states

354
355
    def load_weights(self, weights: Iterable[Tuple[str,
                                                   torch.Tensor]]) -> Set[str]:
356
357
358
359
360
361
362
363
364
        stacked_params_mapping = [
            # (param_name, shard_name, shard_id)
            (".qkv_proj", ".q_proj", "q"),
            (".qkv_proj", ".k_proj", "k"),
            (".qkv_proj", ".v_proj", "v"),
            (".gate_up_proj", ".gate_proj", 0),
            (".gate_up_proj", ".up_proj", 1),
        ]
        params_dict = dict(self.named_parameters())
365
        loaded_params: Set[str] = set()
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
        for name, loaded_weight in weights:
            if "rotary_emb.inv_freq" in name:
                continue
            if ("rotary_emb.cos_cached" in name
                    or "rotary_emb.sin_cached" in name):
                # Models trained using ColossalAI may include these tensors in
                # the checkpoint. Skip them.
                continue
            if scale_name := get_compressed_tensors_cache_scale(name):
                # Loading kv cache scales for compressed-tensors quantization
                param = params_dict[scale_name]
                weight_loader = getattr(param, "weight_loader",
                                        default_weight_loader)
                loaded_weight = loaded_weight[0]
                weight_loader(param, loaded_weight)
381
                loaded_params.add(scale_name)
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
                continue
            for param_name, weight_name, shard_id in stacked_params_mapping:
                if weight_name not in name:
                    continue
                name = name.replace(weight_name, param_name)
                # Skip loading extra bias for GPTQ models.
                if name.endswith(".bias") and name not in params_dict:
                    continue

                if is_pp_missing_parameter(name, self):
                    continue

                param = params_dict[name]
                weight_loader = param.weight_loader
                weight_loader(param, loaded_weight, shard_id)
                break
            else:
                # Skip loading extra bias for GPTQ models.
                if name.endswith(".bias") and name not in params_dict:
                    continue
                # Remapping the name of FP8 kv-scale.
                name = maybe_remap_kv_scale_name(name, params_dict)
                if name is None:
                    continue

                if is_pp_missing_parameter(name, self):
                    continue

                param = params_dict[name]
                weight_loader = getattr(param, "weight_loader",
                                        default_weight_loader)
                weight_loader(param, loaded_weight)
414
415
            loaded_params.add(name)
        return loaded_params
416
417
418
419
420
421
422
423
424
425
426
427
428
429

    # If this function is called, it should always initialize KV cache scale
    # factors (or else raise an exception). Thus, handled exceptions should
    # make sure to leave KV cache scale factors in a known good (dummy) state
    def load_kv_cache_scales(self, quantization_param_path: str) -> None:
        tp_size = get_tensor_model_parallel_world_size()
        tp_rank = get_tensor_model_parallel_rank()
        for layer_idx, scaling_factor in kv_cache_scales_loader(
                quantization_param_path, tp_rank, tp_size,
                self.config.num_hidden_layers,
                self.config.__class__.model_type):
            if not isinstance(self.layers[layer_idx], nn.Identity):
                layer_self_attn = self.layers[layer_idx].self_attn

430
            if current_platform.is_rocm():
431
432
433
434
435
436
437
438
439
440
441
                # The scaling factor convention we are assuming is
                # quantized_value * scaling_factor ~= true_value
                # which is consistent with the practice of setting
                # scaling_factor = tensor_amax / FPtype_max
                scaling_factor *= 2
            if hasattr(layer_self_attn, "kv_scale"):
                layer_self_attn.attn._kv_scale = scaling_factor
            else:
                raise RuntimeError("Self attention has no KV cache scaling "
                                   "factor attribute!")

Woosuk Kwon's avatar
Woosuk Kwon committed
442

443
class LlamaForCausalLM(nn.Module, SupportsLoRA, SupportsPP):
Terry's avatar
Terry committed
444
    packed_modules_mapping = {
445
446
        "qkv_proj": ["q_proj", "k_proj", "v_proj"],
        "gate_up_proj": ["gate_proj", "up_proj"]
Terry's avatar
Terry committed
447
448
449
450
    }

    # LoRA specific attributes
    supported_lora_modules = [
451
452
        "qkv_proj", "o_proj", "gate_up_proj", "down_proj", "embed_tokens",
        "lm_head"
Terry's avatar
Terry committed
453
454
455
    ]
    embedding_modules = {
        "embed_tokens": "input_embeddings",
456
        "lm_head": "output_embeddings"
Terry's avatar
Terry committed
457
458
    }
    embedding_padding_modules = ["lm_head"]
459
460
461
462
463
464
465
466
467
468
469

    # BitandBytes specific attributes
    default_bitsandbytes_target_modules = [
        ".gate_proj.",
        ".down_proj.",
        ".up_proj.",
        ".q_proj.",
        ".k_proj.",
        ".v_proj.",
        ".o_proj.",
    ]
470
471
472
473
474
475
476
477
    bitsandbytes_stacked_params_mapping = {
        # shard_name, weight_name, index
        "q_proj": ("qkv_proj", 0),
        "k_proj": ("qkv_proj", 1),
        "v_proj": ("qkv_proj", 2),
        "gate_proj": ("gate_up_proj", 0),
        "up_proj": ("gate_up_proj", 1),
    }
478

479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
    # Mistral/Llama models can also be loaded with --load-format mistral
    # from consolidated.safetensors checkpoints
    mistral_mapping = {
        "layers": "model.layers",
        "attention": "self_attn",
        "wq": "q_proj",
        "wk": "k_proj",
        "wv": "v_proj",
        "wo": "o_proj",
        "attention_norm": "input_layernorm",
        "feed_forward": "mlp",
        "w1": "gate_proj",
        "w2": "down_proj",
        "w3": "up_proj",
        "ffn_norm": "post_attention_layernorm",
        "tok_embeddings": "model.embed_tokens",
        "output": "lm_head",
        "norm": "model.norm"
    }
498

499
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
Woosuk Kwon's avatar
Woosuk Kwon committed
500
        super().__init__()
501
502
503
504
        config = vllm_config.model_config.hf_config
        quant_config = vllm_config.quant_config
        lora_config = vllm_config.lora_config
        pooler_config = vllm_config.model_config.pooler_config
Woosuk Kwon's avatar
Woosuk Kwon committed
505
        self.config = config
506
507
        self.lora_config = lora_config

508
        self.model = LlamaModel(vllm_config=vllm_config,
509
                                prefix=maybe_prefix(prefix, "model"))
510
511
512
513
514
515
516
517
        if get_pp_group().is_last_rank:
            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,
518
519
520
521
522
523
                padding_size=(
                    DEFAULT_VOCAB_PADDING_SIZE
                    # We need bigger padding if using lora for kernel
                    # compatibility
                    if not lora_config else
                    lora_config.lora_vocab_padding_size),
524
                quant_config=quant_config,
525
                prefix=maybe_prefix(prefix, "lm_head"),
526
527
            )
            if config.tie_word_embeddings:
528
529
                self.lm_head = self.lm_head.tie_weights(
                    self.model.embed_tokens)
530
531
532
533
534

            logit_scale = getattr(config, "logit_scale", 1.0)
            self.logits_processor = LogitsProcessor(self.unpadded_vocab_size,
                                                    config.vocab_size,
                                                    logit_scale)
Joe Runde's avatar
Joe Runde committed
535
            self.sampler = get_sampler()
536
537
        else:
            self.lm_head = PPMissingLayer()
538
539
        self.make_empty_intermediate_tensors = (
            self.model.make_empty_intermediate_tensors)
540
541
542
543
544
        self._pooler = Pooler.from_config_with_defaults(
            pooler_config,
            pooling_type=PoolingType.STEP,
            normalize=False,
            softmax=False)
Woosuk Kwon's avatar
Woosuk Kwon committed
545

546
547
548
    def get_input_embeddings(self, input_ids: torch.Tensor) -> torch.Tensor:
        return self.model.get_input_embeddings(input_ids)

Woosuk Kwon's avatar
Woosuk Kwon committed
549
550
    def forward(
        self,
551
552
        input_ids: torch.Tensor,
        positions: torch.Tensor,
553
554
        kv_caches: List[torch.Tensor],
        attn_metadata: AttentionMetadata,
555
        intermediate_tensors: Optional[IntermediateTensors] = None,
556
        inputs_embeds: Optional[torch.Tensor] = None,
557
558
    ) -> Union[torch.Tensor, IntermediateTensors]:
        model_output = self.model(input_ids, positions, kv_caches,
559
560
                                  attn_metadata, intermediate_tensors,
                                  inputs_embeds)
561
        return model_output
562

563
564
565
566
567
    def compute_logits(
        self,
        hidden_states: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[torch.Tensor]:
568
        logits = self.logits_processor(self.lm_head, hidden_states,
569
570
571
                                       sampling_metadata)
        return logits

572
573
574
575
576
577
578
579
    def pooler(
        self,
        hidden_states: torch.Tensor,
        pooling_metadata: PoolingMetadata,
    ) -> Optional[PoolerOutput]:
        logits = self.compute_logits(hidden_states, None)
        return self._pooler(logits, pooling_metadata)

580
581
    def sample(self, logits: torch.Tensor,
               sampling_metadata: SamplingMetadata) -> Optional[SamplerOutput]:
582
        next_tokens = self.sampler(logits, sampling_metadata)
Woosuk Kwon's avatar
Woosuk Kwon committed
583
584
        return next_tokens

585
586
    def load_weights(self, weights: Iterable[Tuple[str,
                                                   torch.Tensor]]) -> Set[str]:
587
588
589
590
591
        loader = AutoWeightsLoader(
            self,
            skip_prefixes=(["lm_head."]
                           if self.config.tie_word_embeddings else None),
        )
592
        return loader.load_weights(
593
            self.maybe_remap_mistral(name, loaded_weight)
594
            for name, loaded_weight in weights)
595
596

    def load_kv_cache_scales(self, quantization_param_path: str) -> None:
597
        self.model.load_kv_cache_scales(quantization_param_path)
598
599
600
601

    # This function is used to remap the mistral format as
    # used by Mistral and Llama <=2
    def maybe_remap_mistral(
602
603
604
605
        self,
        name: str,
        loaded_weight: torch.Tensor,
    ) -> Tuple[str, torch.Tensor]:
606

607
        def permute(w: torch.Tensor, n_heads: int):
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
            attn_in = self.config.head_dim * n_heads
            attn_out = self.config.hidden_size

            return w.view(n_heads, attn_in // n_heads // 2, 2,
                          attn_out).transpose(1, 2).reshape(attn_in, attn_out)

        mapping = self.mistral_mapping
        modules = name.split(".")

        # rotary embeds should be sliced
        if "wk" in modules:
            loaded_weight = permute(loaded_weight,
                                    self.config.num_key_value_heads)
        elif "wq" in modules:
            loaded_weight = permute(loaded_weight,
                                    self.config.num_attention_heads)

        for item in modules:
            if item in mapping and mapping[item] not in name:
                name = name.replace(item, mapping[item])

        return name, loaded_weight
630
631


632
class LlamaEmbeddingModel(nn.Module, SupportsLoRA, SupportsPP):
633
634
635
636
637
638
639
640
641
642
    """
    A model that uses Llama with additional embedding functionalities.

    This class encapsulates the LlamaModel and provides an interface for
    embedding operations and customized pooling functions.

    Attributes:
        model: An instance of LlamaModel used for forward operations.
        _pooler: An instance of Pooler used for pooling operations.
    """
643
644
645
646
647
648
649
650
651
652
653
654
655
    packed_modules_mapping = {
        "qkv_proj": ["q_proj", "k_proj", "v_proj"],
        "gate_up_proj": ["gate_proj", "up_proj"]
    }

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

657
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
658
659
        super().__init__()

660
661
        pooler_config = vllm_config.model_config.pooler_config

662
        self.model = LlamaModel(vllm_config=vllm_config,
663
                                prefix=maybe_prefix(prefix, "model"))
664
665
666
667
668
        self._pooler = Pooler.from_config_with_defaults(
            pooler_config,
            pooling_type=PoolingType.LAST,
            normalize=True,
            softmax=False)
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
        self.make_empty_intermediate_tensors = (
            self.model.make_empty_intermediate_tensors)

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

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

    def load_weights(self, weights: Iterable[Tuple[str, torch.Tensor]]):
        self.model.load_weights(weights)

    def load_kv_cache_scales(self, quantization_param_path: str) -> None:
        self.model.load_kv_cache_scales(quantization_param_path)
696
697
698
699
700

    # LRUCacheWorkerLoRAManager instantiation requires model config.
    @property
    def config(self):
        return self.model.config