Skip to content

vllm.model_executor.layers.quantization.compressed_tensors.compressed_tensors

QUANTIZATION_SCHEME_MAP_TYPE module-attribute

QUANTIZATION_SCHEME_MAP_TYPE = dict[
    str, Optional[dict[str, QuantizationArgs]]
]

SPARSITY_CONFIG_NAME module-attribute

SPARSITY_CONFIG_NAME: Literal["sparsity_config"] = (
    "sparsity_config"
)

__all__ module-attribute

__all__ = ['CompressedTensorsLinearMethod']

logger module-attribute

logger = init_logger(__name__)

CompressedTensorsConfig

Bases: QuantizationConfig

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
class CompressedTensorsConfig(QuantizationConfig):
    def __init__(
        self,
        target_scheme_map: dict[str, Any],
        ignore: list[str],
        quant_format: str,
        sparsity_scheme_map: dict[str, SparsityCompressionConfig],
        sparsity_ignore_list: list[str],
        kv_cache_scheme: Optional[dict[str, Any]] = None,
        config: Optional[dict[str, Any]] = None,
        transform_config: Optional[dict[str, Any]] = None,
    ):
        super().__init__()
        self.ignore = ignore
        self.quant_format = quant_format
        # Map from [target -> scheme]
        self.target_scheme_map = target_scheme_map
        self.kv_cache_scheme = kv_cache_scheme
        self.sparsity_scheme_map = sparsity_scheme_map
        self.sparsity_ignore_list = sparsity_ignore_list
        self.config = config

        if transform_config:
            self.transform_config = TransformConfig.model_validate(transform_config)
        else:
            self.transform_config = None

    def get_linear_method(self) -> "CompressedTensorsLinearMethod":
        return CompressedTensorsLinearMethod(self)

    def get_supported_act_dtypes(cls) -> list[torch.dtype]:
        return [torch.float32, torch.float16, torch.bfloat16]

    @classmethod
    def get_min_capability(cls) -> int:
        return 70

    def get_name(self) -> QuantizationMethods:
        return "compressed-tensors"

    def apply_vllm_mapper(self, hf_to_vllm_mapper: "WeightsMapper"):
        self.target_scheme_map = hf_to_vllm_mapper.apply_dict(self.target_scheme_map)
        self.ignore = hf_to_vllm_mapper.apply_list(self.ignore)
        self.sparsity_scheme_map = hf_to_vllm_mapper.apply_dict(
            self.sparsity_scheme_map
        )
        self.sparsity_ignore_list = hf_to_vllm_mapper.apply_list(
            self.sparsity_ignore_list
        )
        if self.kv_cache_scheme is not None:
            self.kv_cache_scheme = hf_to_vllm_mapper.apply_dict(self.kv_cache_scheme)

    def get_quant_method(
        self,
        layer: torch.nn.Module,
        prefix: str,
    ) -> Optional["QuantizeMethodBase"]:
        from vllm.attention.layer import Attention  # Avoid circular import

        if isinstance(layer, LinearBase):
            # collect schemes
            quant_scheme = self.get_scheme(layer=layer, layer_name=prefix)
            input_tfms, output_tfms = get_linear_transform_schemes(
                layer, prefix, self.transform_config, self.packed_modules_mapping
            )

            # choose quantization method
            quant_method: LinearMethodBase = UnquantizedLinearMethod()
            if quant_scheme is not None:
                layer.scheme = quant_scheme
                quant_method = CompressedTensorsLinearMethod(self)

            # choose transform method
            if any((input_tfms, output_tfms)):
                return CompressedTensorsLinearTransformMethod.from_schemes(
                    quant_method, quant_scheme, input_tfms, output_tfms
                )

            else:
                return quant_method

        if isinstance(layer, Attention):
            return CompressedTensorsKVCacheMethod(self)
        if isinstance(layer, FusedMoE):
            return CompressedTensorsMoEMethod.get_moe_method(self, layer)
        return None

    @classmethod
    def from_config(cls, config: dict[str, Any]) -> "CompressedTensorsConfig":
        ignore: list[str] = cast(list[str], config.get("ignore", []))
        quant_format = cast(str, config.get("format"))
        target_scheme_map = cls._quantization_scheme_map_from_config(config=config)
        sparsity_scheme_map, sparsity_ignore_list = cls._parse_sparsity_config(
            config=config
        )
        transform_config = config.get("transform_config")

        return cls(
            target_scheme_map=target_scheme_map,
            ignore=ignore,
            quant_format=quant_format,
            sparsity_scheme_map=sparsity_scheme_map,
            sparsity_ignore_list=sparsity_ignore_list,
            config=config,
            transform_config=transform_config,
        )

    @classmethod
    def _parse_sparsity_config(
        cls, config: dict[str, Any]
    ) -> tuple[dict[str, SparsityCompressionConfig], list[str]]:
        """
        :param config: The `quantization_config` dictionary from config.json
        :return: A tuple with two elements
            1. A dictionary mapping target layer names to their corresponding
                sparsity_config
            2. A list of layer names to ignore for sparsity
        """
        if not (sparsity_config := config.get(SPARSITY_CONFIG_NAME)):
            return dict(), []

        sparsity_config = SparsityCompressionConfig.model_validate(sparsity_config)
        sparse_scheme_map: dict[str, SparsityCompressionConfig] = {
            target: sparsity_config for target in sparsity_config.targets or list()
        }
        sparsity_ignore_list = sparsity_config.ignore or list()
        return sparse_scheme_map, sparsity_ignore_list

    @classmethod
    def _quantization_scheme_map_from_config(
        cls, config: dict[str, Any]
    ) -> QUANTIZATION_SCHEME_MAP_TYPE:
        """
        :param config: The `quantization_config` dictionary from config.json
        :return: A dictionary mapping target layer names to their corresponding
            quantization_args for weights and input activations
        """
        target_scheme_map: dict[str, Any] = dict()
        quant_format = cast(str, config.get("format"))

        # The quant_config has multiple config_groups, each containing
        # an input_activations key with details about how the activations are
        # quantized, a weights key indicating how the weights are quantized,
        # and a list of targets under the `targets` key, dictating which
        # layers are impacted by the quantization details. The quantization
        # details follow the structure defined by the QuantizationArgs
        # pydantic model, which is used to verify the structure of the
        # quant_config and also store the details for later use.

        config_groups = config.get("config_groups", dict())
        for _, quant_config in config_groups.items():
            targets = quant_config.get("targets")
            for target in targets:
                target_scheme_map[target] = {}
                target_scheme_map[target]["weights"] = QuantizationArgs.model_validate(
                    quant_config.get("weights")
                )

                target_scheme_map[target]["input_activations"] = None
                target_scheme_map[target]["format"] = quant_config.get("format")
                format = target_scheme_map[target].get("format")
                # If no per-config format defined, use global format in config
                act_quant_format = (
                    is_activation_quantization_format(format)
                    if format is not None
                    else is_activation_quantization_format(quant_format)
                )
                # TODO(czhu): w4a8fp8 is in packed-quantized format
                # but needs input activation quantization
                input_activations = quant_config.get("input_activations")
                if act_quant_format or input_activations:
                    # The only case where we have activation quant supported
                    # but no input_activations provided in the config
                    # should be w8a16fp8 w8a16fp8 can also run for cases where
                    # there is an input_quant but it is ignored
                    if not input_activations:
                        assert (
                            target_scheme_map[target]["weights"].type
                            == QuantizationType.FLOAT
                        )
                    else:
                        target_scheme_map[target]["input_activations"] = (
                            QuantizationArgs.model_validate(  # noqa: E501
                                quant_config.get("input_activations")
                            )
                        )
        return target_scheme_map

    @classmethod
    def get_config_filenames(cls) -> list[str]:
        return []

    def _check_scheme_supported(
        self, min_capability: int, error: bool = True, match_exact: bool = False
    ) -> bool:
        capability_tuple = current_platform.get_device_capability()

        if capability_tuple is not None:
            capability = capability_tuple.to_int()
            if match_exact:
                supported = capability == min_capability
                if error and not supported:
                    raise RuntimeError(
                        "Quantization scheme is not supported for ",
                        "the current GPU. Required capability: ",
                        f"{min_capability}. Current capability: {capability}.",
                    )
            else:
                supported = capability >= min_capability
                if error and not supported:
                    raise RuntimeError(
                        "Quantization scheme is not supported for ",
                        f"the current GPU. Min capability: {min_capability}. ",
                        f"Current capability: {capability}.",
                    )
            return supported
        else:
            return False

    def _is_fp4a4_nvfp4(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ):
        if weight_quant is None or input_quant is None:
            return False

        is_tensor_group_quant = (
            weight_quant.strategy == QuantizationStrategy.TENSOR_GROUP.value
            and input_quant.strategy == QuantizationStrategy.TENSOR_GROUP.value
        )
        is_symmetric = weight_quant.symmetric and input_quant.symmetric

        is_group_size_16 = (
            weight_quant.group_size == 16 and input_quant.group_size == 16
        )
        is_float_type = (
            weight_quant.type == QuantizationType.FLOAT
            and input_quant.type == QuantizationType.FLOAT.value
        )
        is_4_bits = weight_quant.num_bits == 4 and input_quant.num_bits == 4

        return (
            is_tensor_group_quant
            and is_float_type
            and is_4_bits
            and is_group_size_16
            and is_symmetric
        )

    def _is_fp4a16_nvfp4(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ):
        is_weight_only = weight_quant is not None and input_quant is None
        is_tensor_group_quant = (
            weight_quant.strategy == QuantizationStrategy.TENSOR_GROUP.value
        )
        is_symmetric = weight_quant.symmetric

        is_group_size_16 = weight_quant.group_size == 16
        is_float_type = weight_quant.type == QuantizationType.FLOAT
        is_4_bits = weight_quant.num_bits == 4

        return (
            is_weight_only
            and is_tensor_group_quant
            and is_float_type
            and is_4_bits
            and is_group_size_16
            and is_symmetric
        )

    def _is_static_tensor_w8a8(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        is_8_bits = weight_quant.num_bits == input_quant.num_bits == 8
        weight_strategy = (
            weight_quant.strategy == QuantizationStrategy.TENSOR.value
            or weight_quant.strategy == QuantizationStrategy.CHANNEL.value
        )
        is_tensor = (
            weight_strategy
            and input_quant.strategy == QuantizationStrategy.TENSOR.value
        )
        is_static = not weight_quant.dynamic and not input_quant.dynamic

        # Both symmetric and asymmetric input quantization supported.
        # Only symmetric weight quantization supported.
        return is_8_bits and is_tensor and weight_quant.symmetric and is_static

    def _is_dynamic_token_w8a8(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        is_8_bits = weight_quant.num_bits == input_quant.num_bits == 8
        weight_strategy = (
            weight_quant.strategy == QuantizationStrategy.TENSOR.value
            or weight_quant.strategy == QuantizationStrategy.CHANNEL.value
        )
        is_token = (
            weight_strategy and input_quant.strategy == QuantizationStrategy.TOKEN.value
        )
        is_dynamic = not weight_quant.dynamic and input_quant.dynamic

        # Both symmetric and asymmetric input quantization supported.
        # Only symmetric weight quantization supported.
        return is_8_bits and is_token and weight_quant.symmetric and is_dynamic

    def _is_dynamic_token_w4a8_int(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        is_weight_4_bits = weight_quant.num_bits == 4
        is_activation_8_bits = input_quant.num_bits == 8
        weight_strategy = (
            weight_quant.strategy == QuantizationStrategy.GROUP.value
            or weight_quant.strategy == QuantizationStrategy.CHANNEL.value
        )
        is_token = (
            weight_strategy and input_quant.strategy == QuantizationStrategy.TOKEN.value
        )
        is_dynamic = not weight_quant.dynamic and input_quant.dynamic

        # Both symmetric and asymmetric input quantization supported.
        # Only symmetric weight quantization supported.
        return (
            is_weight_4_bits
            and is_activation_8_bits
            and is_token
            and weight_quant.symmetric
            and is_dynamic
        )

    def _is_fp8_w8a8(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        # Confirm weights and activations quantized.
        if weight_quant is None or input_quant is None:
            return False

        # Confirm weight scheme is supported.
        is_floating_point = (
            weight_quant.type == QuantizationType.FLOAT
            and input_quant.type == QuantizationType.FLOAT
        )
        is_symmetric_weight = weight_quant.symmetric
        is_static_weight = not weight_quant.dynamic
        is_tensor_or_channel_or_block_weight = weight_quant.strategy in [
            QuantizationStrategy.TENSOR,
            QuantizationStrategy.CHANNEL,
            QuantizationStrategy.BLOCK,
        ]
        if not (
            is_floating_point
            and is_symmetric_weight
            and is_static_weight
            and is_tensor_or_channel_or_block_weight
        ):
            return False

        # Dynamic quantization is always supported if weights supported.
        if input_quant.dynamic:
            return True

        # Confirm activation scheme is supported.
        is_symmetric_activation = input_quant.symmetric
        is_per_tensor_activation = input_quant.strategy == QuantizationStrategy.TENSOR
        return is_symmetric_activation and is_per_tensor_activation

    def _is_fp8_w4a8(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        if not weight_quant or not input_quant:
            return False
        is_weight_4_bits = weight_quant.num_bits == 4
        is_activation_8_bits = input_quant.num_bits == 8
        weight_strategy = weight_quant.strategy == QuantizationStrategy.GROUP.value
        is_token = (
            weight_strategy and input_quant.strategy == QuantizationStrategy.TOKEN.value
        )
        is_dynamic = not weight_quant.dynamic and input_quant.dynamic
        is_symmetric = weight_quant.symmetric and input_quant.symmetric
        # Only per-group symmetric weight (4bit)
        # + per-tok symmetric activation (8bit) quantization supported.
        return (
            is_weight_4_bits
            and is_activation_8_bits
            and is_token
            and is_symmetric
            and is_dynamic
        )

    def _is_fp8_w4a8_sm90(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        return self._check_scheme_supported(
            90, error=False, match_exact=True
        ) and self._is_fp8_w4a8(weight_quant, input_quant)

    def _is_fp8_w8a8_sm90(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        return self._check_scheme_supported(
            90, error=False, match_exact=True
        ) and self._is_fp8_w8a8(weight_quant, input_quant)

    def _is_fp8_w8a8_sm100(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        return self._check_scheme_supported(
            100, error=False, match_exact=True
        ) and self._is_fp8_w8a8(weight_quant, input_quant)

    def _is_fp8_w8a16(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        # Confirm weights quantized.
        if weight_quant is None:
            return False

        # Confirm we have floating points.
        if weight_quant.type != QuantizationType.FLOAT:
            return False

        # Confirm weight scheme is supported.
        is_symmetric_weight = weight_quant.symmetric
        is_static_weight = not weight_quant.dynamic
        is_tensor_or_channel_or_block_weight = weight_quant.strategy in [
            QuantizationStrategy.TENSOR,
            QuantizationStrategy.CHANNEL,
            QuantizationStrategy.BLOCK,
        ]
        return (
            is_symmetric_weight
            and is_static_weight
            and is_tensor_or_channel_or_block_weight
        )

    def _is_wNa16_group_channel(
        self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
    ) -> bool:
        input_quant_none = input_quant is None
        is_channel_group = (
            weight_quant.strategy == QuantizationStrategy.CHANNEL.value
            or weight_quant.strategy == QuantizationStrategy.GROUP.value
        )
        is_static = not weight_quant.dynamic

        return is_channel_group and input_quant_none and is_static

    def _get_scheme_from_parts(
        self,
        weight_quant: QuantizationArgs,
        input_quant: QuantizationArgs,
        format: Optional[str] = None,
    ) -> "CompressedTensorsScheme":
        # use the per-layer format if defined, otherwise, use global format
        format = format if format is not None else self.quant_format

        # Detect If Mixed Precision
        if self._is_fp4a16_nvfp4(weight_quant, input_quant):
            return CompressedTensorsW4A16Fp4()

        if self._is_fp8_w4a8_sm90(weight_quant, input_quant):
            return CompressedTensorsW4A8Fp8(
                num_bits=weight_quant.num_bits,
                strategy=weight_quant.strategy,
                symmetric=weight_quant.symmetric,
                group_size=weight_quant.group_size,
                actorder=weight_quant.actorder,
            )

        if self._is_wNa16_group_channel(weight_quant, input_quant):
            if (
                format == CompressionFormat.marlin_24.value
                and weight_quant.num_bits in W4A16SPARSE24_SUPPORTED_BITS
            ):
                assert weight_quant.symmetric
                return CompressedTensorsW4A16Sparse24(
                    strategy=weight_quant.strategy,
                    num_bits=weight_quant.num_bits,
                    group_size=weight_quant.group_size,
                )
            if (
                format == CompressionFormat.pack_quantized.value
                and weight_quant.num_bits in WNA16_SUPPORTED_BITS
            ):
                return CompressedTensorsWNA16(
                    num_bits=weight_quant.num_bits,
                    strategy=weight_quant.strategy,
                    symmetric=weight_quant.symmetric,
                    group_size=weight_quant.group_size,
                    actorder=weight_quant.actorder,
                )

        act_quant_format = is_activation_quantization_format(format)
        if act_quant_format:
            if self._is_fp4a4_nvfp4(weight_quant, input_quant):
                if cutlass_fp4_supported() or envs.VLLM_USE_NVFP4_CT_EMULATIONS:
                    return CompressedTensorsW4A4Fp4()
                else:
                    logger.warning_once(
                        "Current platform does not support cutlass NVFP4."
                        " Running CompressedTensorsW4A16Fp4."
                    )
                    return CompressedTensorsW4A16Fp4(has_input_global_scale=True)

            if self._is_fp8_w8a8(weight_quant, input_quant):
                is_fp8_w8a8_supported = self._check_scheme_supported(
                    CompressedTensorsW8A8Fp8.get_min_capability(), error=False
                )
                if is_fp8_w8a8_supported:
                    return CompressedTensorsW8A8Fp8(
                        weight_quant=weight_quant,
                        is_static_input_scheme=(
                            input_quant and not input_quant.dynamic
                        ),
                    )
                else:
                    # note: input_quant will be present for converted models;
                    # will be ignored during inference post loading
                    return CompressedTensorsW8A16Fp8(
                        strategy=weight_quant.strategy,
                        is_static_input_scheme=not input_quant.dynamic,
                    )

            # note: input_quant can be None
            if self._is_fp8_w8a16(weight_quant, input_quant):
                is_static_input_scheme = input_quant and not input_quant.dynamic
                return CompressedTensorsW8A16Fp8(
                    strategy=weight_quant.strategy,
                    is_static_input_scheme=is_static_input_scheme,
                )

            if self._is_static_tensor_w8a8(weight_quant, input_quant):
                return CompressedTensorsW8A8Int8(
                    strategy=weight_quant.strategy,
                    is_static_input_scheme=True,
                    input_symmetric=input_quant.symmetric,
                )

            if self._is_dynamic_token_w8a8(weight_quant, input_quant):
                return CompressedTensorsW8A8Int8(
                    strategy=weight_quant.strategy,
                    is_static_input_scheme=False,
                    input_symmetric=input_quant.symmetric,
                )

            if self._is_dynamic_token_w4a8_int(weight_quant, input_quant):
                is_static_input_scheme = input_quant and not input_quant.dynamic
                return CompressedTensorsW4A8Int(
                    num_bits=weight_quant.num_bits,
                    strategy=weight_quant.strategy,
                    group_size=weight_quant.group_size,
                    is_static_input_scheme=is_static_input_scheme,
                    input_symmetric=input_quant.symmetric,
                )

        raise NotImplementedError("No compressed-tensors compatible scheme was found.")

    def get_scheme(
        self, layer: torch.nn.Module, layer_name: Optional[str] = None
    ) -> Optional["CompressedTensorsScheme"]:
        """
        compressed-tensors supports non uniform in the following way:

        targets of config_groups: There can be N config_groups which each
            have a quantization scheme. Each config_group has a list of targets
            which can be a full layer_name, a regex for a layer_name, or
            an nn.Module name.

        Detect whether a layer_name is found in any target and
        use the quantization scheme corresponding to the matched target
        to select the CompressedTensorsScheme used for inference.
        """

        # Find the "target" in the compressed-tensors config
        # that our layer conforms to.
        # TODO (@kylesayrs): support ignore module names with ct matching utils
        if should_ignore_layer(
            layer_name, ignore=self.ignore, fused_mapping=self.packed_modules_mapping
        ):
            return None

        # Will be empty for models with only sparsity
        weight_quant = input_quant = None
        if self.target_scheme_map:
            matched_target = find_matched_target(
                layer_name=layer_name,
                module=layer,
                targets=self.target_scheme_map.keys(),
                fused_mapping=self.packed_modules_mapping,
            )

            scheme_dict = self.target_scheme_map[matched_target]
            weight_quant = scheme_dict.get("weights")
            input_quant = scheme_dict.get("input_activations")
            format = scheme_dict.get("format")

        # Find the sparsity scheme of the layer
        # assume that fused layers inherit first component's sparsity scheme
        sparsity_targets = self.sparsity_scheme_map.keys() - set(
            self.sparsity_ignore_list
        )
        sparsity_scheme: Optional[SparsityCompressionConfig] = None
        with suppress(ValueError):
            matched_target = find_matched_target(
                layer_name=layer_name,
                module=layer,
                targets=sparsity_targets,
                fused_mapping=self.packed_modules_mapping,
            )
            sparsity_scheme = self.sparsity_scheme_map[matched_target]

        if self.supports_cutlass_24(
            weight_quant=weight_quant,
            input_quant=input_quant,
            sparsity_scheme=sparsity_scheme,
        ):
            # Have a valid sparsity scheme
            # Validate layer is supported by Cutlass 2:4 Kernel
            model_compression_config = (
                None
                if sparsity_scheme is None or sparsity_scheme.format == "dense"
                else self.config
            )

            scheme = CompressedTensors24(
                quantized=weight_quant is not None or input_quant is not None,
                weight_quant=weight_quant,
                input_quant=input_quant,
                model_compression_config=model_compression_config,
            )
        elif weight_quant is None:
            logger.warning_once(
                "Acceleration for non-quantized schemes is "
                "not supported by Compressed Tensors. "
                "Falling back to UnquantizedLinearMethod"
            )
            return None

        else:
            # Find the quant_scheme
            scheme = self._get_scheme_from_parts(  # type: ignore
                weight_quant=weight_quant, input_quant=input_quant, format=format
            )

        # Raise error if device does not support the scheme
        # (e.g. fp8 needs ada lovelace)
        self._check_scheme_supported(scheme.get_min_capability())
        logger.debug("Using scheme: %s for %s", scheme.__class__.__name__, layer_name)
        return scheme

    def get_cache_scale(self, name: str) -> Optional[str]:
        """
        Check whether the param name matches the format for k/v cache scales
        in compressed-tensors. If this is the case, return its equivalent
        param name expected by vLLM

        :param name: param name
        :return: matching param name for KV cache scale in vLLM
        """
        if name.endswith(".output_scale") and ".k_proj" in name:
            return name.replace(".k_proj.output_scale", ".attn.k_scale")
        if name.endswith(".output_scale") and ".v_proj" in name:
            return name.replace(".v_proj.output_scale", ".attn.v_scale")
        # If no matches, return None
        return None

    def has_blocked_weights(self) -> bool:
        for scheme in self.target_scheme_map.values():
            weight_quant = scheme.get("weights")
            if (
                weight_quant is not None
                and weight_quant.strategy == QuantizationStrategy.BLOCK
            ):
                return True
        return False

    @staticmethod
    def supports_cutlass_24(
        weight_quant: Optional[QuantizationArgs],
        input_quant: Optional[QuantizationArgs],
        sparsity_scheme: Optional[SparsityCompressionConfig] = None,
    ) -> bool:
        """
        Check if the layer is supported by the Cutlass 2:4 Kernel
        Conditions:
            - Overarching condition: Sparsity Structure is 2:4
            - Unquantized cases are supported
            - Weight only quantization is not-supported
            - Supported weight quantization strategies are TENSOR and CHANNEL
            - Supported input quantization strategies are TENSOR and TOKEN
            - Only 8 bit quantization is supported

        :return: True if the layer is supported by the Cutlass 2:4 Kernel
            False otherwise
        """
        if sparsity_scheme is None:
            return False

        is_valid_sparsity_structure: bool = (
            sparsity_scheme.sparsity_structure == SparsityStructure.TWO_FOUR.value
        )

        valid_compressors = {
            CompressionFormat.dense.value,
            CompressionFormat.sparse_24_bitmask.value,
        }

        is_valid_sparsity = (
            is_valid_sparsity_structure and sparsity_scheme.format in valid_compressors
        )

        if not is_valid_sparsity:
            return False

        # Unquantized cases are supported
        if weight_quant is None and input_quant is None:
            return True

        # Weight only quantization is not-supported
        if weight_quant is not None and input_quant is None:
            return False

        supported_weight_quant_strategies = [
            QuantizationStrategy.TENSOR.value,
            QuantizationStrategy.CHANNEL.value,
        ]

        assert weight_quant is not None
        assert input_quant is not None
        if weight_quant.strategy not in supported_weight_quant_strategies:
            return False

        supported_input_quant_strategies = [
            QuantizationStrategy.TENSOR.value,
            QuantizationStrategy.TOKEN.value,
        ]

        if input_quant.strategy not in supported_input_quant_strategies:
            return False

        return weight_quant.num_bits == input_quant.num_bits == 8

config instance-attribute

config = config

ignore instance-attribute

ignore = ignore

kv_cache_scheme instance-attribute

kv_cache_scheme = kv_cache_scheme

quant_format instance-attribute

quant_format = quant_format

sparsity_ignore_list instance-attribute

sparsity_ignore_list = sparsity_ignore_list

sparsity_scheme_map instance-attribute

sparsity_scheme_map = sparsity_scheme_map

target_scheme_map instance-attribute

target_scheme_map = target_scheme_map

transform_config instance-attribute

transform_config = model_validate(transform_config)

__init__

__init__(
    target_scheme_map: dict[str, Any],
    ignore: list[str],
    quant_format: str,
    sparsity_scheme_map: dict[
        str, SparsityCompressionConfig
    ],
    sparsity_ignore_list: list[str],
    kv_cache_scheme: Optional[dict[str, Any]] = None,
    config: Optional[dict[str, Any]] = None,
    transform_config: Optional[dict[str, Any]] = None,
)
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def __init__(
    self,
    target_scheme_map: dict[str, Any],
    ignore: list[str],
    quant_format: str,
    sparsity_scheme_map: dict[str, SparsityCompressionConfig],
    sparsity_ignore_list: list[str],
    kv_cache_scheme: Optional[dict[str, Any]] = None,
    config: Optional[dict[str, Any]] = None,
    transform_config: Optional[dict[str, Any]] = None,
):
    super().__init__()
    self.ignore = ignore
    self.quant_format = quant_format
    # Map from [target -> scheme]
    self.target_scheme_map = target_scheme_map
    self.kv_cache_scheme = kv_cache_scheme
    self.sparsity_scheme_map = sparsity_scheme_map
    self.sparsity_ignore_list = sparsity_ignore_list
    self.config = config

    if transform_config:
        self.transform_config = TransformConfig.model_validate(transform_config)
    else:
        self.transform_config = None

_check_scheme_supported

_check_scheme_supported(
    min_capability: int,
    error: bool = True,
    match_exact: bool = False,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _check_scheme_supported(
    self, min_capability: int, error: bool = True, match_exact: bool = False
) -> bool:
    capability_tuple = current_platform.get_device_capability()

    if capability_tuple is not None:
        capability = capability_tuple.to_int()
        if match_exact:
            supported = capability == min_capability
            if error and not supported:
                raise RuntimeError(
                    "Quantization scheme is not supported for ",
                    "the current GPU. Required capability: ",
                    f"{min_capability}. Current capability: {capability}.",
                )
        else:
            supported = capability >= min_capability
            if error and not supported:
                raise RuntimeError(
                    "Quantization scheme is not supported for ",
                    f"the current GPU. Min capability: {min_capability}. ",
                    f"Current capability: {capability}.",
                )
        return supported
    else:
        return False

_get_scheme_from_parts

_get_scheme_from_parts(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
    format: Optional[str] = None,
) -> CompressedTensorsScheme
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _get_scheme_from_parts(
    self,
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
    format: Optional[str] = None,
) -> "CompressedTensorsScheme":
    # use the per-layer format if defined, otherwise, use global format
    format = format if format is not None else self.quant_format

    # Detect If Mixed Precision
    if self._is_fp4a16_nvfp4(weight_quant, input_quant):
        return CompressedTensorsW4A16Fp4()

    if self._is_fp8_w4a8_sm90(weight_quant, input_quant):
        return CompressedTensorsW4A8Fp8(
            num_bits=weight_quant.num_bits,
            strategy=weight_quant.strategy,
            symmetric=weight_quant.symmetric,
            group_size=weight_quant.group_size,
            actorder=weight_quant.actorder,
        )

    if self._is_wNa16_group_channel(weight_quant, input_quant):
        if (
            format == CompressionFormat.marlin_24.value
            and weight_quant.num_bits in W4A16SPARSE24_SUPPORTED_BITS
        ):
            assert weight_quant.symmetric
            return CompressedTensorsW4A16Sparse24(
                strategy=weight_quant.strategy,
                num_bits=weight_quant.num_bits,
                group_size=weight_quant.group_size,
            )
        if (
            format == CompressionFormat.pack_quantized.value
            and weight_quant.num_bits in WNA16_SUPPORTED_BITS
        ):
            return CompressedTensorsWNA16(
                num_bits=weight_quant.num_bits,
                strategy=weight_quant.strategy,
                symmetric=weight_quant.symmetric,
                group_size=weight_quant.group_size,
                actorder=weight_quant.actorder,
            )

    act_quant_format = is_activation_quantization_format(format)
    if act_quant_format:
        if self._is_fp4a4_nvfp4(weight_quant, input_quant):
            if cutlass_fp4_supported() or envs.VLLM_USE_NVFP4_CT_EMULATIONS:
                return CompressedTensorsW4A4Fp4()
            else:
                logger.warning_once(
                    "Current platform does not support cutlass NVFP4."
                    " Running CompressedTensorsW4A16Fp4."
                )
                return CompressedTensorsW4A16Fp4(has_input_global_scale=True)

        if self._is_fp8_w8a8(weight_quant, input_quant):
            is_fp8_w8a8_supported = self._check_scheme_supported(
                CompressedTensorsW8A8Fp8.get_min_capability(), error=False
            )
            if is_fp8_w8a8_supported:
                return CompressedTensorsW8A8Fp8(
                    weight_quant=weight_quant,
                    is_static_input_scheme=(
                        input_quant and not input_quant.dynamic
                    ),
                )
            else:
                # note: input_quant will be present for converted models;
                # will be ignored during inference post loading
                return CompressedTensorsW8A16Fp8(
                    strategy=weight_quant.strategy,
                    is_static_input_scheme=not input_quant.dynamic,
                )

        # note: input_quant can be None
        if self._is_fp8_w8a16(weight_quant, input_quant):
            is_static_input_scheme = input_quant and not input_quant.dynamic
            return CompressedTensorsW8A16Fp8(
                strategy=weight_quant.strategy,
                is_static_input_scheme=is_static_input_scheme,
            )

        if self._is_static_tensor_w8a8(weight_quant, input_quant):
            return CompressedTensorsW8A8Int8(
                strategy=weight_quant.strategy,
                is_static_input_scheme=True,
                input_symmetric=input_quant.symmetric,
            )

        if self._is_dynamic_token_w8a8(weight_quant, input_quant):
            return CompressedTensorsW8A8Int8(
                strategy=weight_quant.strategy,
                is_static_input_scheme=False,
                input_symmetric=input_quant.symmetric,
            )

        if self._is_dynamic_token_w4a8_int(weight_quant, input_quant):
            is_static_input_scheme = input_quant and not input_quant.dynamic
            return CompressedTensorsW4A8Int(
                num_bits=weight_quant.num_bits,
                strategy=weight_quant.strategy,
                group_size=weight_quant.group_size,
                is_static_input_scheme=is_static_input_scheme,
                input_symmetric=input_quant.symmetric,
            )

    raise NotImplementedError("No compressed-tensors compatible scheme was found.")

_is_dynamic_token_w4a8_int

_is_dynamic_token_w4a8_int(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_dynamic_token_w4a8_int(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    is_weight_4_bits = weight_quant.num_bits == 4
    is_activation_8_bits = input_quant.num_bits == 8
    weight_strategy = (
        weight_quant.strategy == QuantizationStrategy.GROUP.value
        or weight_quant.strategy == QuantizationStrategy.CHANNEL.value
    )
    is_token = (
        weight_strategy and input_quant.strategy == QuantizationStrategy.TOKEN.value
    )
    is_dynamic = not weight_quant.dynamic and input_quant.dynamic

    # Both symmetric and asymmetric input quantization supported.
    # Only symmetric weight quantization supported.
    return (
        is_weight_4_bits
        and is_activation_8_bits
        and is_token
        and weight_quant.symmetric
        and is_dynamic
    )

_is_dynamic_token_w8a8

_is_dynamic_token_w8a8(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_dynamic_token_w8a8(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    is_8_bits = weight_quant.num_bits == input_quant.num_bits == 8
    weight_strategy = (
        weight_quant.strategy == QuantizationStrategy.TENSOR.value
        or weight_quant.strategy == QuantizationStrategy.CHANNEL.value
    )
    is_token = (
        weight_strategy and input_quant.strategy == QuantizationStrategy.TOKEN.value
    )
    is_dynamic = not weight_quant.dynamic and input_quant.dynamic

    # Both symmetric and asymmetric input quantization supported.
    # Only symmetric weight quantization supported.
    return is_8_bits and is_token and weight_quant.symmetric and is_dynamic

_is_fp4a16_nvfp4

_is_fp4a16_nvfp4(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
)
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp4a16_nvfp4(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
):
    is_weight_only = weight_quant is not None and input_quant is None
    is_tensor_group_quant = (
        weight_quant.strategy == QuantizationStrategy.TENSOR_GROUP.value
    )
    is_symmetric = weight_quant.symmetric

    is_group_size_16 = weight_quant.group_size == 16
    is_float_type = weight_quant.type == QuantizationType.FLOAT
    is_4_bits = weight_quant.num_bits == 4

    return (
        is_weight_only
        and is_tensor_group_quant
        and is_float_type
        and is_4_bits
        and is_group_size_16
        and is_symmetric
    )

_is_fp4a4_nvfp4

_is_fp4a4_nvfp4(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
)
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp4a4_nvfp4(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
):
    if weight_quant is None or input_quant is None:
        return False

    is_tensor_group_quant = (
        weight_quant.strategy == QuantizationStrategy.TENSOR_GROUP.value
        and input_quant.strategy == QuantizationStrategy.TENSOR_GROUP.value
    )
    is_symmetric = weight_quant.symmetric and input_quant.symmetric

    is_group_size_16 = (
        weight_quant.group_size == 16 and input_quant.group_size == 16
    )
    is_float_type = (
        weight_quant.type == QuantizationType.FLOAT
        and input_quant.type == QuantizationType.FLOAT.value
    )
    is_4_bits = weight_quant.num_bits == 4 and input_quant.num_bits == 4

    return (
        is_tensor_group_quant
        and is_float_type
        and is_4_bits
        and is_group_size_16
        and is_symmetric
    )

_is_fp8_w4a8

_is_fp8_w4a8(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp8_w4a8(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    if not weight_quant or not input_quant:
        return False
    is_weight_4_bits = weight_quant.num_bits == 4
    is_activation_8_bits = input_quant.num_bits == 8
    weight_strategy = weight_quant.strategy == QuantizationStrategy.GROUP.value
    is_token = (
        weight_strategy and input_quant.strategy == QuantizationStrategy.TOKEN.value
    )
    is_dynamic = not weight_quant.dynamic and input_quant.dynamic
    is_symmetric = weight_quant.symmetric and input_quant.symmetric
    # Only per-group symmetric weight (4bit)
    # + per-tok symmetric activation (8bit) quantization supported.
    return (
        is_weight_4_bits
        and is_activation_8_bits
        and is_token
        and is_symmetric
        and is_dynamic
    )

_is_fp8_w4a8_sm90

_is_fp8_w4a8_sm90(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp8_w4a8_sm90(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    return self._check_scheme_supported(
        90, error=False, match_exact=True
    ) and self._is_fp8_w4a8(weight_quant, input_quant)

_is_fp8_w8a16

_is_fp8_w8a16(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp8_w8a16(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    # Confirm weights quantized.
    if weight_quant is None:
        return False

    # Confirm we have floating points.
    if weight_quant.type != QuantizationType.FLOAT:
        return False

    # Confirm weight scheme is supported.
    is_symmetric_weight = weight_quant.symmetric
    is_static_weight = not weight_quant.dynamic
    is_tensor_or_channel_or_block_weight = weight_quant.strategy in [
        QuantizationStrategy.TENSOR,
        QuantizationStrategy.CHANNEL,
        QuantizationStrategy.BLOCK,
    ]
    return (
        is_symmetric_weight
        and is_static_weight
        and is_tensor_or_channel_or_block_weight
    )

_is_fp8_w8a8

_is_fp8_w8a8(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp8_w8a8(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    # Confirm weights and activations quantized.
    if weight_quant is None or input_quant is None:
        return False

    # Confirm weight scheme is supported.
    is_floating_point = (
        weight_quant.type == QuantizationType.FLOAT
        and input_quant.type == QuantizationType.FLOAT
    )
    is_symmetric_weight = weight_quant.symmetric
    is_static_weight = not weight_quant.dynamic
    is_tensor_or_channel_or_block_weight = weight_quant.strategy in [
        QuantizationStrategy.TENSOR,
        QuantizationStrategy.CHANNEL,
        QuantizationStrategy.BLOCK,
    ]
    if not (
        is_floating_point
        and is_symmetric_weight
        and is_static_weight
        and is_tensor_or_channel_or_block_weight
    ):
        return False

    # Dynamic quantization is always supported if weights supported.
    if input_quant.dynamic:
        return True

    # Confirm activation scheme is supported.
    is_symmetric_activation = input_quant.symmetric
    is_per_tensor_activation = input_quant.strategy == QuantizationStrategy.TENSOR
    return is_symmetric_activation and is_per_tensor_activation

_is_fp8_w8a8_sm100

_is_fp8_w8a8_sm100(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp8_w8a8_sm100(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    return self._check_scheme_supported(
        100, error=False, match_exact=True
    ) and self._is_fp8_w8a8(weight_quant, input_quant)

_is_fp8_w8a8_sm90

_is_fp8_w8a8_sm90(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_fp8_w8a8_sm90(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    return self._check_scheme_supported(
        90, error=False, match_exact=True
    ) and self._is_fp8_w8a8(weight_quant, input_quant)

_is_static_tensor_w8a8

_is_static_tensor_w8a8(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_static_tensor_w8a8(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    is_8_bits = weight_quant.num_bits == input_quant.num_bits == 8
    weight_strategy = (
        weight_quant.strategy == QuantizationStrategy.TENSOR.value
        or weight_quant.strategy == QuantizationStrategy.CHANNEL.value
    )
    is_tensor = (
        weight_strategy
        and input_quant.strategy == QuantizationStrategy.TENSOR.value
    )
    is_static = not weight_quant.dynamic and not input_quant.dynamic

    # Both symmetric and asymmetric input quantization supported.
    # Only symmetric weight quantization supported.
    return is_8_bits and is_tensor and weight_quant.symmetric and is_static

_is_wNa16_group_channel

_is_wNa16_group_channel(
    weight_quant: QuantizationArgs,
    input_quant: QuantizationArgs,
) -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def _is_wNa16_group_channel(
    self, weight_quant: QuantizationArgs, input_quant: QuantizationArgs
) -> bool:
    input_quant_none = input_quant is None
    is_channel_group = (
        weight_quant.strategy == QuantizationStrategy.CHANNEL.value
        or weight_quant.strategy == QuantizationStrategy.GROUP.value
    )
    is_static = not weight_quant.dynamic

    return is_channel_group and input_quant_none and is_static

_parse_sparsity_config classmethod

_parse_sparsity_config(
    config: dict[str, Any],
) -> tuple[dict[str, SparsityCompressionConfig], list[str]]

:param config: The quantization_config dictionary from config.json :return: A tuple with two elements 1. A dictionary mapping target layer names to their corresponding sparsity_config 2. A list of layer names to ignore for sparsity

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@classmethod
def _parse_sparsity_config(
    cls, config: dict[str, Any]
) -> tuple[dict[str, SparsityCompressionConfig], list[str]]:
    """
    :param config: The `quantization_config` dictionary from config.json
    :return: A tuple with two elements
        1. A dictionary mapping target layer names to their corresponding
            sparsity_config
        2. A list of layer names to ignore for sparsity
    """
    if not (sparsity_config := config.get(SPARSITY_CONFIG_NAME)):
        return dict(), []

    sparsity_config = SparsityCompressionConfig.model_validate(sparsity_config)
    sparse_scheme_map: dict[str, SparsityCompressionConfig] = {
        target: sparsity_config for target in sparsity_config.targets or list()
    }
    sparsity_ignore_list = sparsity_config.ignore or list()
    return sparse_scheme_map, sparsity_ignore_list

_quantization_scheme_map_from_config classmethod

_quantization_scheme_map_from_config(
    config: dict[str, Any],
) -> QUANTIZATION_SCHEME_MAP_TYPE

:param config: The quantization_config dictionary from config.json :return: A dictionary mapping target layer names to their corresponding quantization_args for weights and input activations

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@classmethod
def _quantization_scheme_map_from_config(
    cls, config: dict[str, Any]
) -> QUANTIZATION_SCHEME_MAP_TYPE:
    """
    :param config: The `quantization_config` dictionary from config.json
    :return: A dictionary mapping target layer names to their corresponding
        quantization_args for weights and input activations
    """
    target_scheme_map: dict[str, Any] = dict()
    quant_format = cast(str, config.get("format"))

    # The quant_config has multiple config_groups, each containing
    # an input_activations key with details about how the activations are
    # quantized, a weights key indicating how the weights are quantized,
    # and a list of targets under the `targets` key, dictating which
    # layers are impacted by the quantization details. The quantization
    # details follow the structure defined by the QuantizationArgs
    # pydantic model, which is used to verify the structure of the
    # quant_config and also store the details for later use.

    config_groups = config.get("config_groups", dict())
    for _, quant_config in config_groups.items():
        targets = quant_config.get("targets")
        for target in targets:
            target_scheme_map[target] = {}
            target_scheme_map[target]["weights"] = QuantizationArgs.model_validate(
                quant_config.get("weights")
            )

            target_scheme_map[target]["input_activations"] = None
            target_scheme_map[target]["format"] = quant_config.get("format")
            format = target_scheme_map[target].get("format")
            # If no per-config format defined, use global format in config
            act_quant_format = (
                is_activation_quantization_format(format)
                if format is not None
                else is_activation_quantization_format(quant_format)
            )
            # TODO(czhu): w4a8fp8 is in packed-quantized format
            # but needs input activation quantization
            input_activations = quant_config.get("input_activations")
            if act_quant_format or input_activations:
                # The only case where we have activation quant supported
                # but no input_activations provided in the config
                # should be w8a16fp8 w8a16fp8 can also run for cases where
                # there is an input_quant but it is ignored
                if not input_activations:
                    assert (
                        target_scheme_map[target]["weights"].type
                        == QuantizationType.FLOAT
                    )
                else:
                    target_scheme_map[target]["input_activations"] = (
                        QuantizationArgs.model_validate(  # noqa: E501
                            quant_config.get("input_activations")
                        )
                    )
    return target_scheme_map

apply_vllm_mapper

apply_vllm_mapper(hf_to_vllm_mapper: WeightsMapper)
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def apply_vllm_mapper(self, hf_to_vllm_mapper: "WeightsMapper"):
    self.target_scheme_map = hf_to_vllm_mapper.apply_dict(self.target_scheme_map)
    self.ignore = hf_to_vllm_mapper.apply_list(self.ignore)
    self.sparsity_scheme_map = hf_to_vllm_mapper.apply_dict(
        self.sparsity_scheme_map
    )
    self.sparsity_ignore_list = hf_to_vllm_mapper.apply_list(
        self.sparsity_ignore_list
    )
    if self.kv_cache_scheme is not None:
        self.kv_cache_scheme = hf_to_vllm_mapper.apply_dict(self.kv_cache_scheme)

from_config classmethod

from_config(
    config: dict[str, Any],
) -> CompressedTensorsConfig
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@classmethod
def from_config(cls, config: dict[str, Any]) -> "CompressedTensorsConfig":
    ignore: list[str] = cast(list[str], config.get("ignore", []))
    quant_format = cast(str, config.get("format"))
    target_scheme_map = cls._quantization_scheme_map_from_config(config=config)
    sparsity_scheme_map, sparsity_ignore_list = cls._parse_sparsity_config(
        config=config
    )
    transform_config = config.get("transform_config")

    return cls(
        target_scheme_map=target_scheme_map,
        ignore=ignore,
        quant_format=quant_format,
        sparsity_scheme_map=sparsity_scheme_map,
        sparsity_ignore_list=sparsity_ignore_list,
        config=config,
        transform_config=transform_config,
    )

get_cache_scale

get_cache_scale(name: str) -> Optional[str]

Check whether the param name matches the format for k/v cache scales in compressed-tensors. If this is the case, return its equivalent param name expected by vLLM

:param name: param name :return: matching param name for KV cache scale in vLLM

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def get_cache_scale(self, name: str) -> Optional[str]:
    """
    Check whether the param name matches the format for k/v cache scales
    in compressed-tensors. If this is the case, return its equivalent
    param name expected by vLLM

    :param name: param name
    :return: matching param name for KV cache scale in vLLM
    """
    if name.endswith(".output_scale") and ".k_proj" in name:
        return name.replace(".k_proj.output_scale", ".attn.k_scale")
    if name.endswith(".output_scale") and ".v_proj" in name:
        return name.replace(".v_proj.output_scale", ".attn.v_scale")
    # If no matches, return None
    return None

get_config_filenames classmethod

get_config_filenames() -> list[str]
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@classmethod
def get_config_filenames(cls) -> list[str]:
    return []

get_linear_method

get_linear_method() -> CompressedTensorsLinearMethod
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def get_linear_method(self) -> "CompressedTensorsLinearMethod":
    return CompressedTensorsLinearMethod(self)

get_min_capability classmethod

get_min_capability() -> int
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@classmethod
def get_min_capability(cls) -> int:
    return 70

get_name

get_name() -> QuantizationMethods
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def get_name(self) -> QuantizationMethods:
    return "compressed-tensors"

get_quant_method

get_quant_method(
    layer: Module, prefix: str
) -> Optional[QuantizeMethodBase]
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def get_quant_method(
    self,
    layer: torch.nn.Module,
    prefix: str,
) -> Optional["QuantizeMethodBase"]:
    from vllm.attention.layer import Attention  # Avoid circular import

    if isinstance(layer, LinearBase):
        # collect schemes
        quant_scheme = self.get_scheme(layer=layer, layer_name=prefix)
        input_tfms, output_tfms = get_linear_transform_schemes(
            layer, prefix, self.transform_config, self.packed_modules_mapping
        )

        # choose quantization method
        quant_method: LinearMethodBase = UnquantizedLinearMethod()
        if quant_scheme is not None:
            layer.scheme = quant_scheme
            quant_method = CompressedTensorsLinearMethod(self)

        # choose transform method
        if any((input_tfms, output_tfms)):
            return CompressedTensorsLinearTransformMethod.from_schemes(
                quant_method, quant_scheme, input_tfms, output_tfms
            )

        else:
            return quant_method

    if isinstance(layer, Attention):
        return CompressedTensorsKVCacheMethod(self)
    if isinstance(layer, FusedMoE):
        return CompressedTensorsMoEMethod.get_moe_method(self, layer)
    return None

get_scheme

get_scheme(
    layer: Module, layer_name: Optional[str] = None
) -> Optional[CompressedTensorsScheme]

compressed-tensors supports non uniform in the following way:

There can be N config_groups which each

have a quantization scheme. Each config_group has a list of targets which can be a full layer_name, a regex for a layer_name, or an nn.Module name.

Detect whether a layer_name is found in any target and use the quantization scheme corresponding to the matched target to select the CompressedTensorsScheme used for inference.

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def get_scheme(
    self, layer: torch.nn.Module, layer_name: Optional[str] = None
) -> Optional["CompressedTensorsScheme"]:
    """
    compressed-tensors supports non uniform in the following way:

    targets of config_groups: There can be N config_groups which each
        have a quantization scheme. Each config_group has a list of targets
        which can be a full layer_name, a regex for a layer_name, or
        an nn.Module name.

    Detect whether a layer_name is found in any target and
    use the quantization scheme corresponding to the matched target
    to select the CompressedTensorsScheme used for inference.
    """

    # Find the "target" in the compressed-tensors config
    # that our layer conforms to.
    # TODO (@kylesayrs): support ignore module names with ct matching utils
    if should_ignore_layer(
        layer_name, ignore=self.ignore, fused_mapping=self.packed_modules_mapping
    ):
        return None

    # Will be empty for models with only sparsity
    weight_quant = input_quant = None
    if self.target_scheme_map:
        matched_target = find_matched_target(
            layer_name=layer_name,
            module=layer,
            targets=self.target_scheme_map.keys(),
            fused_mapping=self.packed_modules_mapping,
        )

        scheme_dict = self.target_scheme_map[matched_target]
        weight_quant = scheme_dict.get("weights")
        input_quant = scheme_dict.get("input_activations")
        format = scheme_dict.get("format")

    # Find the sparsity scheme of the layer
    # assume that fused layers inherit first component's sparsity scheme
    sparsity_targets = self.sparsity_scheme_map.keys() - set(
        self.sparsity_ignore_list
    )
    sparsity_scheme: Optional[SparsityCompressionConfig] = None
    with suppress(ValueError):
        matched_target = find_matched_target(
            layer_name=layer_name,
            module=layer,
            targets=sparsity_targets,
            fused_mapping=self.packed_modules_mapping,
        )
        sparsity_scheme = self.sparsity_scheme_map[matched_target]

    if self.supports_cutlass_24(
        weight_quant=weight_quant,
        input_quant=input_quant,
        sparsity_scheme=sparsity_scheme,
    ):
        # Have a valid sparsity scheme
        # Validate layer is supported by Cutlass 2:4 Kernel
        model_compression_config = (
            None
            if sparsity_scheme is None or sparsity_scheme.format == "dense"
            else self.config
        )

        scheme = CompressedTensors24(
            quantized=weight_quant is not None or input_quant is not None,
            weight_quant=weight_quant,
            input_quant=input_quant,
            model_compression_config=model_compression_config,
        )
    elif weight_quant is None:
        logger.warning_once(
            "Acceleration for non-quantized schemes is "
            "not supported by Compressed Tensors. "
            "Falling back to UnquantizedLinearMethod"
        )
        return None

    else:
        # Find the quant_scheme
        scheme = self._get_scheme_from_parts(  # type: ignore
            weight_quant=weight_quant, input_quant=input_quant, format=format
        )

    # Raise error if device does not support the scheme
    # (e.g. fp8 needs ada lovelace)
    self._check_scheme_supported(scheme.get_min_capability())
    logger.debug("Using scheme: %s for %s", scheme.__class__.__name__, layer_name)
    return scheme

get_supported_act_dtypes

get_supported_act_dtypes() -> list[dtype]
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def get_supported_act_dtypes(cls) -> list[torch.dtype]:
    return [torch.float32, torch.float16, torch.bfloat16]

has_blocked_weights

has_blocked_weights() -> bool
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def has_blocked_weights(self) -> bool:
    for scheme in self.target_scheme_map.values():
        weight_quant = scheme.get("weights")
        if (
            weight_quant is not None
            and weight_quant.strategy == QuantizationStrategy.BLOCK
        ):
            return True
    return False

supports_cutlass_24 staticmethod

supports_cutlass_24(
    weight_quant: Optional[QuantizationArgs],
    input_quant: Optional[QuantizationArgs],
    sparsity_scheme: Optional[
        SparsityCompressionConfig
    ] = None,
) -> bool

Check if the layer is supported by the Cutlass 2:4 Kernel Conditions: - Overarching condition: Sparsity Structure is 2:4 - Unquantized cases are supported - Weight only quantization is not-supported - Supported weight quantization strategies are TENSOR and CHANNEL - Supported input quantization strategies are TENSOR and TOKEN - Only 8 bit quantization is supported

:return: True if the layer is supported by the Cutlass 2:4 Kernel False otherwise

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@staticmethod
def supports_cutlass_24(
    weight_quant: Optional[QuantizationArgs],
    input_quant: Optional[QuantizationArgs],
    sparsity_scheme: Optional[SparsityCompressionConfig] = None,
) -> bool:
    """
    Check if the layer is supported by the Cutlass 2:4 Kernel
    Conditions:
        - Overarching condition: Sparsity Structure is 2:4
        - Unquantized cases are supported
        - Weight only quantization is not-supported
        - Supported weight quantization strategies are TENSOR and CHANNEL
        - Supported input quantization strategies are TENSOR and TOKEN
        - Only 8 bit quantization is supported

    :return: True if the layer is supported by the Cutlass 2:4 Kernel
        False otherwise
    """
    if sparsity_scheme is None:
        return False

    is_valid_sparsity_structure: bool = (
        sparsity_scheme.sparsity_structure == SparsityStructure.TWO_FOUR.value
    )

    valid_compressors = {
        CompressionFormat.dense.value,
        CompressionFormat.sparse_24_bitmask.value,
    }

    is_valid_sparsity = (
        is_valid_sparsity_structure and sparsity_scheme.format in valid_compressors
    )

    if not is_valid_sparsity:
        return False

    # Unquantized cases are supported
    if weight_quant is None and input_quant is None:
        return True

    # Weight only quantization is not-supported
    if weight_quant is not None and input_quant is None:
        return False

    supported_weight_quant_strategies = [
        QuantizationStrategy.TENSOR.value,
        QuantizationStrategy.CHANNEL.value,
    ]

    assert weight_quant is not None
    assert input_quant is not None
    if weight_quant.strategy not in supported_weight_quant_strategies:
        return False

    supported_input_quant_strategies = [
        QuantizationStrategy.TENSOR.value,
        QuantizationStrategy.TOKEN.value,
    ]

    if input_quant.strategy not in supported_input_quant_strategies:
        return False

    return weight_quant.num_bits == input_quant.num_bits == 8

CompressedTensorsKVCacheMethod

Bases: BaseKVCacheMethod

Supports loading kv-cache scaling factors from compressed-tensors checkpoints.

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
class CompressedTensorsKVCacheMethod(BaseKVCacheMethod):
    """
    Supports loading kv-cache scaling factors from compressed-tensors
    checkpoints.
    """

    def __init__(self, quant_config: CompressedTensorsConfig):
        self.validate_kv_cache_scheme(quant_config.kv_cache_scheme)
        super().__init__(quant_config)

    @staticmethod
    def validate_kv_cache_scheme(kv_cache_scheme: Optional[dict[str, Any]]):
        """
        Validator for the kv cache scheme. Useful for controlling the
        kv cache quantization schemes, that are being supported in vLLM
        :param kv_cache_scheme: the compressed-tensors kv cache scheme
        """
        if kv_cache_scheme is None:
            return

        type_ = kv_cache_scheme.get("type")
        num_bits = kv_cache_scheme.get("num_bits")

        if type_ != "float" and num_bits != 8:
            raise NotImplementedError(
                "Currently supported kv cache quantization is "
                "num_bits=8, type=float, however "
                f"received num_bits={num_bits}, type={type_}"
            )

        strategy = kv_cache_scheme.get("strategy")
        if strategy != "tensor":
            raise NotImplementedError(
                "Only support per-tensor scaling factor "
                "for compressed-tensors KV cache. "
                f"Expected strategy: tensor, found strategy: {strategy}"
            )

        is_symmetric = kv_cache_scheme.get("symmetric")
        if not is_symmetric:
            raise NotImplementedError(
                "Only support symmetric scaling factor "
                "for compressed-tensors KV cache. "
                f"However found symmetric: {is_symmetric}"
            )

__init__

__init__(quant_config: CompressedTensorsConfig)
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def __init__(self, quant_config: CompressedTensorsConfig):
    self.validate_kv_cache_scheme(quant_config.kv_cache_scheme)
    super().__init__(quant_config)

validate_kv_cache_scheme staticmethod

validate_kv_cache_scheme(
    kv_cache_scheme: Optional[dict[str, Any]],
)

Validator for the kv cache scheme. Useful for controlling the kv cache quantization schemes, that are being supported in vLLM :param kv_cache_scheme: the compressed-tensors kv cache scheme

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
@staticmethod
def validate_kv_cache_scheme(kv_cache_scheme: Optional[dict[str, Any]]):
    """
    Validator for the kv cache scheme. Useful for controlling the
    kv cache quantization schemes, that are being supported in vLLM
    :param kv_cache_scheme: the compressed-tensors kv cache scheme
    """
    if kv_cache_scheme is None:
        return

    type_ = kv_cache_scheme.get("type")
    num_bits = kv_cache_scheme.get("num_bits")

    if type_ != "float" and num_bits != 8:
        raise NotImplementedError(
            "Currently supported kv cache quantization is "
            "num_bits=8, type=float, however "
            f"received num_bits={num_bits}, type={type_}"
        )

    strategy = kv_cache_scheme.get("strategy")
    if strategy != "tensor":
        raise NotImplementedError(
            "Only support per-tensor scaling factor "
            "for compressed-tensors KV cache. "
            f"Expected strategy: tensor, found strategy: {strategy}"
        )

    is_symmetric = kv_cache_scheme.get("symmetric")
    if not is_symmetric:
        raise NotImplementedError(
            "Only support symmetric scaling factor "
            "for compressed-tensors KV cache. "
            f"However found symmetric: {is_symmetric}"
        )

CompressedTensorsLinearMethod

Bases: LinearMethodBase

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
class CompressedTensorsLinearMethod(LinearMethodBase):
    def __init__(self, quantization_config: CompressedTensorsConfig):
        self.quantization_config = quantization_config

    def process_weights_after_loading(self, layer: torch.nn.Module) -> None:
        layer.scheme.process_weights_after_loading(layer)

    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,
    ):
        """
        Use the CompressedTensorsScheme associated with each layer to create
        the necessary parameters for the layer. See LinearMethodBase for param
        details
        """
        weight_loader = extra_weight_attrs.get("weight_loader")
        layer.scheme.create_weights(
            layer=layer,
            input_size=input_size,
            input_size_per_partition=input_size_per_partition,
            output_partition_sizes=output_partition_sizes,
            output_size=output_size,
            params_dtype=params_dtype,
            weight_loader=weight_loader,
        )

    def apply(
        self,
        layer: torch.nn.Module,
        x: torch.Tensor,
        bias: Optional[torch.Tensor] = None,
    ):
        """
        Use the output of create_weights and the CompressedTensorsScheme
        associated with the layer to apply the forward pass with the
        layer input.  See LinearMethodBase for param details

        """
        scheme = layer.scheme
        if scheme is None:
            raise ValueError("A scheme must be defined for each layer")
        return scheme.apply_weights(layer, x, bias=bias)

quantization_config instance-attribute

quantization_config = quantization_config

__init__

__init__(quantization_config: CompressedTensorsConfig)
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def __init__(self, quantization_config: CompressedTensorsConfig):
    self.quantization_config = quantization_config

apply

apply(
    layer: Module, x: Tensor, bias: Optional[Tensor] = None
)

Use the output of create_weights and the CompressedTensorsScheme associated with the layer to apply the forward pass with the layer input. See LinearMethodBase for param details

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def apply(
    self,
    layer: torch.nn.Module,
    x: torch.Tensor,
    bias: Optional[torch.Tensor] = None,
):
    """
    Use the output of create_weights and the CompressedTensorsScheme
    associated with the layer to apply the forward pass with the
    layer input.  See LinearMethodBase for param details

    """
    scheme = layer.scheme
    if scheme is None:
        raise ValueError("A scheme must be defined for each layer")
    return scheme.apply_weights(layer, x, bias=bias)

create_weights

create_weights(
    layer: Module,
    input_size_per_partition: int,
    output_partition_sizes: list[int],
    input_size: int,
    output_size: int,
    params_dtype: dtype,
    **extra_weight_attrs,
)

Use the CompressedTensorsScheme associated with each layer to create the necessary parameters for the layer. See LinearMethodBase for param details

Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
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,
):
    """
    Use the CompressedTensorsScheme associated with each layer to create
    the necessary parameters for the layer. See LinearMethodBase for param
    details
    """
    weight_loader = extra_weight_attrs.get("weight_loader")
    layer.scheme.create_weights(
        layer=layer,
        input_size=input_size,
        input_size_per_partition=input_size_per_partition,
        output_partition_sizes=output_partition_sizes,
        output_size=output_size,
        params_dtype=params_dtype,
        weight_loader=weight_loader,
    )

process_weights_after_loading

process_weights_after_loading(layer: Module) -> None
Source code in vllm/model_executor/layers/quantization/compressed_tensors/compressed_tensors.py
def process_weights_after_loading(self, layer: torch.nn.Module) -> None:
    layer.scheme.process_weights_after_loading(layer)