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

4
import itertools
5
from abc import abstractmethod
6

7
from typing import Any
8
from vllm import envs
9
10

import torch
11
from torch.nn.parameter import Parameter, UninitializedParameter
12

13
14
15
16
17
18
19
20
from vllm.distributed import (
    divide,
    get_tensor_model_parallel_rank,
    get_tensor_model_parallel_world_size,
    split_tensor_along_last_dim,
    tensor_model_parallel_all_gather,
    tensor_model_parallel_all_reduce,
)
21
from vllm.logger import init_logger
22
from vllm.model_executor.custom_op import CustomOp
23
from vllm.model_executor.layers.quantization.base_config import (
24
25
26
    QuantizationConfig,
    QuantizeMethodBase,
)
27
from vllm.model_executor.layers.utils import dispatch_unquantized_gemm
28
29
30
31
32
33
34
35
36
from vllm.model_executor.parameter import (
    BasevLLMParameter,
    BlockQuantScaleParameter,
    ModelWeightParameter,
    PackedColumnParameter,
    PackedvLLMParameter,
    PerTensorScaleParameter,
    RowvLLMParameter,
)
37
from vllm.model_executor.utils import set_weight_attrs
38
from vllm.platforms import current_platform
gaoqiong's avatar
gaoqiong committed
39

zhuwenwen's avatar
zhuwenwen committed
40
import os
41
from vllm.model_executor.utils import gemm_bank_conf
42

43
from lmslim.quantize.quant_ops import lm_faster_rmsquant
44

45
46
logger = init_logger(__name__)

47
WEIGHT_LOADER_V2_SUPPORTED = [
48
    "UnquantizedLinearMethod",
49
    "CompressedTensorsLinearMethod",
50
    "CompressedTensorsLinearTransformMethod",
51
52
    "BitBLASLinearMethod",
    "GPTQBitBLASLinearMethod",
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
    "AWQMarlinLinearMethod",
    "AWQLinearMethod",
    "GPTQMarlinLinearMethod",
    "Fp8LinearMethod",
    "MarlinLinearMethod",
    "GPTQMarlin24LinearMethod",
    "TPUInt8LinearMethod",
    "GPTQLinearMethod",
    "FBGEMMFp8LinearMethod",
    "ModelOptFp8LinearMethod",
    "IPEXAWQLinearMethod",
    "IPEXGPTQLinearMethod",
    "HQQMarlinMethod",
    "QuarkLinearMethod",
    "ModelOptNvFp4LinearMethod",
68
    "PetitNvFp4LinearMethod",
zhuwenwen's avatar
zhuwenwen committed
69
    "BlockInt8LinearMethod",
70
]
71

72

73
74
75
def adjust_bitblas_shard(param, shard_size, shard_offset):
    bitblas_tile_size = getattr(param, "bitblas_tile_size", None)
    if bitblas_tile_size is not None:
