linear.py 61.2 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
44

logger = init_logger(__name__)

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

71

72
73
74
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:
75
        return (shard_size // bitblas_tile_size, shard_offset // bitblas_tile_size)
76
77
78
79

    return shard_size, shard_offset


80
81
82
83
84
85
86
87
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


88
89
90
91
92
93
94
95
def adjust_block_scale_shard(weight_block_size, shard_size, shard_offset):
    assert weight_block_size is not None
    block_n = weight_block_size[0]
    shard_offset = (shard_offset + block_n - 1) // block_n
    shard_size = (shard_size + block_n - 1) // block_n
    return shard_size, shard_offset


96
97
98
def adjust_bitsandbytes_4bit_shard(
    param: Parameter, shard_offsets: dict[str, tuple[int, int]], loaded_shard_id: str
) -> tuple[int, int]:
99
100
    """Adjust the quantization offsets and sizes for BitsAndBytes sharding."""

101
102
    total, _ = shard_offsets["total"]
    orig_offset, orig_size = shard_offsets[loaded_shard_id]
103
104
105
106
107
108
109
110

    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


111
112
113
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
114
115
    is an array of length N. The loaded_weight corresponds to
    one of the shards on disk. Here, we slice the param based on
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
    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]

131
132
133
134
    if envs.VLLM_USE_NN:
        return param[shard_id], loaded_weight.t()
    else:
        return param[shard_id], loaded_weight
135
136


137
138
139
140
141
142
143
144
# 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:
    {
145
        'bnb_shard_offsets': array([0, 4, 8, 16]),
146
147
148
149
150
        'bnb_quant_state': {0: ..., 1: ..., 2: ...},
    }

    The function will return:
    {
151
        'bnb_shard_offsets': array([0, 4]),
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        '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]
166
        for i in range(1, len(shard_offsets) - 1)
167
168
169
170
171
172
    }
    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


173
class LinearMethodBase(QuantizeMethodBase):
174
175
176
    """Base class for different (maybe quantized) linear methods."""

    @abstractmethod
177
178
179
180
181
182
183
184
185
186
187
    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.
188
           The weights will be set as attributes of the layer.
189

190
191
192
        Args:
            layer: The layer that is using the LinearMethodBase factory.
            input_size_per_partition: Size of the weight input dim on rank X.
193
            output_partition_sizes: Sizes of the output dim of each logical
194
195
196
197
198
199
                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.
        """
200
201
202
        raise NotImplementedError

    @abstractmethod
203
204
205
206
    def apply(
        self,
        layer: torch.nn.Module,
        x: torch.Tensor,
207
        bias: torch.Tensor | None = None,
208
    ) -> torch.Tensor:
209
210
        """Apply the weights in layer to the input tensor.
        Expects create_weights to have been called before on the layer."""
211
212
213
214
        raise NotImplementedError


class UnquantizedLinearMethod(LinearMethodBase):
215
    """Linear method without quantization."""
216
217
    
    def __init__(self):
zhuwenwen's avatar
zhuwenwen committed
218
        self.use_llama_nn = os.environ.get('LLAMA_NN') == '1'
219
        self.use_gemm_pad = os.environ.get('GEMM_PAD') == '1'
gaoqiong's avatar
gaoqiong committed
220
        
221

222

223
224
225
226
227
228
229
230
231
232
    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,
    ):
233
234
235
236
        # 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.
237
        weight_loader = extra_weight_attrs.pop("weight_loader")
238
239
240
        if envs.VLLM_USE_NN:
            weight = ModelWeightParameter(
                data=torch.empty(
241
242
                    input_size_per_partition,
                    sum(output_partition_sizes),
243
244
245
246
247
248
249
250
251
                    dtype=params_dtype,
                ),
                input_dim=1,
                output_dim=0,
                weight_loader=weight_loader,
            )
        else:
            weight = ModelWeightParameter(
                data=torch.empty(
252
253
                    sum(output_partition_sizes),
                    input_size_per_partition,
254
255
256
257
258
259
                    dtype=params_dtype,
                ),
                input_dim=1,
                output_dim=0,
                weight_loader=weight_loader,
            )
260

261
262
        layer.register_parameter("weight", weight)
        set_weight_attrs(weight, extra_weight_attrs)
263

264
    def process_weights_after_loading(self, layer: torch.nn.Module) -> None:
265
        if current_platform.is_cpu():
266
            from vllm.model_executor.layers.utils import dispatch_cpu_unquantized_gemm
267

268
            dispatch_cpu_unquantized_gemm(layer, remove_weight=True)
269

270
271
272
273
    def apply(
        self,
        layer: torch.nn.Module,
        x: torch.Tensor,
274
        bias: torch.Tensor | None = None,
275
    ) -> torch.Tensor:
zhuwenwen's avatar
zhuwenwen committed
276
        if self.use_llama_nn:
zhuwenwen's avatar
zhuwenwen committed
277
278
            # 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
279
            if bias is not None:
zhuwenwen's avatar
zhuwenwen committed
280
                if len(x.shape) == 2: 
281
                    return torch.addmm(bias, x, layer.weight)
zhuwenwen's avatar
zhuwenwen committed
282
                else:
283
                    return torch.matmul(x, layer.weight) + bias
zhuwenwen's avatar
zhuwenwen committed
284
            else:
285
                return torch.matmul(x, layer.weight)
zhuwenwen's avatar
zhuwenwen committed
286
        else:
zhuwenwen's avatar
zhuwenwen committed
287
288
289
290
291
292
293
294
295
296
            # 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)
297
            else:
zhuwenwen's avatar
zhuwenwen committed
298
                return dispatch_unquantized_gemm()(layer, x, layer.weight, bias)
299

300

301
class LinearBase(CustomOp):
302
    """Base linear layer.
303
304
305
306
307
308

    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.
309
        quant_config: Quantization configure.
310
        prefix: Prefix for parameter names.
311
        return_bias: If true, return bias together with outputs in forward pass.
312
        disable_tp: If true, tensor parallelism will be disabled for this layer.
313
314
315
316
317
318
319
    """

    def __init__(
        self,
        input_size: int,
        output_size: int,
        skip_bias_add: bool = False,
320
321
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
322
        prefix: str = "",
323
324
        *,
        return_bias: bool = True,
325
        disable_tp: bool = False,
326
327
328
329
330
331
332
333
334
335
    ):
        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
336
337
        self.quant_config = quant_config
        self.prefix = prefix
338
        self.allow_fp8_block_shape_mismatch = False
339
        if quant_config is None:
340
            self.quant_method: QuantizeMethodBase | None = UnquantizedLinearMethod()
341
        else:
342
            self.quant_method = quant_config.get_quant_method(self, prefix=prefix)
343
        self.return_bias = return_bias
344
        self.disable_tp = disable_tp
345
346
        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
347

348
    def update_param_tp_status(self):
349
350
351
352
        for param in self.parameters():
            if isinstance(param, BasevLLMParameter):
                param.tp_rank = self.tp_rank
                param.tp_size = self.tp_size
353
354


355
# --8<-- [start:replicated_linear]
356
@CustomOp.register("replicated_linear")
357
358
359
360
361
362
363
364
365
366
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.
367
368
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.qkv_proj)
369
        return_bias: If true, return bias together with outputs in forward pass.
370
        disable_tp: Take no effect for replicated linear layers.
371
372
    """

373
374
    # --8<-- [end:replicated_linear]

375
376
377
378
379
380
    def __init__(
        self,
        input_size: int,
        output_size: int,
        bias: bool = True,
        skip_bias_add: bool = False,
381
382
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
383
384
385
        prefix: str = "",
        *,
        return_bias: bool = True,
386
        disable_tp: bool = False,
387
    ):
388
389
390
391
392
        # 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]
393

394
395
396
397
398
399
400
401
402
403
        super().__init__(
            input_size,
            output_size,
            skip_bias_add,
            params_dtype,
            quant_config,
            prefix=prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
404

405
406
        # All the linear layer supports quant method.
        assert self.quant_method is not None
407
408
409
410
411
412
413
414
415
        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,
        )
416

417
418
        if bias:
            self.bias = Parameter(
419
420
421
422
423
424
425
426
427
                torch.empty(self.output_size, dtype=self.params_dtype)
            )
            set_weight_attrs(
                self.bias,
                {
                    "output_dim": 0,
                    "weight_loader": self.weight_loader,
                },
            )
428
429
        else:
            self.register_parameter("bias", None)
430
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
431

432
433
434
    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).
435
436
437
438
439
440
441
442
443
444
445
        # 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)

446
447
448
        if len(loaded_weight.shape) == 0:
            loaded_weight = loaded_weight.reshape(1)

449
        if envs.VLLM_USE_NN and not self.is_quantization:
450
451
            loaded_weight = loaded_weight.t()
            
452
453
        assert param.size() == loaded_weight.size(), (
            f"Tried to load weights of size {loaded_weight.size()}"
454
455
            f"to a parameter of size {param.size()}"
        )
456
457
        param.data.copy_(loaded_weight)

458
    def forward(
459
        self,
zhuwenwen's avatar
zhuwenwen committed
460
        x: torch.Tensor,
461
    ) -> torch.Tensor | tuple[torch.Tensor, Parameter | None]:
zhuwenwen's avatar
zhuwenwen committed
462
463
        bias = self.bias if not self.skip_bias_add else None
        assert self.quant_method is not None
464

zhuwenwen's avatar
zhuwenwen committed
465
        output = self.quant_method.apply(self, x, bias)
466

zhuwenwen's avatar
zhuwenwen committed
467
468
        if not self.return_bias:
            return output
469
        output_bias = self.bias if self.skip_bias_add else None
zhuwenwen's avatar
zhuwenwen committed
470
        return output, output_bias
471

472
473
474
475
476
477
    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

478