76
        return (shard_size // bitblas_tile_size, shard_offset // bitblas_tile_size)
77
78
79
80

    return shard_size, shard_offset


81
82
83
84
85
86
87
88
def adjust_marlin_shard(param, shard_size, shard_offset):
    marlin_tile_size = getattr(param, "marlin_tile_size", None)
    if marlin_tile_size is None:
        return shard_size, shard_offset

    return shard_size * marlin_tile_size, shard_offset * marlin_tile_size


89
90
91
def adjust_bitsandbytes_4bit_shard(
    param: Parameter, shard_offsets: dict[str, tuple[int, int]], loaded_shard_id: str
) -> tuple[int, int]:
92
93
    """Adjust the quantization offsets and sizes for BitsAndBytes sharding."""

94
95
    total, _ = shard_offsets["total"]
    orig_offset, orig_size = shard_offsets[loaded_shard_id]
96
97
98
99
100
101
102
103

    quantized_total = param.data.shape[0]
    quantized_offset = orig_offset * quantized_total // total
    quantized_size = orig_size * quantized_total // total

    return quantized_size, quantized_offset


104
105
106
def adjust_scalar_to_fused_array(param, loaded_weight, shard_id):
    """For fused modules (QKV and MLP) we have an array of length
    N that holds 1 scale for each "logical" matrix. So the param
107
108
    is an array of length N. The loaded_weight corresponds to
    one of the shards on disk. Here, we slice the param based on
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    the shard_id for loading.
    """
    qkv_idxs = {"q": 0, "k": 1, "v": 2}

    if isinstance(shard_id, str):
        shard_id = qkv_idxs[shard_id]
    elif not isinstance(shard_id, int):
        raise ValueError(f"Unknown Shard Id {shard_id}")

    # AutoFP8 scales do not have a shape
    # compressed-tensors scales do have a shape
    if len(loaded_weight.shape) != 0:
        assert loaded_weight.shape[0] == 1
        loaded_weight = loaded_weight[0]

124
125
126
127
    if envs.VLLM_USE_NN:
        return param[shard_id], loaded_weight.t()
    else:
        return param[shard_id], loaded_weight
128
129


130
131
132
133
134
135
136
137
# TODO(Isotr0py): We might need a more flexible structure to handle
# bitsandbytes shard offsets.
def left_shift_bitsandbytes_4bit_shard(bnb_weight_attrs: dict[str, Any]):
    """
    Separate the BitsAndBytes 4-bit shard.

    For example, given bnb weight attributes as below:
    {
138
        'bnb_shard_offsets': array([0, 4, 8, 16]),
139
140
141
142
143
        'bnb_quant_state': {0: ..., 1: ..., 2: ...},
    }

    The function will return:
    {
144
        'bnb_shard_offsets': array([0, 4]),
145
146
147
148
149
150
151
152
153
154
155
156
157
158
        'bnb_quant_state': {0: ...},
    }
    and
    {
        'bnb_shard_offsets': array([0, 4, 12]),
        'bnb_quant_state': {0: ..., 1: ...},
    }
    """
    shard_offsets = bnb_weight_attrs["bnb_shard_offsets"]
    offset_l = shard_offsets[:2]
    offset_r = shard_offsets[1:] - shard_offsets[1]
    quant_state_l = {0: bnb_weight_attrs["bnb_quant_state"][0]}
    quant_state_r = {
        i - 1: bnb_weight_attrs["bnb_quant_state"][i]
159
        for i in range(1, len(shard_offsets) - 1)
160
161
162
163
164
165
    }
    left = dict(bnb_shard_offsets=offset_l, bnb_quant_state=quant_state_l)
    right = dict(bnb_shard_offsets=offset_r, bnb_quant_state=quant_state_r)
    return left, right


166
class LinearMethodBase(QuantizeMethodBase):
167
168
169
    """Base class for different (maybe quantized) linear methods."""

    @abstractmethod
170
171
172
173
174
175
176
177
178
179
180
    def create_weights(
        self,
        layer: torch.nn.Module,
        input_size_per_partition: int,
        output_partition_sizes: list[int],
        input_size: int,
        output_size: int,
        params_dtype: torch.dtype,
        **extra_weight_attrs,
    ):
        """Create weights for a linear layer.
181
           The weights will be set as attributes of the layer.
182

183
184
185
        Args:
            layer: The layer that is using the LinearMethodBase factory.
            input_size_per_partition: Size of the weight input dim on rank X.
186
            output_partition_sizes: Sizes of the output dim of each logical
187
188
189
190
191
192
                weight on rank X. E.g., output_partition_sizes for QKVLinear
                is a list contains the width of Wq, Wk, Wv on rank X.
            input_size: Size of the input dim of the weight across all ranks.
            output_size: Size of the output dim of the weight across all ranks.
            params_dtype: Datatype of the parameters.
        """
193
194
195
        raise NotImplementedError

    @abstractmethod
196
197
198
199
    def apply(
        self,
        layer: torch.nn.Module,
        x: torch.Tensor,
200
        bias: torch.Tensor | None = None,
201
    ) -> torch.Tensor:
202
203
        """Apply the weights in layer to the input tensor.
        Expects create_weights to have been called before on the layer."""
204
205
206
207
        raise NotImplementedError


class UnquantizedLinearMethod(LinearMethodBase):
208
    """Linear method without quantization."""
209
210
    
    def __init__(self):
zhuwenwen's avatar
zhuwenwen committed
211
        self.use_llama_nn = os.environ.get('LLAMA_NN') == '1'
212
        self.use_gemm_pad = os.environ.get('GEMM_PAD') == '1'
gaoqiong's avatar
gaoqiong committed
213
        
214

215

216
217
218
219
220
221
222
223
224
225
    def create_weights(
        self,
        layer: torch.nn.Module,
        input_size_per_partition: int,
        output_partition_sizes: list[int],
        input_size: int,
        output_size: int,
        params_dtype: torch.dtype,
        **extra_weight_attrs,
    ):
226
227
228
229
        # This method creates unquantized linear weights.
        # The weights are not quantized, and they are not sharded.
        # The amount of memory allocated for the weights is
        # sum(output_partition_sizes) * input_size_per_partition.
230
        weight_loader = extra_weight_attrs.pop("weight_loader")
231
232
233
        if envs.VLLM_USE_NN:
            weight = ModelWeightParameter(
                data=torch.empty(
234
235
                    input_size_per_partition,
                    sum(output_partition_sizes),
236
237
238
239
240
241
242
243
244
                    dtype=params_dtype,
                ),
                input_dim=1,
                output_dim=0,
                weight_loader=weight_loader,
            )
        else:
            weight = ModelWeightParameter(
                data=torch.empty(
245
246
                    sum(output_partition_sizes),
                    input_size_per_partition,
247
248
249
250
251
252
                    dtype=params_dtype,
                ),
                input_dim=1,
                output_dim=0,
                weight_loader=weight_loader,
            )
253

254
255
        layer.register_parameter("weight", weight)
        set_weight_attrs(weight, extra_weight_attrs)
256

257
    def process_weights_after_loading(self, layer: torch.nn.Module) -> None:
258
        if current_platform.is_cpu():
259
            from vllm.model_executor.layers.utils import dispatch_cpu_unquantized_gemm
260

261
            dispatch_cpu_unquantized_gemm(layer, remove_weight=True)
262

263
264
265
266
    def apply(
        self,
        layer: torch.nn.Module,
        x: torch.Tensor,
267
        bias: torch.Tensor | None = None,
268
    ) -> torch.Tensor:
zhuwenwen's avatar
zhuwenwen committed
269
        if self.use_llama_nn:
zhuwenwen's avatar
zhuwenwen committed
270
271
            # if os.environ['GEMM_PAD'] == '1' and gemm_bank_conf(layer.weight.shape[1] - 32):
            #     layer.weight = layer.weight[:,:-32]
zhuwenwen's avatar
zhuwenwen committed
272
            if bias is not None:
zhuwenwen's avatar
zhuwenwen committed
273
                if len(x.shape) == 2: 
274
                    return torch.addmm(bias, x, layer.weight)
zhuwenwen's avatar
zhuwenwen committed
275
                else:
276
                    return torch.matmul(x, layer.weight) + bias
zhuwenwen's avatar
zhuwenwen committed
277
            else:
278
                return torch.matmul(x, layer.weight)
zhuwenwen's avatar
zhuwenwen committed
279
        else:
zhuwenwen's avatar
zhuwenwen committed
280
281
282
283
284
285
286
287
288
289
            # if envs.VLLM_USE_NN and x.shape[-1] == layer.weight.shape[0]:
            #     return dispatch_unquantized_gemm()(layer, x, layer.weight.t(), bias)
            if envs.VLLM_USE_NN:
                if bias is not None:
                    if len(x.shape) == 2: 
                        return torch.addmm(bias, x, layer.weight)
                    else:
                        return torch.matmul(x, layer.weight) + bias
                else:
                    return torch.matmul(x, layer.weight)
290
            else:
zhuwenwen's avatar
zhuwenwen committed
291
                return dispatch_unquantized_gemm()(layer, x, layer.weight, bias)
292

293

294
class LinearBase(CustomOp):
295
    """Base linear layer.
296
297
298
299
300
301

    Args:
        input_size: input dimension of the linear layer.
        output_size: output dimension of the linear layer.
        skip_bias_add: If true, skip adding bias but instead return it.
        params_dtype: Data type for the parameters.
302
        quant_config: Quantization configure.
303
        prefix: Prefix for parameter names.
304
        return_bias: If true, return bias together with outputs in forward pass.
305
        disable_tp: If true, tensor parallelism will be disabled for this layer.
306
307
308
309
310
311
312
    """

    def __init__(
        self,
        input_size: int,
        output_size: int,
        skip_bias_add: bool = False,
313
314
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
315
        prefix: str = "",
316
317
        *,
        return_bias: bool = True,
318
        disable_tp: bool = False,
319
320
321
322
323
324
325
326
327
328
    ):
        super().__init__()

        # Keep input parameters
        self.input_size = input_size
        self.output_size = output_size
        self.skip_bias_add = skip_bias_add
        if params_dtype is None:
            params_dtype = torch.get_default_dtype()
        self.params_dtype = params_dtype
329
330
        self.quant_config = quant_config
        self.prefix = prefix
331
        if quant_config is None:
332
            self.quant_method: QuantizeMethodBase | None = UnquantizedLinearMethod()
333
        else:
334
            self.quant_method = quant_config.get_quant_method(self, prefix=prefix)
335
        self.return_bias = return_bias
336
        self.disable_tp = disable_tp
337
338
        self.tp_rank = get_tensor_model_parallel_rank() if not disable_tp else 0
        self.tp_size = get_tensor_model_parallel_world_size() if not disable_tp else 1
339

340
    def update_param_tp_status(self):
341
342
343
344
        for param in self.parameters():
            if isinstance(param, BasevLLMParameter):
                param.tp_rank = self.tp_rank
                param.tp_size = self.tp_size
345
346


347
@CustomOp.register("replicated_linear")
348
349
350
351
352
353
354
355
356
357
class ReplicatedLinear(LinearBase):
    """Replicated linear layer.

    Args:
        input_size: input dimension of the linear layer.
        output_size: output dimension of the linear layer.
        bias: If true, add bias.
        skip_bias_add: If true, skip adding bias but instead return it.
        params_dtype: Data type for the parameters.
        quant_config: Quantization configure.
358
359
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.qkv_proj)
360
        return_bias: If true, return bias together with outputs in forward pass.
361
        disable_tp: Take no effect for replicated linear layers.
362
363
    """

364
365
366
367
368
369
    def __init__(
        self,
        input_size: int,
        output_size: int,
        bias: bool = True,
        skip_bias_add: bool = False,
370
371
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
372
        eps: float | None = 1e-6,
373
374
375
        prefix: str = "",
        *,
        return_bias: bool = True,
376
        disable_tp: bool = False,
377
    ):
378
379
380
381
382
        # If MergedReplicatedLinear, use output size of each partition.
        if hasattr(self, "output_sizes"):
            self.output_partition_sizes = self.output_sizes
        else:
            self.output_partition_sizes = [output_size]
383
            
384
        self.eps = eps
385

386
387
388
389
390
391
392
393
394
395
        super().__init__(
            input_size,
            output_size,
            skip_bias_add,
            params_dtype,
            quant_config,
            prefix=prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
396

397
398
        # All the linear layer supports quant method.
        assert self.quant_method is not None
399
400
401
402
403
404
405
406
407
        self.quant_method.create_weights(
            self,
            self.input_size,
            self.output_partition_sizes,
            self.input_size,
            self.output_size,
            self.params_dtype,
            weight_loader=self.weight_loader,
        )
408

409
410
        if bias:
            self.bias = Parameter(
411
412
413
414
415
416
417
418
419
                torch.empty(self.output_size, dtype=self.params_dtype)
            )
            set_weight_attrs(
                self.bias,
                {
                    "output_dim": 0,
                    "weight_loader": self.weight_loader,
                },
            )
420
421
        else:
            self.register_parameter("bias", None)
422
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
423

424
425
426
    def weight_loader(self, param: Parameter, loaded_weight: torch.Tensor):
        # If the weight on disk does not have a shape, give it one
        # (such scales for AutoFp8).
427
428
429
430
431
432
433
434
435
436
437
        # Special case for GGUF

        is_gguf_weight = getattr(param, "is_gguf_weight", False)
        is_gguf_weight_type = getattr(param, "is_gguf_weight_type", False)
        if is_gguf_weight_type:
            param.weight_type = loaded_weight.item()

        # Materialize GGUF UninitializedParameter
        if is_gguf_weight and isinstance(param, UninitializedParameter):
            param.materialize(loaded_weight.shape, dtype=loaded_weight.dtype)

438
439
440
        if len(loaded_weight.shape) == 0:
            loaded_weight = loaded_weight.reshape(1)

441
        if envs.VLLM_USE_NN and not self.is_quantization:
442
443
            loaded_weight = loaded_weight.t()
            
444
445
        assert param.size() == loaded_weight.size(), (
            f"Tried to load weights of size {loaded_weight.size()}"
446
447
            f"to a parameter of size {param.size()}"
        )
448
449
        param.data.copy_(loaded_weight)

450
    def forward(
451
        self,
zhuwenwen's avatar
zhuwenwen committed
452
        x: torch.Tensor,
453
    ) -> torch.Tensor | tuple[torch.Tensor, Parameter | None]:
zhuwenwen's avatar
zhuwenwen committed
454
455
        bias = self.bias if not self.skip_bias_add else None
        assert self.quant_method is not None
456

zhuwenwen's avatar
zhuwenwen committed
457
458
        output = self.quant_method.apply(self, x, bias)
        output_bias = self.bias if self.skip_bias_add else None
459

zhuwenwen's avatar
zhuwenwen committed
460
461
462
        if not self.return_bias:
            return output
        return output, output_bias
463

464
465
466
467
468
469
    def extra_repr(self) -> str:
        s = f"in_features={self.input_size}"
        s += f", output_features={self.output_size}"
        s += f", bias={self.bias is not None}"
        return s

470

471
@CustomOp.register("column_parallel_linear")
472
class ColumnParallelLinear(LinearBase):
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
    """Linear layer with column parallelism.

    The linear layer is defined as Y = XA + b. A is parallelized along
    its second dimension as A = [A_1, ..., A_p].

    Args:
        input_size: first dimension of matrix A.
        output_size: second dimension of matrix A.
        bias: If true, add bias.
        gather_output: If true, call all-gather on output and make Y available
                       to all GPUs, otherwise, every GPU will have its output
                       which is Y_i = XA_i
        skip_bias_add: This was added to enable performance optimizations where
                       bias can be fused with other element-wise operations. we
                       skip adding bias but instead return it.
        params_dtype: Data type for the parameters.
489
        quant_config: Quantization configure.
James Fleming's avatar
James Fleming committed
490
491
        output_sizes: list of output sizes packed into one output, like for QKV
                       the list would be size 3.
492
        prefix: The name of the layer in the state dict, including all parents
493
                        (e.g. model.layers.0.qkv_proj)
494
495
        return_bias: If true, return bias together with outputs in forward pass.
        disable_tp: If true, weights matrix won't be sharded through tp rank.
496
497
    """

498
499
500
501
502
503
504
    def __init__(
        self,
        input_size: int,
        output_size: int,
        bias: bool = True,
        gather_output: bool = False,
        skip_bias_add: bool = False,
505
506
507
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
        output_sizes: list[int] | None = None,
508
        eps: float | None = 1e-6,
509
510
511
        prefix: str = "",
        *,
        return_bias: bool = True,
512
        disable_tp: bool = False,
513
    ):
514
        # Divide the weight matrix along the last dimension.
515
516
        self.tp_rank = get_tensor_model_parallel_rank() if not disable_tp else 0
        self.tp_size = get_tensor_model_parallel_world_size() if not disable_tp else 1
517
518
        self.input_size_per_partition = input_size
        self.output_size_per_partition = divide(output_size, self.tp_size)
519
520
521
522
        self.output_partition_sizes = [self.output_size_per_partition]
        # If QKV or MergedColumn, use output size of each partition.
        if hasattr(self, "output_sizes"):
            self.output_partition_sizes = [
523
                divide(output_size, self.tp_size) for output_size in self.output_sizes
524
525
            ]

526
527
528
529
530
531
532
533
534
535
        super().__init__(
            input_size,
            output_size,
            skip_bias_add,
            params_dtype,
            quant_config,
            prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
536

537
        self.eps = eps
538
539
        self.gather_output = gather_output

James Fleming's avatar
James Fleming committed
540
541
        if output_sizes is None:
            output_sizes = [output_size]
542

543
        assert self.quant_method is not None
544
545
        self.quant_method.create_weights(
            layer=self,
546
            input_size_per_partition=self.input_size_per_partition,
547
548
549
550
            output_partition_sizes=self.output_partition_sizes,
            input_size=self.input_size,
            output_size=self.output_size,
            params_dtype=self.params_dtype,
551
            weight_loader=(
552
553
554
555
556
                self.weight_loader_v2
                if self.quant_method.__class__.__name__ in WEIGHT_LOADER_V2_SUPPORTED
                else self.weight_loader
            ),
        )
557
558
        if bias:
            self.bias = Parameter(
559
560
561
562
563
564
565
566
567
                torch.empty(self.output_size_per_partition, dtype=params_dtype)
            )
            set_weight_attrs(
                self.bias,
                {
                    "output_dim": 0,
                    "weight_loader": self.weight_loader,
                },
            )
568
569
        else:
            self.register_parameter("bias", None)
570
        self.update_param_tp_status()
571
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
572

573
574
    def weight_loader(self, param: Parameter, loaded_weight: torch.Tensor):
        output_dim = getattr(param, "output_dim", None)
575

576
577
578
579
580
581
        is_sharded_weight = getattr(param, "is_sharded_weight", False)
        use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
        # bitsandbytes loads the weights of the specific portion
        # no need to narrow
        is_sharded_weight = is_sharded_weight or use_bitsandbytes_4bit

582
583
584
585
586
587
588
589
        # Special case for GGUF
        is_gguf_weight = getattr(param, "is_gguf_weight", False)
        is_gguf_weight_type = getattr(param, "is_gguf_weight_type", False)
        if is_gguf_weight_type:
            param.weight_type = loaded_weight.item()

        # Materialize GGUF UninitializedParameter
        if is_gguf_weight and isinstance(param, UninitializedParameter):
590
591
            final_shape = list(loaded_weight.shape)
            if output_dim is not None:
592
                assert final_shape[output_dim] % self.tp_size == 0
593
                final_shape[output_dim] = final_shape[output_dim] // self.tp_size
594
            param.materialize(final_shape, dtype=loaded_weight.dtype)
595

596
        param_data = param.data
597
        if output_dim is not None and not is_sharded_weight:
598
            if not envs.VLLM_USE_NN or len(param_data.shape)==1 or self.is_quantization:
599
600
601
                shard_size = param_data.shape[output_dim] 
            else:
                shard_size = param_data.shape[int(not(output_dim))]
602
            start_idx = self.tp_rank * shard_size
603
            loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
604

605
606
607
608
        # Special case for loading scales off disk, which often do not
        # have a shape (such as in the case of AutoFP8).
        if len(loaded_weight.shape) == 0:
            loaded_weight = loaded_weight.reshape(1)
609

610
        if envs.VLLM_USE_NN and not self.is_quantization:
611
612
            loaded_weight = loaded_weight.t()
            
613
614
615
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)

616
    def weight_loader_v2(self, param: BasevLLMParameter, loaded_weight: torch.Tensor):
617
618
619
620
621
        # Special case for loading scales off disk, which often do not
        # have a shape (such as in the case of AutoFP8).
        if len(loaded_weight.shape) == 0:
            assert loaded_weight.numel() == 1
            loaded_weight = loaded_weight.reshape(1)
622
        param.load_column_parallel_weight(loaded_weight=loaded_weight, is_quantization=self.is_quantization)
623

624
    def forward(
625
626
        self,
        input_,
627
    ) -> torch.Tensor | tuple[torch.Tensor, Parameter | None]:
zhuwenwen's avatar
zhuwenwen committed
628
629
630
631
632
633
634
635
636
        bias = self.bias if not self.skip_bias_add else None

        # Matrix multiply.
        assert self.quant_method is not None
        output_parallel = self.quant_method.apply(self, input_, bias)

        if self.gather_output and self.tp_size > 1:
            # All-gather across the partitions.
            output = tensor_model_parallel_all_gather(output_parallel)
637
        else:
zhuwenwen's avatar
zhuwenwen committed
638
639
640
641
642
            output = output_parallel
        output_bias = self.bias if self.skip_bias_add else None
        if not self.return_bias:
            return output
        return output, output_bias
643

644
645
646
647
    def extra_repr(self) -> str:
        s = f"in_features={self.input_size}"
        s += f", output_features={self.output_size_per_partition}"
        s += f", bias={self.bias is not None}"
648
        s += f", tp_size={self.tp_size}"
649
650
651
        s += f", gather_output={self.gather_output}"
        return s

652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670

class MergedColumnParallelLinear(ColumnParallelLinear):
    """Packed linear layers with column parallelism.

    Similar to ColumnParallelLinear, but the weight matrix is concatenated
    along the output dimension. When the weight matrix is loaded, the
    different partitions are sharded separately.

    Args:
        input_size: input dimension of the linear layer.
        output_sizes: list of output dimensions of the linear layer.
        bias: If true, add bias.
        gather_output: If true, call all-gather on output and make the output
                       available to all GPUs, otherwise, every GPU will have
                       its own output.
        skip_bias_add: This was added to enable performance optimizations where
                       bias can be fused with other element-wise operations. we
                       skip adding bias but instead return it.
        params_dtype: Data type for the parameters.
671
        quant_config: Quantization configure.
672
673
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.qkv_proj)
674
        return_bias: If true, return bias together with outputs in forward pass.
675
676
        disable_tp: If true, all weights matrix won't be sharded, this layer
                    will be treated as a "Replicated" MergedLinear.
677
678
    """

679
680
681
682
683
684
685
    def __init__(
        self,
        input_size: int,
        output_sizes: list[int],
        bias: bool = True,
        gather_output: bool = False,
        skip_bias_add: bool = False,
686
687
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
zhuwenwen's avatar
zhuwenwen committed
688
        eps: float | None = 1e-6,
689
690
691
        prefix: str = "",
        *,
        return_bias: bool = True,
692
        disable_tp: bool = False,
693
    ):
694
        self.eps = eps
695
        self.output_sizes = output_sizes
696
697
        self.tp_size = get_tensor_model_parallel_world_size() if not disable_tp else 1
        self.tp_rank = get_tensor_model_parallel_rank() if not disable_tp else 0
698

699
700
701
702
703
704
705
706
707
708
709
710
711
        assert all(output_size % self.tp_size == 0 for output_size in output_sizes)
        super().__init__(
            input_size=input_size,
            output_size=sum(output_sizes),
            bias=bias,
            gather_output=gather_output,
            skip_bias_add=skip_bias_add,
            params_dtype=params_dtype,
            quant_config=quant_config,
            prefix=prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
712
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
James Fleming's avatar
James Fleming committed
713

714
715
716
717
    def weight_loader(
        self,
        param: Parameter,
        loaded_weight: torch.Tensor,
718
        loaded_shard_id: int | None = None,
719
    ):
720
721
722
723
724
        # Special case for GGUF
        # initialize GGUF param after we know the quantize type
        is_gguf_weight = getattr(param, "is_gguf_weight", False)
        is_gguf_weight_type = getattr(param, "is_gguf_weight_type", False)
        if is_gguf_weight_type:
725
726
727
728
729
            if loaded_shard_id is not None:
                param.data[loaded_shard_id].copy_(loaded_weight)
                param.shard_weight_type[loaded_shard_id] = loaded_weight.item()
            else:
                param.shard_weight_type = {
730
                    i: loaded_weight.item() for i, _ in enumerate(self.output_sizes)
731
                }
732
733
            return

734
735
        if is_gguf_weight:
            output_dim = getattr(param, "output_dim", None)
736
737
            shard_size = loaded_weight.size(output_dim) // self.tp_size
            start_idx = self.tp_rank * shard_size
738

739
            if loaded_shard_id is not None:
740
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
741
742
743
744
                param.shard_id.append(loaded_shard_id)
                param.shard_id_map[loaded_shard_id] = len(param.data_container)
                param.data_container.append(loaded_weight)
                return
745

746
747
        param_data = param.data
        output_dim = getattr(param, "output_dim", None)
748
749
        # Special case for per-tensor scale to load scalar into fused array.
        needs_scalar_to_array = getattr(param, "needs_scalar_to_array", False)
750

751
        if loaded_shard_id is None:
752
753
            # Loaded weight is already fused on disk (mlp).
            # (e.g., Phi-3's gate_up_proj).
754
            if output_dim is None:
755
                if needs_scalar_to_array:
756
                    param_data, loaded_weight = adjust_scalar_to_fused_array(
757
758
                        param_data, loaded_weight, 0
                    )
759

760
761
762
763
                assert param_data.shape == loaded_weight.shape
                param_data.copy_(loaded_weight)
                return
            current_shard_offset = 0
764
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
765
            shard_offsets: list[tuple[int, int, int]] = []
766
767
768
769
770
            for i, output_size in enumerate(self.output_sizes):
                shard_offsets.append((i, current_shard_offset, output_size))
                current_shard_offset += output_size
            packed_dim = getattr(param, "packed_dim", None)
            for shard_id, shard_offset, shard_size in shard_offsets:
771
                # Special case for Quantization.
772
773
774
                # If quantized, we need to adjust the offset and size to account
                # for the packing.
                if packed_dim == output_dim:
775
776
                    shard_size = shard_size // param.packed_factor
                    shard_offset = shard_offset // param.packed_factor
777
                    # Special case for Marlin.
778
                    shard_size, shard_offset = adjust_marlin_shard(
779
780
                        param, shard_size, shard_offset
                    )
781

782
                shard_size, shard_offset = adjust_bitblas_shard(
783
784
                    param, shard_size, shard_offset
                )
785

786
                if use_bitsandbytes_4bit:
787
788
789
790
791
792
793
                    index = list(itertools.accumulate([0] + self.output_sizes))
                    orig_offsets = {
                        str(i): (index[i], size)
                        for i, size in enumerate(self.output_sizes)
                    }
                    orig_offsets["total"] = (self.output_size, 0)
                    shard_size, shard_offset = adjust_bitsandbytes_4bit_shard(
794
795
                        param, orig_offsets, str(shard_id)
                    )
796

797
                loaded_weight_shard = loaded_weight.narrow(
798
799
                    output_dim, shard_offset, shard_size
                )
800
801
802
803
804
                self.weight_loader(param, loaded_weight_shard, shard_id)
            return

        assert loaded_shard_id < len(self.output_sizes)
        if output_dim is not None:
805
            shard_offset = sum(self.output_sizes[:loaded_shard_id]) // self.tp_size
806
            shard_size = self.output_sizes[loaded_shard_id] // self.tp_size
807
            # Special case for quantization.
808
809
810
811
            # If quantized, we need to adjust the offset and size to account
            # for the packing.
            packed_dim = getattr(param, "packed_dim", None)
            if packed_dim == output_dim:
812
813
                shard_size = shard_size // param.packed_factor
                shard_offset = shard_offset // param.packed_factor
814
                # Special case for Marlin.
815
                shard_size, shard_offset = adjust_marlin_shard(
816
817
                    param, shard_size, shard_offset
                )
818
            shard_size, shard_offset = adjust_bitblas_shard(
819
820
                param, shard_size, shard_offset
            )
gaoqiong's avatar
gaoqiong committed
821

822
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
823
824
825
826
827
            is_sharded_weight = getattr(param, "is_sharded_weight", False)
            # bitsandbytes loads the weights of the specific portion
            # no need to narrow
            is_sharded_weight = is_sharded_weight or use_bitsandbytes_4bit

828
            if use_bitsandbytes_4bit:
829
                shard_size = loaded_weight.shape[output_dim]
830
                shard_offset = loaded_weight.shape[output_dim] * loaded_shard_id
831

832
            if not envs.VLLM_USE_NN or self.is_quantization or (envs.VLLM_USE_NN and param_data.dim()==1):
833
834
835
                param_data = param_data.narrow(output_dim, shard_offset, shard_size)
            else:
                param_data = param_data.narrow(int(not(output_dim)), shard_offset, shard_size)
836
            start_idx = self.tp_rank * shard_size
837
            if not is_sharded_weight:
838
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
839
840
841
        # Special case for per-tensor scales in fused case.
        elif needs_scalar_to_array:
            param_data, loaded_weight = adjust_scalar_to_fused_array(
842
843
                param_data, loaded_weight, loaded_shard_id
            )
844

845
        else:
CHU Tianxiang's avatar
CHU Tianxiang committed
846
847
848
849
850
            ignore_warning = getattr(param, "ignore_warning", False)
            if not ignore_warning:
                logger.warning(
                    "Loading a weight without `output_dim` attribute in "
                    "MergedColumnParallelLinear, assume the weight is "
851
852
                    "the same for all partitions."
                )
853

854
        if envs.VLLM_USE_NN and not self.is_quantization:
855
856
            loaded_weight = loaded_weight.t()
            
gaoqiong's avatar
gaoqiong committed
857
858
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)
859

860
861
862
    def _load_fused_module_from_checkpoint(
        self, param: BasevLLMParameter, loaded_weight: torch.Tensor
    ):
863
864
865
        """
        Handle special case for models where MLP layers are already
        fused on disk. In this case, we have no shard id. This function
866
        determines the shard id by splitting these layers and then calls
867
868
869
870
871
872
873
        the weight loader using the shard id.

        An example of a model with these fused layers:
        https://huggingface.co/microsoft/Phi-3-mini-4k-instruct
        """

        current_shard_offset = 0
874
        shard_offsets: list[tuple[int, int, int]] = []
875
876
877
878
879
880
881
882
        for i, output_size in enumerate(self.output_sizes):
            shard_offsets.append((i, current_shard_offset, output_size))
            current_shard_offset += output_size

        for shard_id, shard_offset, shard_size in shard_offsets:
            # Special case for Quantization.
            # If quantized, we need to adjust the offset and size to account
            # for the packing.
883
884
885
886
887
888
889
890
891
892
893
            if (
                isinstance(param, (PackedColumnParameter, PackedvLLMParameter))
                and param.packed_dim == param.output_dim
            ):
                shard_size, shard_offset = param.adjust_shard_indexes_for_packing(
                    shard_size=shard_size, shard_offset=shard_offset
                )

            loaded_weight_shard = loaded_weight.narrow(
                param.output_dim, shard_offset, shard_size
            )
894
895
            self.weight_loader_v2(param, loaded_weight_shard, shard_id)

896
897
898
899
    def weight_loader_v2(
        self,
        param: BasevLLMParameter,
        loaded_weight: torch.Tensor,
900
        loaded_shard_id: int | None = None,
901
    ):
902
        if loaded_shard_id is None:
903
            if isinstance(param, PerTensorScaleParameter):
904
                param.load_merged_column_weight(loaded_weight=loaded_weight, shard_id=0)
905
                return
906
            elif type(param) in (RowvLLMParameter, BasevLLMParameter):
907
                param.load_merged_column_weight(loaded_weight=loaded_weight)
908
                return
909
            # TODO: @dsikka - move to parameter.py
910
911
912
913
914
            self._load_fused_module_from_checkpoint(param, loaded_weight)
            return

        assert loaded_shard_id < len(self.output_sizes)

915
916
        if isinstance(param, BlockQuantScaleParameter):
            assert self.quant_method is not None
917
918
919
            # Assume the weight block size has been set by quant method
            assert hasattr(self, "weight_block_size")
            weight_block_size = self.weight_block_size
920
921
922
            assert weight_block_size is not None
            block_n, _ = weight_block_size[0], weight_block_size[1]
            shard_offset = (
923
924
925
926
927
928
929
                (sum(self.output_sizes[:loaded_shard_id]) + block_n - 1) // block_n
            ) // self.tp_size
            shard_size = (
                (self.output_sizes[loaded_shard_id] + block_n - 1)
                // block_n
                // self.tp_size
            )
930
        else:
931
            shard_offset = sum(self.output_sizes[:loaded_shard_id]) // self.tp_size
932
            shard_size = self.output_sizes[loaded_shard_id] // self.tp_size
933

934
935
936
937
938
939
        param.load_merged_column_weight(
            loaded_weight=loaded_weight,
            shard_id=loaded_shard_id,
            shard_offset=shard_offset,
            shard_size=shard_size,
            tp_rank=self.tp_rank,
940
            is_quantization=self.is_quantization
941
        )
942

943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964

class QKVParallelLinear(ColumnParallelLinear):
    """Linear layers for the attention's QKV transformation.

    Linear layers for the linear transformation of the query, key, and value
    vectors in the attention layer. The weight matrix is concatenated along
    the output dimension. The layer is parallelized along the head dimension.
    When the number of key/value heads is smaller than the number of query
    heads (e.g., multi-query/grouped-query attention), the key/value head may
    be replicated while the query heads are partitioned.

    Args:
        hidden_size: input hidden state size of the transformer.
        head_size: size of each attention head.
        total_num_heads: total number of attention query heads.
        total_num_kv_heads: total number of attention key/value heads. If
                            None, assume total_num_kv_heads = total_num_heads.
        bias: If true, add bias.
        skip_bias_add: This was added to enable performance optimizations where
                       bias can be fused with other element-wise operations. we
                       skip adding bias but instead return it.
        params_dtype: Data type for the parameters.
965
        quant_config: Quantization configure.
966
967
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.qkv_proj)
968
        return_bias: If true, return bias together with outputs in forward pass.
969
        disable_tp: If true, weights matrix won't be sharded through tp rank.
970
971
    """

972
973
974
975
976
    def __init__(
        self,
        hidden_size: int,
        head_size: int,
        total_num_heads: int,
977
        total_num_kv_heads: int | None = None,
978
979
        bias: bool = True,
        skip_bias_add: bool = False,
980
981
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
982
983
984
        prefix: str = "",
        *,
        return_bias: bool = True,
985
        disable_tp: bool = False,
986
    ):
987
988
989
990
991
992
993
        self.hidden_size = hidden_size
        self.head_size = head_size
        self.total_num_heads = total_num_heads
        if total_num_kv_heads is None:
            total_num_kv_heads = total_num_heads
        self.total_num_kv_heads = total_num_kv_heads
        # Divide the weight matrix along the last dimension.
994
        tp_size = get_tensor_model_parallel_world_size() if not disable_tp else 1
995
996
997
        self.num_heads = divide(self.total_num_heads, tp_size)
        if tp_size >= self.total_num_kv_heads:
            self.num_kv_heads = 1
998
            self.num_kv_head_replicas = divide(tp_size, self.total_num_kv_heads)
999
1000
1001
1002
        else:
            self.num_kv_heads = divide(self.total_num_kv_heads, tp_size)
            self.num_kv_head_replicas = 1
        input_size = self.hidden_size
1003
1004
1005
        output_size = (
            (self.num_heads + 2 * self.num_kv_heads) * tp_size * self.head_size
        )
1006
1007
1008
        self.output_sizes = [
            self.num_heads * self.head_size * tp_size,  # q_proj
            self.num_kv_heads * self.head_size * tp_size,  # k_proj
1009
            self.num_kv_heads * self.head_size * tp_size,  # v_proj
James Fleming's avatar
James Fleming committed
1010
        ]
gaoqiong's avatar
gaoqiong committed
1011

1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
        super().__init__(
            input_size=input_size,
            output_size=output_size,
            bias=bias,
            gather_output=False,
            skip_bias_add=skip_bias_add,
            params_dtype=params_dtype,
            quant_config=quant_config,
            prefix=prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
1024
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
1025

1026
1027
1028
1029
1030
    def _get_shard_offset_mapping(self, loaded_shard_id: str):
        shard_offset_mapping = {
            "q": 0,
            "k": self.num_heads * self.head_size,
            "v": (self.num_heads + self.num_kv_heads) * self.head_size,
1031
            "total": (self.num_heads + 2 * self.num_kv_heads) * self.head_size,
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
        }
        return shard_offset_mapping.get(loaded_shard_id)

    def _get_shard_size_mapping(self, loaded_shard_id: str):
        shard_size_mapping = {
            "q": self.num_heads * self.head_size,
            "k": self.num_kv_heads * self.head_size,
            "v": self.num_kv_heads * self.head_size,
        }
        return shard_size_mapping.get(loaded_shard_id)

1043
1044
1045
    def _load_fused_module_from_checkpoint(
        self, param: BasevLLMParameter, loaded_weight: torch.Tensor
    ):
1046
        """
1047
        Handle special case for models where QKV layers are already
1048
        fused on disk. In this case, we have no shard id. This function
1049
        determines the shard id by splitting these layers and then calls
1050
1051
1052
1053
1054
1055
1056
1057
        the weight loader using the shard id.

        An example of a model with these fused layers:
        https://huggingface.co/microsoft/Phi-3-mini-4k-instruct
        """
        shard_offsets = [
            # (shard_id, shard_offset, shard_size)
            ("q", 0, self.total_num_heads * self.head_size),
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
            (
                "k",
                self.total_num_heads * self.head_size,
                self.total_num_kv_heads * self.head_size,
            ),
            (
                "v",
                (self.total_num_heads + self.total_num_kv_heads) * self.head_size,
                self.total_num_kv_heads * self.head_size,
            ),
1068
1069
1070
1071
1072
1073
        ]

        for shard_id, shard_offset, shard_size in shard_offsets:
            # Special case for Quantization.
            # If quantized, we need to adjust the offset and size to account
            # for the packing.
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
            if (
                isinstance(param, (PackedColumnParameter, PackedvLLMParameter))
                and param.packed_dim == param.output_dim
            ):
                shard_size, shard_offset = param.adjust_shard_indexes_for_packing(
                    shard_size=shard_size, shard_offset=shard_offset
                )

            loaded_weight_shard = loaded_weight.narrow(
                param.output_dim, shard_offset, shard_size
            )
1085
1086
            self.weight_loader_v2(param, loaded_weight_shard, shard_id)

1087
1088
1089
1090
    def weight_loader_v2(
        self,
        param: BasevLLMParameter,
        loaded_weight: torch.Tensor,
1091
        loaded_shard_id: str | None = None,
1092
    ):
1093
        if loaded_shard_id is None:  # special case for certain models
1094
            if isinstance(param, PerTensorScaleParameter):
1095
1096
1097
                param.load_qkv_weight(
                    loaded_weight=loaded_weight, shard_id=0, tp_rank=self.tp_rank
                )
1098
                return
1099
            elif type(param) in (RowvLLMParameter, BasevLLMParameter):
1100
                param.load_qkv_weight(loaded_weight=loaded_weight, tp_rank=self.tp_rank)
1101
                return
1102
            # TODO: @dsikka - move to parameter.py
1103
1104
1105
1106
1107
1108
1109
1110
            self._load_fused_module_from_checkpoint(param, loaded_weight)
            return

        assert loaded_shard_id in ["q", "k", "v"]

        shard_offset = self._get_shard_offset_mapping(loaded_shard_id)
        shard_size = self._get_shard_size_mapping(loaded_shard_id)

1111
1112
1113
        # Note(simon): This is needed for Qwen3's fp8 quantization.
        if isinstance(param, BlockQuantScaleParameter):
            assert self.quant_method is not None
1114
1115
1116
1117
            # Assume the weight block size has been set by quant method
            assert hasattr(self, "weight_block_size")
            weight_block_size = self.weight_block_size
            assert weight_block_size is not None
1118
1119
1120
1121
            block_n, _ = weight_block_size[0], weight_block_size[1]
            shard_offset = (shard_offset + block_n - 1) // block_n
            shard_size = (shard_size + block_n - 1) // block_n

1122
1123
1124
1125
1126
1127
1128
        param.load_qkv_weight(
            loaded_weight=loaded_weight,
            num_heads=self.num_kv_head_replicas,
            shard_id=loaded_shard_id,
            shard_offset=shard_offset,
            shard_size=shard_size,
            tp_rank=self.tp_rank,
1129
            is_quantization=self.is_quantization, 
1130
        )
1131

1132
1133
1134
1135
    def weight_loader(
        self,
        param: Parameter,
        loaded_weight: torch.Tensor,
1136
        loaded_shard_id: str | None = None,
1137
    ):
1138
1139
1140
1141
        # Special case for GGUF
        # initialize GGUF param after we know the quantize type
        is_gguf_weight = getattr(param, "is_gguf_weight", False)
        is_gguf_weight_type = getattr(param, "is_gguf_weight_type", False)
1142
        if is_gguf_weight_type:
1143
            idx_map = {"q": 0, "k": 1, "v": 2}
1144
1145
1146
1147
            if loaded_shard_id is not None:
                param.data[idx_map[loaded_shard_id]].copy_(loaded_weight)
                param.shard_weight_type[loaded_shard_id] = loaded_weight.item()
            else:
1148
                param.shard_weight_type = {k: loaded_weight.item() for k in idx_map}
1149
1150
            return

1151
1152
        if is_gguf_weight:
            output_dim = getattr(param, "output_dim", None)
1153
1154
            shard_size = loaded_weight.size(output_dim) // self.tp_size
            start_idx = self.tp_rank * shard_size
1155

1156
            if loaded_shard_id is not None:
1157
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
1158
1159
1160
1161
                param.shard_id.append(loaded_shard_id)
                param.shard_id_map[loaded_shard_id] = len(param.data_container)
                param.data_container.append(loaded_weight)
                return
1162

1163
1164
        param_data = param.data
        output_dim = getattr(param, "output_dim", None)
1165

1166
1167
        # Special case for per-tensor scales in fused case.
        needs_scalar_to_array = getattr(param, "needs_scalar_to_array", False)
1168

1169
        if loaded_shard_id is None:
1170
1171
            # Loaded weight is already fused on disk (qkv).
            # (e.g., Phi-3's qkv_proj).
1172
            if output_dim is None:
1173
                if needs_scalar_to_array:
1174
                    param_data, loaded_weight = adjust_scalar_to_fused_array(
1175
1176
                        param_data, loaded_weight, 0
                    )
1177

1178
1179
1180
1181
1182
1183
                assert param_data.shape == loaded_weight.shape
                param_data.copy_(loaded_weight)
                return
            shard_offsets = [
                # (shard_id, shard_offset, shard_size)
                ("q", 0, self.total_num_heads * self.head_size),
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
                (
                    "k",
                    self.total_num_heads * self.head_size,
                    self.total_num_kv_heads * self.head_size,
                ),
                (
                    "v",
                    (self.total_num_heads + self.total_num_kv_heads) * self.head_size,
                    self.total_num_kv_heads * self.head_size,
                ),
1194
            ]
1195
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
1196

1197
1198
            packed_dim = getattr(param, "packed_dim", None)
            for shard_id, shard_offset, shard_size in shard_offsets:
1199
                # Special case for Quantized Weights.
1200
1201
1202
                # If quantized, we need to adjust the offset and size to account
                # for the packing.
                if packed_dim == output_dim:
1203
1204
                    shard_size = shard_size // param.packed_factor
                    shard_offset = shard_offset // param.packed_factor
1205

1206
                    # Special case for Marlin.
1207
                    shard_size, shard_offset = adjust_marlin_shard(
1208
1209
                        param, shard_size, shard_offset
                    )
1210

1211
1212
1213
                if use_bitsandbytes_4bit:
                    orig_qkv_offsets = {
                        "q": (0, self.total_num_heads * self.head_size),
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
                        "k": (
                            self.total_num_heads * self.head_size,
                            self.total_num_kv_heads * self.head_size,
                        ),
                        "v": (
                            (self.total_num_heads + self.total_num_kv_heads)
                            * self.head_size,
                            self.total_num_kv_heads * self.head_size,
                        ),
                        "total": (
                            (self.total_num_heads + 2 * self.total_num_kv_heads)
                            * self.head_size,
                            0,
                        ),
1228
1229
1230
                    }

                    shard_size, shard_offset = adjust_bitsandbytes_4bit_shard(
1231
1232
                        param, orig_qkv_offsets, shard_id
                    )
1233

1234
                loaded_weight_shard = loaded_weight.narrow(
1235
1236
                    output_dim, shard_offset, shard_size
                )
1237
1238
1239
1240
                self.weight_loader(param, loaded_weight_shard, shard_id)
            return

        assert loaded_shard_id in ["q", "k", "v"]
1241
1242

        # If output dim is defined, use the default loading process.
1243
1244
1245
1246
1247
1248
1249
1250
        if output_dim is not None:
            if loaded_shard_id == "q":
                shard_offset = 0
                shard_size = self.num_heads * self.head_size
            elif loaded_shard_id == "k":
                shard_offset = self.num_heads * self.head_size
                shard_size = self.num_kv_heads * self.head_size
            elif loaded_shard_id == "v":
1251
                shard_offset = (self.num_heads + self.num_kv_heads) * self.head_size
1252
                shard_size = self.num_kv_heads * self.head_size
1253
            # Special case for Quantized Weights.
1254
1255
1256
1257
            # If quantized, we need to adjust the offset and size to account
            # for the packing.
            packed_dim = getattr(param, "packed_dim", None)
            if packed_dim == output_dim:
1258
1259
                shard_size = shard_size // param.packed_factor
                shard_offset = shard_offset // param.packed_factor
1260

1261
                # Special case for Marlin.
1262
                shard_size, shard_offset = adjust_marlin_shard(
1263
1264
                    param, shard_size, shard_offset
                )
1265

1266
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
1267
1268
1269
1270
1271
            is_sharded_weight = getattr(param, "is_sharded_weight", False)
            # bitsandbytes loads the weights of the specific portion
            # no need to narrow
            is_sharded_weight = is_sharded_weight or use_bitsandbytes_4bit

1272
            if use_bitsandbytes_4bit:
1273
1274
                orig_qkv_offsets = {
                    "q": (0, self.num_heads * self.head_size),
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
                    "k": (
                        self.num_heads * self.head_size,
                        self.num_kv_heads * self.head_size,
                    ),
                    "v": (
                        (self.num_heads + self.num_kv_heads) * self.head_size,
                        self.num_kv_heads * self.head_size,
                    ),
                    "total": (
                        (self.num_heads + 2 * self.num_kv_heads) * self.head_size,
                        0,
                    ),
1287
                }
1288
                shard_size, shard_offset = adjust_bitsandbytes_4bit_shard(
1289
1290
                    param, orig_qkv_offsets, loaded_shard_id
                )
gaoqiong's avatar
gaoqiong committed
1291

1292
            if not envs.VLLM_USE_NN or len(param_data.shape)==1 or self.is_quantization:
1293
                param_data = param_data.narrow(output_dim, shard_offset, shard_size)
1294
1295
1296
            else:
                param_data = param_data.narrow(int(not(output_dim)), shard_offset,
                                               shard_size)
zhuwenwen's avatar
zhuwenwen committed
1297
            if loaded_shard_id == "q":
1298
                shard_rank = self.tp_rank
1299
            else:
1300
1301
                shard_rank = self.tp_rank // self.num_kv_head_replicas
            start_idx = shard_rank * shard_size
1302

1303
            if not is_sharded_weight:
1304
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
1305

1306
1307
1308
        # Special case for per-tensor scales in fused case.
        elif needs_scalar_to_array:
            param_data, loaded_weight = adjust_scalar_to_fused_array(
1309
1310
                param_data, loaded_weight, loaded_shard_id
            )
1311
        else:
CHU Tianxiang's avatar
CHU Tianxiang committed
1312
1313
1314
1315
1316
            ignore_warning = getattr(param, "ignore_warning", False)
            if not ignore_warning:
                logger.warning(
                    "Loading a weight without `output_dim` attribute in "
                    "QKVParallelLinear, assume the weight is the same "
1317
1318
                    "for all partitions."
                )
gaoqiong's avatar
gaoqiong committed
1319

1320
        if envs.VLLM_USE_NN and not self.is_quantization:
1321
1322
            loaded_weight = loaded_weight.t()
            
gaoqiong's avatar
gaoqiong committed
1323
1324
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)
1325
1326


1327
@CustomOp.register("row_parallel_linear")
1328
class RowParallelLinear(LinearBase):
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
    """Linear layer with row parallelism.

    The linear layer is defined as Y = XA + b. A is parallelized along
    its first dimension and X along its second dimension as:
               -   -
              | A_1 |
              | .   |
          A = | .   |        X = [X_1, ..., X_p]
              | .   |
              | A_p |
               -   -
    Arguments:
        input_size: first dimension of matrix A.
        output_size: second dimension of matrix A.
        bias: If true, add bias. Note that bias is not parallelized.
        input_is_parallel: If true, we assume that the input is already
                           split across the GPUs and we do not split
                           again.
        skip_bias_add: This was added to enable performance optimization where
                       bias can be fused with other element-wise operations.
                       We skip adding bias but instead return it.
        params_dtype: Data type for the parameters.
1351
1352
1353
        reduce_results: If true, call all-reduce on output and make Y available
                       to all GPUs, otherwise, every GPU will have its output
                       which is Y = X_iA_i
1354
        quant_config: Quantization configure.
1355
1356
1357
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.down_proj)
        return_bias: If true, return bias together with outputs in forward pass.
1358
        disable_tp: If true, weights matrix won't be sharded through tp rank.
1359
1360
    """

1361
1362
1363
1364
1365
1366
1367
    def __init__(
        self,
        input_size: int,
        output_size: int,
        bias: bool = True,
        input_is_parallel: bool = True,
        skip_bias_add: bool = False,
1368
        params_dtype: torch.dtype | None = None,
1369
        reduce_results: bool = True,
1370
        quant_config: QuantizationConfig | None = None,
1371
1372
1373
        prefix: str = "",
        *,
        return_bias: bool = True,
1374
        disable_tp: bool = False,
1375
    ):
1376
        # Divide the weight matrix along the first dimension.
1377
1378
        self.tp_rank = get_tensor_model_parallel_rank() if not disable_tp else 0
        self.tp_size = get_tensor_model_parallel_world_size() if not disable_tp else 1
1379
1380
1381
1382
        self.input_size_per_partition = divide(input_size, self.tp_size)
        self.output_size_per_partition = output_size
        self.output_partition_sizes = [output_size]

1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
        super().__init__(
            input_size,
            output_size,
            skip_bias_add,
            params_dtype,
            quant_config,
            prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
1393

1394
1395
1396
        self.input_is_parallel = input_is_parallel
        self.reduce_results = reduce_results

1397
        assert self.quant_method is not None
1398
1399
1400
        self.quant_method.create_weights(
            layer=self,
            input_size_per_partition=self.input_size_per_partition,
1401
            output_partition_sizes=self.output_partition_sizes,
1402
1403
1404
            input_size=self.input_size,
            output_size=self.output_size,
            params_dtype=self.params_dtype,
1405
            weight_loader=(
1406
1407
1408
1409
1410
                self.weight_loader_v2
                if self.quant_method.__class__.__name__ in WEIGHT_LOADER_V2_SUPPORTED
                else self.weight_loader
            ),
        )
1411
        if not reduce_results and (bias and not skip_bias_add):
1412
1413
1414
1415
            raise ValueError(
                "When not reduce the results, adding bias to the "
                "results can lead to incorrect results"
            )
1416
1417

        if bias:
1418
1419
1420
1421
1422
1423
1424
1425
            self.bias = Parameter(torch.empty(self.output_size, dtype=params_dtype))
            set_weight_attrs(
                self.bias,
                {
                    "output_dim": 0,
                    "weight_loader": self.weight_loader,
                },
            )
1426
1427
        else:
            self.register_parameter("bias", None)
1428

1429
        self.update_param_tp_status()
1430
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
1431
1432
1433

    def weight_loader(self, param: Parameter, loaded_weight: torch.Tensor):
        input_dim = getattr(param, "input_dim", None)
1434
        use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
1435
1436
1437
1438
        is_sharded_weight = getattr(param, "is_sharded_weight", False)
        # bitsandbytes loads the weights of the specific portion
        # no need to narrow
        is_sharded_weight = is_sharded_weight or use_bitsandbytes_4bit
1439
1440
1441
1442
1443
1444
1445
1446
1447

        # Special case for GGUF
        is_gguf_weight = getattr(param, "is_gguf_weight", False)
        is_gguf_weight_type = getattr(param, "is_gguf_weight_type", False)
        if is_gguf_weight_type:
            param.weight_type = loaded_weight.item()

        # Materialize GGUF UninitializedParameter
        if is_gguf_weight and isinstance(param, UninitializedParameter):
1448
1449
            weight_shape = list(loaded_weight.shape)
            if input_dim:
1450
                weight_shape[input_dim] = weight_shape[input_dim] // self.tp_size
1451
            param.materialize(tuple(weight_shape), dtype=loaded_weight.dtype)
1452

1453
        param_data = param.data
1454
        if input_dim is not None and not is_sharded_weight:
1455
            if not envs.VLLM_USE_NN or self.is_quantization:
1456
1457
1458
                shard_size = param_data.shape[input_dim]
            else:
                shard_size = param_data.shape[int(not(input_dim))]
1459
            start_idx = self.tp_rank * shard_size
1460
            loaded_weight = loaded_weight.narrow(input_dim, start_idx, shard_size)
1461

1462
1463
1464
        # Special case for loading scales off disk, which often do not
        # have a shape (such as in the case of AutoFP8).
        if len(loaded_weight.shape) == 0:
1465
1466
            loaded_weight = loaded_weight.reshape(1)

1467
        if envs.VLLM_USE_NN and not self.is_quantization:
1468
1469
            loaded_weight = loaded_weight.t()
            
1470
1471
1472
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)

1473
    def weight_loader_v2(self, param: BasevLLMParameter, loaded_weight: torch.Tensor):
1474
1475
1476
1477
1478
1479
        # Special case for loading scales off disk, which often do not
        # have a shape (such as in the case of AutoFP8).
        if len(loaded_weight.shape) == 0:
            assert loaded_weight.numel() == 1
            loaded_weight = loaded_weight.reshape(1)

1480
        param.load_row_parallel_weight(loaded_weight=loaded_weight, is_quantization=self.is_quantization)
1481

1482
    def forward(
1483
1484
        self,
        input_,
1485
    ) -> torch.Tensor | tuple[torch.Tensor, Parameter | None]:
1486
1487
1488
1489
        if self.input_is_parallel:
            input_parallel = input_
        else:
            splitted_input = split_tensor_along_last_dim(
1490
1491
                input_, num_partitions=self.tp_size
            )
1492
            input_parallel = splitted_input[self.tp_rank].contiguous()
1493
1494

        # Matrix multiply.
1495
        assert self.quant_method is not None
1496
1497
1498
        # Only fuse bias add into GEMM for rank 0 (this ensures that
        # bias will not get added more than once in TP>1 case)
        bias_ = None if (self.tp_rank > 0 or self.skip_bias_add) else self.bias
1499
        output_parallel = self.quant_method.apply(self, input_parallel, bias_)
1500

1501
        if self.reduce_results and self.tp_size > 1:
zhuwenwen's avatar
zhuwenwen committed
1502
            output = tensor_model_parallel_all_reduce(output_parallel)
1503
        else:
1504
1505
1506
            output = output_parallel

        output_bias = self.bias if self.skip_bias_add else None
1507

1508
1509
        if not self.return_bias:
            return output
1510
        return output, output_bias
1511
1512

    def extra_repr(self) -> str:
1513
        s = f"in_features={self.input_size_per_partition}"
1514
1515
1516
1517
1518
        s += f", output_features={self.output_size}"
        s += f", bias={self.bias is not None}"
        s += f", tp_size={self.tp_size}"
        s += f", reduce_results={self.reduce_results}"
        return s