479
# --8<-- [start:column_parallel_linear]
480
@CustomOp.register("column_parallel_linear")
481
class ColumnParallelLinear(LinearBase):
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
    """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.
498
        quant_config: Quantization configure.
499
        prefix: The name of the layer in the state dict, including all parents
500
                        (e.g. model.layers.0.qkv_proj)
501
502
        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.
503
504
    """

505
506
    # --8<-- [end:column_parallel_linear]

507
508
509
510
511
512
513
    def __init__(
        self,
        input_size: int,
        output_size: int,
        bias: bool = True,
        gather_output: bool = False,
        skip_bias_add: bool = False,
514
515
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
516
517
518
        prefix: str = "",
        *,
        return_bias: bool = True,
519
        disable_tp: bool = False,
520
    ):
521
        # Divide the weight matrix along the last dimension.
522
523
        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
524
525
        self.input_size_per_partition = input_size
        self.output_size_per_partition = divide(output_size, self.tp_size)
526
527
528
529
        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 = [
530
                divide(output_size, self.tp_size) for output_size in self.output_sizes
531
532
            ]

533
534
535
536
537
538
539
540
541
542
        super().__init__(
            input_size,
            output_size,
            skip_bias_add,
            params_dtype,
            quant_config,
            prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
543

544
        self._maybe_allow_fp8_block_shape_mismatch()
545
546
547
        self.gather_output = gather_output

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

577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
    def _maybe_allow_fp8_block_shape_mismatch(self) -> None:
        quant_config = getattr(self, "quant_config", None)
        weight_block = getattr(quant_config, "weight_block_size", None)
        if (
            weight_block is None
            or len(weight_block) < 1
            or len(self.output_partition_sizes) <= 1
        ):
            return

        try:
            block_n = int(weight_block[0])
        except (ValueError, TypeError):
            return

        if block_n <= 0:
            return

        if any(size % block_n != 0 for size in self.output_partition_sizes):
            self.allow_fp8_block_shape_mismatch = True
            logger.debug(
                "Allowing FP8 block shape mismatch for %s (block_n=%d, partitions=%s)",
                getattr(self, "prefix", "<unknown>"),
                block_n,
                self.output_partition_sizes,
            )

604
605
    def weight_loader(self, param: Parameter, loaded_weight: torch.Tensor):
        output_dim = getattr(param, "output_dim", None)
606

607
608
609
610
611
612
        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

613
614
615
616
617
618
619
620
        # 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):
621
622
            final_shape = list(loaded_weight.shape)
            if output_dim is not None:
623
                assert final_shape[output_dim] % self.tp_size == 0
624
                final_shape[output_dim] = final_shape[output_dim] // self.tp_size
625
            param.materialize(final_shape, dtype=loaded_weight.dtype)
626

627
        param_data = param.data
628
        if output_dim is not None and not is_sharded_weight:
629
            if not envs.VLLM_USE_NN or len(param_data.shape)==1 or self.is_quantization:
630
631
632
                shard_size = param_data.shape[output_dim] 
            else:
                shard_size = param_data.shape[int(not(output_dim))]
633
            start_idx = self.tp_rank * shard_size
634
            loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
635

636
637
638
639
        # 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)
640

641
        if envs.VLLM_USE_NN and not self.is_quantization:
642
            loaded_weight = loaded_weight.t()
643
644
645
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)

646
    def weight_loader_v2(self, param: BasevLLMParameter, loaded_weight: torch.Tensor):
647
648
649
650
651
        # 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)
652
        param.load_column_parallel_weight(loaded_weight=loaded_weight, is_quantization=self.is_quantization)
653

654
    def forward(
655
656
        self,
        input_,
657
658
        *,
        iqis: tuple[torch.Tensor, torch.Tensor] | None = None
659
    ) -> torch.Tensor | tuple[torch.Tensor, Parameter | None]:
zhuwenwen's avatar
zhuwenwen committed
660
661
662
663
        bias = self.bias if not self.skip_bias_add else None

        # Matrix multiply.
        assert self.quant_method is not None
664
665
666
667
        if iqis is not None:
            output_parallel = self.quant_method.apply(self, input_, bias, input_quant_args=iqis)
        else:
            output_parallel = self.quant_method.apply(self, input_, bias)
zhuwenwen's avatar
zhuwenwen committed
668
669
670
671

        if self.gather_output and self.tp_size > 1:
            # All-gather across the partitions.
            output = tensor_model_parallel_all_gather(output_parallel)
672
        else:
zhuwenwen's avatar
zhuwenwen committed
673
            output = output_parallel
674

zhuwenwen's avatar
zhuwenwen committed
675
676
        if not self.return_bias:
            return output
677
        output_bias = self.bias if self.skip_bias_add else None
zhuwenwen's avatar
zhuwenwen committed
678
        return output, output_bias
679

680
681
682
683
    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}"
684
        s += f", tp_size={self.tp_size}"
685
686
687
        s += f", gather_output={self.gather_output}"
        return s

688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706

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.
707
        quant_config: Quantization configure.
708
709
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.qkv_proj)
710
        return_bias: If true, return bias together with outputs in forward pass.
711
712
        disable_tp: If true, all weights matrix won't be sharded, this layer
                    will be treated as a "Replicated" MergedLinear.
713
714
    """

715
716
717
718
719
720
721
    def __init__(
        self,
        input_size: int,
        output_sizes: list[int],
        bias: bool = True,
        gather_output: bool = False,
        skip_bias_add: bool = False,
722
723
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
724
725
726
        prefix: str = "",
        *,
        return_bias: bool = True,
727
        disable_tp: bool = False,
728
    ):
729
        self.output_sizes = output_sizes
730
731
        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
732

733
734
735
736
737
738
739
740
741
742
743
744
745
        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,
        )
746
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
James Fleming's avatar
James Fleming committed
747

748
749
750
751
    def weight_loader(
        self,
        param: Parameter,
        loaded_weight: torch.Tensor,
752
        loaded_shard_id: int | None = None,
753
    ):
754
755
756
757
758
        # 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:
759
760
761
762
763
            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 = {
764
                    i: loaded_weight.item() for i, _ in enumerate(self.output_sizes)
765
                }
766
767
            return

768
769
        if is_gguf_weight:
            output_dim = getattr(param, "output_dim", None)
770
771
            shard_size = loaded_weight.size(output_dim) // self.tp_size
            start_idx = self.tp_rank * shard_size
772

773
            if loaded_shard_id is not None:
774
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
775
776
777
778
                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
779

780
781
        param_data = param.data
        output_dim = getattr(param, "output_dim", None)
782
783
        # Special case for per-tensor scale to load scalar into fused array.
        needs_scalar_to_array = getattr(param, "needs_scalar_to_array", False)
784

785
        if loaded_shard_id is None:
786
787
            # Loaded weight is already fused on disk (mlp).
            # (e.g., Phi-3's gate_up_proj).
788
            if output_dim is None:
789
                if needs_scalar_to_array:
790
                    param_data, loaded_weight = adjust_scalar_to_fused_array(
791
792
                        param_data, loaded_weight, 0
                    )
793

794
795
796
797
                assert param_data.shape == loaded_weight.shape
                param_data.copy_(loaded_weight)
                return
            current_shard_offset = 0
798
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
799
            shard_offsets: list[tuple[int, int, int]] = []
800
801
802
803
804
            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:
805
                # Special case for Quantization.
806
807
808
                # If quantized, we need to adjust the offset and size to account
                # for the packing.
                if packed_dim == output_dim:
809
810
                    shard_size = shard_size // param.packed_factor
                    shard_offset = shard_offset // param.packed_factor
811
                    # Special case for Marlin.
812
                    shard_size, shard_offset = adjust_marlin_shard(
813
814
                        param, shard_size, shard_offset
                    )
815

816
                shard_size, shard_offset = adjust_bitblas_shard(
817
818
                    param, shard_size, shard_offset
                )
819

820
                if use_bitsandbytes_4bit:
821
822
823
824
825
826
827
                    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(
828
829
                        param, orig_offsets, str(shard_id)
                    )
830

831
                loaded_weight_shard = loaded_weight.narrow(
832
833
                    output_dim, shard_offset, shard_size
                )
834
835
836
837
838
                self.weight_loader(param, loaded_weight_shard, shard_id)
            return

        assert loaded_shard_id < len(self.output_sizes)
        if output_dim is not None:
839
840
841
842
843
844
845
846
847
848
849
850
            shard_offset = sum(self.output_sizes[:loaded_shard_id])
            shard_size = self.output_sizes[loaded_shard_id]

            if isinstance(param, BlockQuantScaleParameter):
                weight_block_size = getattr(self, "weight_block_size", None)
                shard_size, shard_offset = adjust_block_scale_shard(
                    weight_block_size, shard_size, shard_offset
                )

            shard_offset //= self.tp_size
            shard_size //= self.tp_size

851
            # Special case for quantization.
852
853
854
855
            # 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:
856
857
                shard_size = shard_size // param.packed_factor
                shard_offset = shard_offset // param.packed_factor
858
                # Special case for Marlin.
859
                shard_size, shard_offset = adjust_marlin_shard(
860
861
                    param, shard_size, shard_offset
                )
862
            shard_size, shard_offset = adjust_bitblas_shard(
863
864
                param, shard_size, shard_offset
            )
gaoqiong's avatar
gaoqiong committed
865

866
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
867
868
869
870
871
            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

872
            if use_bitsandbytes_4bit:
873
                shard_size = loaded_weight.shape[output_dim]
874
                shard_offset = loaded_weight.shape[output_dim] * loaded_shard_id
875

876
            if not envs.VLLM_USE_NN or self.is_quantization or (envs.VLLM_USE_NN and param_data.dim()==1):
877
878
879
                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)
880
            start_idx = self.tp_rank * shard_size
881
            if not is_sharded_weight:
882
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
883
884
885
        # Special case for per-tensor scales in fused case.
        elif needs_scalar_to_array:
            param_data, loaded_weight = adjust_scalar_to_fused_array(
886
887
                param_data, loaded_weight, loaded_shard_id
            )
888

889
        else:
CHU Tianxiang's avatar
CHU Tianxiang committed
890
891
892
893
894
            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 "
895
896
                    "the same for all partitions."
                )
897

898
        if envs.VLLM_USE_NN and not self.is_quantization:
899
900
            loaded_weight = loaded_weight.t()
            
gaoqiong's avatar
gaoqiong committed
901
902
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)
903

904
905
906
    def _load_fused_module_from_checkpoint(
        self, param: BasevLLMParameter, loaded_weight: torch.Tensor
    ):
907
908
909
        """
        Handle special case for models where MLP layers are already
        fused on disk. In this case, we have no shard id. This function
910
        determines the shard id by splitting these layers and then calls
911
912
913
914
915
916
917
        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
918
        shard_offsets: list[tuple[int, int, int]] = []
919
920
921
922
923
924
925
926
        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.
927
928
929
930
931
932
933
934
935
936
937
            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
            )
938
939
            self.weight_loader_v2(param, loaded_weight_shard, shard_id)

940
941
942
943
    def weight_loader_v2(
        self,
        param: BasevLLMParameter,
        loaded_weight: torch.Tensor,
944
        loaded_shard_id: int | None = None,
945
    ):
946
        if loaded_shard_id is None:
947
            if isinstance(param, PerTensorScaleParameter):
948
                param.load_merged_column_weight(loaded_weight=loaded_weight, shard_id=0)
949
                return
950
            elif type(param) in (RowvLLMParameter, BasevLLMParameter):
951
                param.load_merged_column_weight(loaded_weight=loaded_weight)
952
                return
953
            # TODO: @dsikka - move to parameter.py
954
955
956
957
958
            self._load_fused_module_from_checkpoint(param, loaded_weight)
            return

        assert loaded_shard_id < len(self.output_sizes)

959
960
961
        shard_offset = sum(self.output_sizes[:loaded_shard_id])
        shard_size = self.output_sizes[loaded_shard_id]

962
        if isinstance(param, BlockQuantScaleParameter):
963
964
965
            weight_block_size = getattr(self, "weight_block_size", None)
            shard_size, shard_offset = adjust_block_scale_shard(
                weight_block_size, shard_size, shard_offset
966
            )
967
968
969

        shard_offset //= self.tp_size
        shard_size //= self.tp_size
970

971
972
973
974
975
976
        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,
977
            is_quantization=self.is_quantization
978
        )
979

980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001

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.
1002
        quant_config: Quantization configure.
1003
1004
        prefix: The name of the layer in the state dict, including all parents
                        (e.g. model.layers.0.qkv_proj)
1005
        return_bias: If true, return bias together with outputs in forward pass.
1006
        disable_tp: If true, weights matrix won't be sharded through tp rank.
1007
1008
    """

1009
1010
1011
1012
1013
    def __init__(
        self,
        hidden_size: int,
        head_size: int,
        total_num_heads: int,
1014
        total_num_kv_heads: int | None = None,
1015
1016
        bias: bool = True,
        skip_bias_add: bool = False,
1017
1018
        params_dtype: torch.dtype | None = None,
        quant_config: QuantizationConfig | None = None,
1019
1020
1021
        prefix: str = "",
        *,
        return_bias: bool = True,
1022
        disable_tp: bool = False,
1023
        v_head_size: int | None = None,
1024
    ):
1025
1026
        self.hidden_size = hidden_size
        self.head_size = head_size
1027
        self.v_head_size = v_head_size if v_head_size is not None else head_size
1028
1029
1030
1031
1032
        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.
1033
        tp_size = get_tensor_model_parallel_world_size() if not disable_tp else 1
1034
1035
1036
        self.num_heads = divide(self.total_num_heads, tp_size)
        if tp_size >= self.total_num_kv_heads:
            self.num_kv_heads = 1
1037
            self.num_kv_head_replicas = divide(tp_size, self.total_num_kv_heads)
1038
1039
1040
1041
        else:
            self.num_kv_heads = divide(self.total_num_kv_heads, tp_size)
            self.num_kv_head_replicas = 1
        input_size = self.hidden_size
1042
        output_size = (
1043
1044
1045
1046
            self.num_heads * self.head_size
            + self.num_kv_heads * self.head_size
            + self.num_kv_heads * self.v_head_size
        ) * tp_size
1047
1048
1049
        self.output_sizes = [
            self.num_heads * self.head_size * tp_size,  # q_proj
            self.num_kv_heads * self.head_size * tp_size,  # k_proj
1050
            self.num_kv_heads * self.v_head_size * tp_size,  # v_proj
James Fleming's avatar
James Fleming committed
1051
        ]
gaoqiong's avatar
gaoqiong committed
1052

1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
        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,
        )
1065
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
1066

1067
1068
1069
1070
1071
    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,
1072
1073
            "total": (self.num_heads + self.num_kv_heads) * self.head_size
            + self.num_kv_heads * self.v_head_size,
1074
1075
1076
1077
1078
1079
1080
        }
        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,
1081
            "v": self.num_kv_heads * self.v_head_size,
1082
1083
1084
        }
        return shard_size_mapping.get(loaded_shard_id)

1085
1086
1087
    def _load_fused_module_from_checkpoint(
        self, param: BasevLLMParameter, loaded_weight: torch.Tensor
    ):
1088
        """
1089
        Handle special case for models where QKV layers are already
1090
        fused on disk. In this case, we have no shard id. This function
1091
        determines the shard id by splitting these layers and then calls
1092
1093
1094
1095
1096
1097
1098
1099
        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),
1100
1101
1102
1103
1104
1105
1106
1107
            (
                "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,
1108
                self.total_num_kv_heads * self.v_head_size,
1109
            ),
1110
1111
1112
1113
1114
1115
        ]

        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.
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
            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
            )
1127
1128
            self.weight_loader_v2(param, loaded_weight_shard, shard_id)

1129
1130
1131
1132
    def weight_loader_v2(
        self,
        param: BasevLLMParameter,
        loaded_weight: torch.Tensor,
1133
        loaded_shard_id: str | None = None,
1134
    ):
1135
        if loaded_shard_id is None:  # special case for certain models
1136
            if isinstance(param, PerTensorScaleParameter):
1137
1138
1139
                param.load_qkv_weight(
                    loaded_weight=loaded_weight, shard_id=0, tp_rank=self.tp_rank
                )
1140
                return
1141
            elif type(param) in (RowvLLMParameter, BasevLLMParameter):
1142
                param.load_qkv_weight(loaded_weight=loaded_weight, tp_rank=self.tp_rank)
1143
                return
1144
            # TODO: @dsikka - move to parameter.py
1145
1146
1147
1148
1149
1150
1151
1152
            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)

1153
        if isinstance(param, BlockQuantScaleParameter):
1154
1155
1156
1157
            weight_block_size = getattr(self, "weight_block_size", None)
            shard_size, shard_offset = adjust_block_scale_shard(
                weight_block_size, shard_size, shard_offset
            )
1158

1159
1160
1161
1162
1163
1164
1165
        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,
1166
            is_quantization=self.is_quantization, 
1167
        )
1168

1169
1170
1171
1172
    def weight_loader(
        self,
        param: Parameter,
        loaded_weight: torch.Tensor,
1173
        loaded_shard_id: str | None = None,
1174
    ):
1175
1176
1177
1178
        # 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)
1179
        if is_gguf_weight_type:
1180
            idx_map = {"q": 0, "k": 1, "v": 2}
1181
1182
1183
1184
            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:
1185
                param.shard_weight_type = {k: loaded_weight.item() for k in idx_map}
1186
1187
            return

1188
1189
        if is_gguf_weight:
            output_dim = getattr(param, "output_dim", None)
1190
1191
            shard_size = loaded_weight.size(output_dim) // self.tp_size
            start_idx = self.tp_rank * shard_size
1192

1193
            if loaded_shard_id is not None:
1194
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
1195
1196
1197
1198
                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
1199

1200
1201
        param_data = param.data
        output_dim = getattr(param, "output_dim", None)
1202

1203
1204
        # Special case for per-tensor scales in fused case.
        needs_scalar_to_array = getattr(param, "needs_scalar_to_array", False)
1205

1206
        if loaded_shard_id is None:
1207
1208
            # Loaded weight is already fused on disk (qkv).
            # (e.g., Phi-3's qkv_proj).
1209
            if output_dim is None:
1210
                if needs_scalar_to_array:
1211
                    param_data, loaded_weight = adjust_scalar_to_fused_array(
1212
1213
                        param_data, loaded_weight, 0
                    )
1214

1215
1216
1217
1218
1219
1220
                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),
1221
1222
1223
1224
1225
1226
1227
1228
                (
                    "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,
1229
                    self.total_num_kv_heads * self.v_head_size,
1230
                ),
1231
            ]
1232
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
1233

1234
1235
            packed_dim = getattr(param, "packed_dim", None)
            for shard_id, shard_offset, shard_size in shard_offsets:
1236
                # Special case for Quantized Weights.
1237
1238
1239
                # If quantized, we need to adjust the offset and size to account
                # for the packing.
                if packed_dim == output_dim:
1240
1241
                    shard_size = shard_size // param.packed_factor
                    shard_offset = shard_offset // param.packed_factor
1242

1243
                    # Special case for Marlin.
1244
                    shard_size, shard_offset = adjust_marlin_shard(
1245
1246
                        param, shard_size, shard_offset
                    )
1247

1248
1249
1250
                if use_bitsandbytes_4bit:
                    orig_qkv_offsets = {
                        "q": (0, self.total_num_heads * self.head_size),
1251
1252
1253
1254
1255
1256
1257
                        "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,
1258
                            self.total_num_kv_heads * self.v_head_size,
1259
1260
                        ),
                        "total": (
1261
1262
1263
                            (self.total_num_heads + self.total_num_kv_heads)
                            * self.head_size
                            + self.total_num_kv_heads * self.v_head_size,
1264
1265
                            0,
                        ),
1266
1267
1268
                    }

                    shard_size, shard_offset = adjust_bitsandbytes_4bit_shard(
1269
1270
                        param, orig_qkv_offsets, shard_id
                    )
1271

1272
                loaded_weight_shard = loaded_weight.narrow(
1273
1274
                    output_dim, shard_offset, shard_size
                )
1275
1276
1277
1278
                self.weight_loader(param, loaded_weight_shard, shard_id)
            return

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

        # If output dim is defined, use the default loading process.
1281
1282
1283
1284
1285
1286
1287
1288
        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":
1289
                shard_offset = (self.num_heads + self.num_kv_heads) * self.head_size
1290
                shard_size = self.num_kv_heads * self.v_head_size
1291
1292
1293
1294
1295
1296
1297

            if isinstance(param, BlockQuantScaleParameter):
                weight_block_size = getattr(self, "weight_block_size", None)
                shard_size, shard_offset = adjust_block_scale_shard(
                    weight_block_size, shard_size, shard_offset
                )

1298
            # Special case for Quantized Weights.
1299
1300
1301
1302
            # 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:
1303
1304
                shard_size = shard_size // param.packed_factor
                shard_offset = shard_offset // param.packed_factor
1305

1306
                # Special case for Marlin.
1307
                shard_size, shard_offset = adjust_marlin_shard(
1308
1309
                    param, shard_size, shard_offset
                )
1310

1311
            use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
1312
1313
1314
1315
1316
            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

1317
            if use_bitsandbytes_4bit:
1318
1319
                orig_qkv_offsets = {
                    "q": (0, self.num_heads * self.head_size),
1320
1321
1322
1323
1324
1325
                    "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,
1326
                        self.num_kv_heads * self.v_head_size,
1327
1328
                    ),
                    "total": (
1329
1330
                        (self.num_heads + self.num_kv_heads) * self.head_size
                        + self.num_kv_heads * self.v_head_size,
1331
1332
                        0,
                    ),
1333
                }
1334
                shard_size, shard_offset = adjust_bitsandbytes_4bit_shard(
1335
1336
                    param, orig_qkv_offsets, loaded_shard_id
                )
gaoqiong's avatar
gaoqiong committed
1337

1338
            if not envs.VLLM_USE_NN or len(param_data.shape)==1 or self.is_quantization:
1339
                param_data = param_data.narrow(output_dim, shard_offset, shard_size)
1340
1341
1342
            else:
                param_data = param_data.narrow(int(not(output_dim)), shard_offset,
                                               shard_size)
zhuwenwen's avatar
zhuwenwen committed
1343
            if loaded_shard_id == "q":
1344
                shard_rank = self.tp_rank
1345
            else:
1346
1347
                shard_rank = self.tp_rank // self.num_kv_head_replicas
            start_idx = shard_rank * shard_size
1348

1349
            if not is_sharded_weight:
1350
                loaded_weight = loaded_weight.narrow(output_dim, start_idx, shard_size)
1351

1352
1353
1354
        # Special case for per-tensor scales in fused case.
        elif needs_scalar_to_array:
            param_data, loaded_weight = adjust_scalar_to_fused_array(
1355
1356
                param_data, loaded_weight, loaded_shard_id
            )
1357
        else:
CHU Tianxiang's avatar
CHU Tianxiang committed
1358
1359
1360
1361
1362
            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 "
1363
1364
                    "for all partitions."
                )
gaoqiong's avatar
gaoqiong committed
1365

1366
        if envs.VLLM_USE_NN and not self.is_quantization:
1367
            loaded_weight = loaded_weight.t()
gaoqiong's avatar
gaoqiong committed
1368
1369
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)
1370
1371


1372
# --8<-- [start:row_parallel_linear]
1373
@CustomOp.register("row_parallel_linear")
1374
class RowParallelLinear(LinearBase):
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
    """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.
1397
1398
1399
        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
1400
        quant_config: Quantization configure.
1401
1402
1403
        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.
1404
        disable_tp: If true, weights matrix won't be sharded through tp rank.
1405
1406
    """

1407
1408
    # --8<-- [end:row_parallel_linear]

1409
1410
1411
1412
1413
1414
1415
    def __init__(
        self,
        input_size: int,
        output_size: int,
        bias: bool = True,
        input_is_parallel: bool = True,
        skip_bias_add: bool = False,
1416
        params_dtype: torch.dtype | None = None,
1417
        reduce_results: bool = True,
1418
        quant_config: QuantizationConfig | None = None,
1419
1420
1421
        prefix: str = "",
        *,
        return_bias: bool = True,
1422
        disable_tp: bool = False,
1423
    ):
1424
        # Divide the weight matrix along the first dimension.
1425
1426
        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
1427
1428
1429
1430
        self.input_size_per_partition = divide(input_size, self.tp_size)
        self.output_size_per_partition = output_size
        self.output_partition_sizes = [output_size]

1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
        super().__init__(
            input_size,
            output_size,
            skip_bias_add,
            params_dtype,
            quant_config,
            prefix,
            return_bias=return_bias,
            disable_tp=disable_tp,
        )
1441

1442
1443
1444
        self.input_is_parallel = input_is_parallel
        self.reduce_results = reduce_results

1445
        assert self.quant_method is not None
1446
1447
1448
        self.quant_method.create_weights(
            layer=self,
            input_size_per_partition=self.input_size_per_partition,
1449
            output_partition_sizes=self.output_partition_sizes,
1450
1451
1452
            input_size=self.input_size,
            output_size=self.output_size,
            params_dtype=self.params_dtype,
1453
            weight_loader=(
1454
1455
1456
1457
1458
                self.weight_loader_v2
                if self.quant_method.__class__.__name__ in WEIGHT_LOADER_V2_SUPPORTED
                else self.weight_loader
            ),
        )
1459
        if not reduce_results and (bias and not skip_bias_add):
1460
1461
1462
1463
            raise ValueError(
                "When not reduce the results, adding bias to the "
                "results can lead to incorrect results"
            )
1464
1465

        if bias:
1466
1467
1468
1469
1470
1471
1472
1473
            self.bias = Parameter(torch.empty(self.output_size, dtype=params_dtype))
            set_weight_attrs(
                self.bias,
                {
                    "output_dim": 0,
                    "weight_loader": self.weight_loader,
                },
            )
1474
1475
        else:
            self.register_parameter("bias", None)
1476
        self.update_param_tp_status()
1477
        self.is_quantization = not isinstance(self.quant_method, UnquantizedLinearMethod)
1478
1479
1480

    def weight_loader(self, param: Parameter, loaded_weight: torch.Tensor):
        input_dim = getattr(param, "input_dim", None)
1481
        use_bitsandbytes_4bit = getattr(param, "use_bitsandbytes_4bit", False)
1482
1483
1484
1485
        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
1486
1487
1488
1489
1490
1491
1492
1493
1494

        # 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):
1495
1496
            weight_shape = list(loaded_weight.shape)
            if input_dim:
1497
                weight_shape[input_dim] = weight_shape[input_dim] // self.tp_size
1498
            param.materialize(tuple(weight_shape), dtype=loaded_weight.dtype)
1499

1500
        param_data = param.data
1501
        if input_dim is not None and not is_sharded_weight:
1502
            if not envs.VLLM_USE_NN or self.is_quantization:
1503
1504
1505
                shard_size = param_data.shape[input_dim]
            else:
                shard_size = param_data.shape[int(not(input_dim))]
1506
            start_idx = self.tp_rank * shard_size
1507
            loaded_weight = loaded_weight.narrow(input_dim, start_idx, shard_size)
1508

1509
1510
1511
        # 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:
1512
1513
            loaded_weight = loaded_weight.reshape(1)

1514
        if envs.VLLM_USE_NN and not self.is_quantization:
1515
            loaded_weight = loaded_weight.t()
1516
1517
1518
        assert param_data.shape == loaded_weight.shape
        param_data.copy_(loaded_weight)

1519
    def weight_loader_v2(self, param: BasevLLMParameter, loaded_weight: torch.Tensor):
1520
1521
1522
1523
1524
1525
        # 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)

1526
        param.load_row_parallel_weight(loaded_weight=loaded_weight, is_quantization=self.is_quantization)
1527

1528
    def forward(
1529
1530
        self,
        input_,
1531
1532
        *,
        iqis: tuple[torch.Tensor, torch.Tensor] | None = None
1533
    ) -> torch.Tensor | tuple[torch.Tensor, Parameter | None]:
1534
1535
1536
1537
        if self.input_is_parallel:
            input_parallel = input_
        else:
            splitted_input = split_tensor_along_last_dim(
1538
1539
                input_, num_partitions=self.tp_size
            )
1540
            input_parallel = splitted_input[self.tp_rank].contiguous()
1541
1542

        # Matrix multiply.
1543
        assert self.quant_method is not None
1544
1545
1546
        # 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
1547
1548
1549
1550
        if iqis is not None:
            output_parallel = self.quant_method.apply(self, input_parallel, bias_, input_quant_args=iqis)
        else:
            output_parallel = self.quant_method.apply(self, input_parallel, bias_)
1551

1552
        if self.reduce_results and self.tp_size > 1:
zhuwenwen's avatar
zhuwenwen committed
1553
            output = tensor_model_parallel_all_reduce(output_parallel)
1554
        else:
1555
1556
            output = output_parallel

1557
1558
        if not self.return_bias:
            return output
1559
        output_bias = self.bias if self.skip_bias_add else None
1560
        return output, output_bias
1561
1562

    def extra_repr(self) -> str:
1563
        s = f"in_features={self.input_size_per_partition}"
1564
1565
1566
1567
1568
        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