loader.py 63.8 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
# ruff: noqa: SIM117
4
import collections
5
import copy
6
import dataclasses
7
import fnmatch
8
import glob
9
import inspect
10
import itertools
11
import math
12
import os
13
import time
14
import warnings
15
from abc import ABC, abstractmethod
16
from contextlib import contextmanager
17
18
from typing import (Any, Callable, Dict, Generator, Iterable, List, Optional,
                    Tuple, cast)
19

20
import gguf
21
import huggingface_hub
22
import numpy as np
23
import torch
24
from huggingface_hub import HfApi
25
from torch import nn
26
from transformers import AutoModelForCausalLM
27
from transformers.utils import SAFE_WEIGHTS_INDEX_NAME
28

29
from vllm.attention import Attention
30
from vllm.config import (LoadConfig, LoadFormat, ModelConfig, ParallelConfig,
31
                         VllmConfig, set_current_vllm_config)
32
33
from vllm.distributed import (get_tensor_model_parallel_rank,
                              get_tensor_model_parallel_world_size)
34
from vllm.envs import VLLM_USE_MODELSCOPE
35
from vllm.logger import init_logger
36
37
# yapf conflicts with isort for this block
# yapf: disable
38
39
from vllm.model_executor.layers.linear import (LinearBase,
                                               MergedColumnParallelLinear,
40
                                               QKVCrossParallelLinear,
41
42
                                               QKVParallelLinear,
                                               ReplicatedLinear,
43
                                               RowParallelLinear)
44
# yapf: enable
45
from vllm.model_executor.layers.quantization.base_config import (
46
    QuantizeMethodBase)
47
from vllm.model_executor.model_loader.tensorizer import (
48
    TensorizerConfig, is_vllm_tensorized, load_with_tensorizer,
49
    serialize_vllm_model, tensorizer_weights_iterator)
50
from vllm.model_executor.model_loader.utils import (ParamMapping,
51
                                                    configure_quant_config,
52
                                                    get_model_architecture,
53
54
                                                    set_default_torch_dtype)
from vllm.model_executor.model_loader.weight_utils import (
55
    download_safetensors_index_file_from_hf, download_weights_from_hf,
56
57
58
59
    fastsafetensors_weights_iterator, filter_duplicate_safetensors_files,
    filter_files_not_needed_for_inference, get_gguf_extra_tensor_names,
    get_lock, gguf_quant_weights_iterator, initialize_dummy_weights,
    np_cache_weights_iterator, pt_weights_iterator,
60
    runai_safetensors_weights_iterator, safetensors_weights_iterator)
61
from vllm.model_executor.utils import set_weight_attrs
62
from vllm.platforms import current_platform
63
from vllm.transformers_utils.s3_utils import glob as s3_glob
64
from vllm.transformers_utils.utils import is_s3
65
from vllm.utils import is_pin_memory_available
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95


@contextmanager
def device_loading_context(module: torch.nn.Module,
                           target_device: torch.device):
    if target_device.type == "cpu":
        # If target is CPU, no need to move anything
        yield module
        return

    original_device_states: Dict[str, torch.device] = {}

    # Store original device states and move parameters to GPU if they're on CPU
    for name, p in module.named_parameters():
        if p.device.type == "cpu":
            original_device_states[name] = p.device
            p.data = p.data.to(target_device)
        # Parameters already on target device are not touched

    try:
        yield module

    finally:
        # Restore parameters to their original devices, ignoring new parameters
        pin_memory = is_pin_memory_available()
        for name, p in module.named_parameters():
            if name in original_device_states:
                original_device: torch.device = original_device_states[name]
                if original_device.type == "cpu":
                    # `torch.empty_like` does not support `pin_memory` argument
96
97
98
99
100
101
102
103
                    cpu_data = torch.empty_strided(
                        size=p.data.size(),
                        stride=p.data.stride(),
                        dtype=p.data.dtype,
                        layout=p.data.layout,
                        device="cpu",
                        pin_memory=pin_memory,
                    )
104
105
106
107
108
109
                    cpu_data.copy_(p.data)
                    p.data = cpu_data
                else:
                    p.data = p.data.to(original_device)
        # New parameters or parameters already on target device are untouched

110
111
112
113

logger = init_logger(__name__)


114
def _initialize_model(
115
116
117
    vllm_config: VllmConfig,
    *,
    prefix: str = "",
118
    model_class: Optional[type[nn.Module]] = None,
119
) -> nn.Module:
120
    """Initialize a model with the given configurations."""
121
    model_config = vllm_config.model_config
122
123
    if model_class is None:
        model_class, _ = get_model_architecture(model_config)
124

125
126
127
    if vllm_config.quant_config is not None:
        configure_quant_config(vllm_config.quant_config, model_class)

128
    signatures = inspect.signature(model_class.__init__)
129
130
131
    all_params = [param.name for param in signatures.parameters.values()]
    if "vllm_config" in all_params and "prefix" in all_params:
        # new-style model class
132
        with set_current_vllm_config(vllm_config, check_compile=True):
133
            return model_class(vllm_config=vllm_config, prefix=prefix)
134

135
136
137
    msg = ("vLLM model class should accept `vllm_config` and `prefix` as "
           "input arguments. Possibly you have an old-style model class"
           " registered from out of tree and it is used for new vLLM version. "
138
           "Check https://docs.vllm.ai/en/latest/design/arch_overview.html "
139
           "for the design and update the model class accordingly.")
140
141
    warnings.warn(msg, DeprecationWarning, stacklevel=2)

142
143
    logger.warning(
        "Trying to guess the arguments for old-style model class %s",
144
145
        model_class,
    )
146
147
148
149
150
151
152
153
154
155
156
157
158
159
    # try to be compatible with old-style model class
    kwargs = {}
    if "prefix" in all_params:
        kwargs["prefix"] = prefix
    if "config" in all_params:
        kwargs["config"] = model_config.hf_config
    if "cache_config" in all_params:
        kwargs["cache_config"] = vllm_config.cache_config
    if "quant_config" in all_params:
        kwargs["quant_config"] = vllm_config.quant_config
    if "lora_config" in all_params:
        kwargs["lora_config"] = vllm_config.lora_config
    if "scheduler_config" in all_params:
        kwargs["scheduler_config"] = vllm_config.scheduler_config
王敏's avatar
王敏 committed
160
161
    if "parallel_config" in all_params:
        kwargs["parallel_config"] = vllm_config.parallel_config
162
    with set_current_vllm_config(vllm_config, check_compile=True):
163
        return model_class(**kwargs)
164
165


166
167
168
def _process_weights_after_loading(model: nn.Module, model_config: ModelConfig,
                                   target_device: torch.device) -> None:
    for _, module in model.named_modules():
169
170
171
172
173
        if isinstance(module, QKVCrossParallelLinear):
            # NOTE(Isotr0py): special case for cross QKV layer because
            # q and kv proj aren't registered as submodules intentionally
            module.process_weights_after_loading()
            continue
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
        quant_method = getattr(module, "quant_method", None)
        if isinstance(quant_method, QuantizeMethodBase):
            # When quant methods need to process weights after loading
            # (for repacking, quantizing, etc), they expect parameters
            # to be on the global target device. This scope is for the
            # case where cpu offloading is used, where we will move the
            # parameters onto device for processing and back off after.
            with device_loading_context(module, target_device):
                quant_method.process_weights_after_loading(module)

    # Currently only used by MLA.
    # NOTE: This intentionally happens after other modules so we can easily
    # decompress the weights for MLA.
    for _, module in model.named_modules():
        if isinstance(module, Attention) and \
            hasattr(module, "process_weights_after_loading"):
            # TODO(lucas): see if there is a way to unify the signatures
            # of process_weights_after_loading
            module.process_weights_after_loading(model_config.dtype)


195
196
197
198
199
200
class BaseModelLoader(ABC):
    """Base class for model loaders."""

    def __init__(self, load_config: LoadConfig):
        self.load_config = load_config

201
202
203
204
205
    @abstractmethod
    def download_model(self, model_config: ModelConfig) -> None:
        """Download a model so that it can be immediately loaded."""
        raise NotImplementedError

206
    @abstractmethod
207
    def load_model(self, *, vllm_config: VllmConfig) -> nn.Module:
208
        """Load a model with the given configurations."""
209
        raise NotImplementedError
210
211
212
213
214


class DefaultModelLoader(BaseModelLoader):
    """Model loader that can load different file types from disk."""

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
    @dataclasses.dataclass
    class Source:
        """A source for weights."""

        model_or_path: str
        """The model ID or path."""

        revision: Optional[str]
        """The optional model revision."""

        prefix: str = ""
        """A prefix to prepend to all weights."""

        fall_back_to_pt: bool = True
        """Whether .pt weights can be used."""

231
232
233
        allow_patterns_overrides: Optional[list[str]] = None
        """If defined, weights will load exclusively using these patterns."""

234
235
236
    counter_before_loading_weights: float = 0.0
    counter_after_loading_weights: float = 0.0

237
238
239
240
241
242
243
244
245
    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)
        if load_config.model_loader_extra_config:
            raise ValueError(f"Model loader extra config is not supported for "
                             f"load format {load_config.load_format}")

    def _maybe_download_from_modelscope(
            self, model: str, revision: Optional[str]) -> Optional[str]:
        """Download model from ModelScope hub if VLLM_USE_MODELSCOPE is True.
246

247
248
249
250
251
252
253
254
255
        Returns the path to the downloaded model, or None if the model is not
        downloaded from ModelScope."""
        if VLLM_USE_MODELSCOPE:
            # download model from ModelScope hub,
            # lazy import so that modelscope is not required for normal use.
            # pylint: disable=C.
            from modelscope.hub.snapshot_download import snapshot_download

            if not os.path.exists(model):
256
257
258
259
260
261
262
263
264
265
266
                # Use file lock to prevent multiple processes from
                # downloading the same model weights at the same time.
                with get_lock(model, self.load_config.download_dir):
                    model_path = snapshot_download(
                        model_id=model,
                        cache_dir=self.load_config.download_dir,
                        local_files_only=huggingface_hub.constants.
                        HF_HUB_OFFLINE,
                        revision=revision,
                        ignore_file_pattern=self.load_config.ignore_patterns,
                    )
267
268
269
270
271
            else:
                model_path = model
            return model_path
        return None

272
273
274
275
276
    def _prepare_weights(
        self,
        model_name_or_path: str,
        revision: Optional[str],
        fall_back_to_pt: bool,
277
        allow_patterns_overrides: Optional[list[str]],
278
    ) -> Tuple[str, List[str], bool]:
279
280
281
        """Prepare weights for the model.

        If the model is not local, it will be downloaded."""
282
283
        model_name_or_path = (self._maybe_download_from_modelscope(
            model_name_or_path, revision) or model_name_or_path)
284
285
286
287

        is_local = os.path.isdir(model_name_or_path)
        load_format = self.load_config.load_format
        use_safetensors = False
288
        index_file = SAFE_WEIGHTS_INDEX_NAME
289
290
291
        # Some quantized models use .pt files for storing the weights.
        if load_format == LoadFormat.AUTO:
            allow_patterns = ["*.safetensors", "*.bin"]
292
293
        elif (load_format == LoadFormat.SAFETENSORS
              or load_format == LoadFormat.FASTSAFETENSORS):
294
295
            use_safetensors = True
            allow_patterns = ["*.safetensors"]
296
297
298
299
        elif load_format == LoadFormat.MISTRAL:
            use_safetensors = True
            allow_patterns = ["consolidated*.safetensors"]
            index_file = "consolidated.safetensors.index.json"
300
301
302
303
304
305
306
307
308
309
        elif load_format == LoadFormat.PT:
            allow_patterns = ["*.pt"]
        elif load_format == LoadFormat.NPCACHE:
            allow_patterns = ["*.bin"]
        else:
            raise ValueError(f"Unknown load_format: {load_format}")

        if fall_back_to_pt:
            allow_patterns += ["*.pt"]

310
311
312
        if allow_patterns_overrides is not None:
            allow_patterns = allow_patterns_overrides

313
        if not is_local:
314
315
316
317
318
319
320
            hf_folder = download_weights_from_hf(
                model_name_or_path,
                self.load_config.download_dir,
                allow_patterns,
                revision,
                ignore_patterns=self.load_config.ignore_patterns,
            )
321
322
323
324
325
326
327
328
329
330
331
        else:
            hf_folder = model_name_or_path

        hf_weights_files: List[str] = []
        for pattern in allow_patterns:
            hf_weights_files += glob.glob(os.path.join(hf_folder, pattern))
            if len(hf_weights_files) > 0:
                if pattern == "*.safetensors":
                    use_safetensors = True
                break

332
333
334
335
336
337
338
339
        if use_safetensors:
            # For models like Mistral-7B-Instruct-v0.3
            # there are both sharded safetensors files and a consolidated
            # safetensors file. Using both breaks.
            # Here, we download the `model.safetensors.index.json` and filter
            # any files not found in the index.
            if not is_local:
                download_safetensors_index_file_from_hf(
340
341
342
343
344
                    model_name_or_path,
                    index_file,
                    self.load_config.download_dir,
                    revision,
                )
345
            hf_weights_files = filter_duplicate_safetensors_files(
346
                hf_weights_files, hf_folder, index_file)
347
        else:
348
349
350
351
352
353
354
355
356
357
            hf_weights_files = filter_files_not_needed_for_inference(
                hf_weights_files)

        if len(hf_weights_files) == 0:
            raise RuntimeError(
                f"Cannot find any model weights with `{model_name_or_path}`")

        return hf_folder, hf_weights_files, use_safetensors

    def _get_weights_iterator(
358
            self, source: "Source"
359
360
361
    ) -> Generator[Tuple[str, torch.Tensor], None, None]:
        """Get an iterator for the model weights based on the load format."""
        hf_folder, hf_weights_files, use_safetensors = self._prepare_weights(
362
363
            source.model_or_path, source.revision, source.fall_back_to_pt,
            source.allow_patterns_overrides)
364
365
366
        if self.load_config.load_format == LoadFormat.NPCACHE:
            # Currently np_cache only support *.bin checkpoints
            assert use_safetensors is False
367
            weights_iterator = np_cache_weights_iterator(
368
369
370
371
                source.model_or_path,
                self.load_config.download_dir,
                hf_folder,
                hf_weights_files,
372
                self.load_config.use_tqdm_on_load,
373
            )
374
        elif use_safetensors:
375
376
377
378
379
380
381
382
383
384
            if self.load_config.load_format == LoadFormat.FASTSAFETENSORS:
                weights_iterator = fastsafetensors_weights_iterator(
                    hf_weights_files,
                    self.load_config.use_tqdm_on_load,
                )
            else:
                weights_iterator = safetensors_weights_iterator(
                    hf_weights_files,
                    self.load_config.use_tqdm_on_load,
                )
385
        else:
386
387
388
389
            weights_iterator = pt_weights_iterator(
                hf_weights_files,
                self.load_config.use_tqdm_on_load,
            )
390

391
        if current_platform.is_tpu():
392
393
394
395
396
397
398
399
400
401
            # In PyTorch XLA, we should call `xm.mark_step` frequently so that
            # not too many ops are accumulated in the XLA program.
            import torch_xla.core.xla_model as xm

            def _xla_weights_iterator(iterator: Generator):
                for weights in iterator:
                    yield weights
                    xm.mark_step()

            weights_iterator = _xla_weights_iterator(weights_iterator)
402

403
404
405
406
407
408
409
410
411
412
        elif current_platform.is_hpu():
            import habana_frameworks.torch.core as htcore

            def _hpu_weights_iterator(iterator: Generator):
                for weights in iterator:
                    yield weights
                    htcore.mark_step()

            weights_iterator = _hpu_weights_iterator(weights_iterator)

413
414
        if self.counter_before_loading_weights == 0.0:
            self.counter_before_loading_weights = time.perf_counter()
415
416
417
418
        # Apply the prefix.
        return ((source.prefix + name, tensor)
                for (name, tensor) in weights_iterator)

419
    def get_all_weights(
420
421
422
423
424
425
426
427
428
        self,
        model_config: ModelConfig,
        model: nn.Module,
    ) -> Generator[Tuple[str, torch.Tensor], None, None]:
        primary_weights = DefaultModelLoader.Source(
            model_config.model,
            model_config.revision,
            prefix="",
            fall_back_to_pt=getattr(model, "fall_back_to_pt_during_load",
429
                                    True),
430
431
            allow_patterns_overrides=getattr(model, "allow_patterns_overrides",
                                             None),
432
        )
433
434
        yield from self._get_weights_iterator(primary_weights)

435
436
437
438
        secondary_weights = cast(
            Iterable[DefaultModelLoader.Source],
            getattr(model, "secondary_weights", ()),
        )
439
440
        for source in secondary_weights:
            yield from self._get_weights_iterator(source)
441

442
443
444
    def download_model(self, model_config: ModelConfig) -> None:
        self._prepare_weights(model_config.model,
                              model_config.revision,
445
446
                              fall_back_to_pt=True,
                              allow_patterns_overrides=None)
447

448
449
450
    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config
451
        target_device = torch.device(device_config.device)
452
        with set_default_torch_dtype(model_config.dtype):
453
            with target_device:
454
                model = _initialize_model(vllm_config=vllm_config)
455

456
457
            weights_to_load = {name for name, _ in model.named_parameters()}
            loaded_weights = model.load_weights(
458
                self.get_all_weights(model_config, model))
459
460
461
462
463
            self.counter_after_loading_weights = time.perf_counter()
            logger.info(
                "Loading weights took %.2f seconds",
                self.counter_after_loading_weights -
                self.counter_before_loading_weights)
464
            # We only enable strict check for non-quantized models
465
466
467
468
469
470
471
            # that have loaded weights tracking currently.
            if model_config.quantization is None and loaded_weights is not None:
                weights_not_loaded = weights_to_load - loaded_weights
                if weights_not_loaded:
                    raise ValueError(
                        "Following weights were not initialized from "
                        f"checkpoint: {weights_not_loaded}")
472

473
474
            _process_weights_after_loading(model, model_config, target_device)

475
476
477
478
479
480
481
482
483
484
485
486
        return model.eval()


class DummyModelLoader(BaseModelLoader):
    """Model loader that will set model weights to random values."""

    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)
        if load_config.model_loader_extra_config:
            raise ValueError(f"Model loader extra config is not supported for "
                             f"load format {load_config.load_format}")

487
488
489
    def download_model(self, model_config: ModelConfig) -> None:
        pass  # Nothing to download

490
491
492
    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config
493
        target_device = torch.device(device_config.device)
494
        with set_default_torch_dtype(model_config.dtype):
495
            with target_device:
496
                model = _initialize_model(vllm_config=vllm_config)
497
498
499
            # NOTE(woosuk): For accurate performance evaluation, we assign
            # random values to the weights.
            initialize_dummy_weights(model)
500

501
            _process_weights_after_loading(model, model_config, target_device)
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
        return model.eval()


class TensorizerLoader(BaseModelLoader):
    """Model loader using CoreWeave's tensorizer library."""

    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)
        if isinstance(load_config.model_loader_extra_config, TensorizerConfig):
            self.tensorizer_config = load_config.model_loader_extra_config
        else:
            self.tensorizer_config = TensorizerConfig(
                **load_config.model_loader_extra_config)

    def _verify_config(self, model_config: ModelConfig,
                       parallel_config: ParallelConfig):
        self.tensorizer_config.verify_with_model_config(model_config)
        self.tensorizer_config.verify_with_parallel_config(parallel_config)

    def _get_weights_iterator(
522
        self, ) -> Generator[Tuple[str, torch.Tensor], None, None]:
523
524
525
        tensorizer_args = self.tensorizer_config._construct_tensorizer_args()
        return tensorizer_weights_iterator(tensorizer_args)

526
    def _load_model_serialized_cpu(
527
        self,
528
        vllm_config: VllmConfig,
529
    ) -> nn.Module:
530
        """Load a serialized model with tensorizer to the CPU.
531

532
        This is only necessary when the model isn't vLLM-tensorized (see
533
534
535
        examples/other/tensorize_vllm_model.py) This should still
        be faster than default HuggingFace loading, but will be slower than
        loading a vLLM-tensorized model.
536
        """
537
538
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config
539
540
        with set_default_torch_dtype(model_config.dtype):
            with torch.device(device_config.device):
541
                model = _initialize_model(vllm_config=vllm_config)
542
543
544
545
546

            model.load_weights(self._get_weights_iterator())
        return model.eval()

    def _load_model_serialized(
547
        self,
548
        vllm_config: VllmConfig,
549
550
551
    ) -> nn.Module:
        """Load a serialized model with tensorizer.

552
        Expects a vLLM-tensorized model. See the
553
        examples/other/tensorize_vllm_model.py example script
554
        for serializing vLLM models."""
555
556
557
558

        device_config = vllm_config.device_config
        model_config = vllm_config.model_config

559
560
561
562
563
564
565
566
567
        with set_default_torch_dtype(model_config.dtype):
            with torch.device(device_config.device):
                model_class = get_model_architecture(model_config)[0]

                tensorizer_config = copy.copy(self.tensorizer_config)
                tensorizer_config.model_class = model_class
                tensorizer_config.hf_config = model_config.hf_config
                tensorizer_config.dtype = model_config.dtype

568
569
                model = load_with_tensorizer(tensorizer_config,
                                             vllm_config=vllm_config)
570
571
        return model.eval()

572
573
574
575
576
577
    def download_model(self, model_config: ModelConfig) -> None:
        self.tensorizer_config.verify_with_model_config(model_config)

        with self.tensorizer_config.open_stream():
            pass

578
579
580
    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        model_config = vllm_config.model_config
        parallel_config = vllm_config.parallel_config
581
582
        self._verify_config(model_config, parallel_config)

583
584
        if parallel_config.tensor_parallel_size > 1:
            from vllm.distributed import get_tensor_model_parallel_rank
585
586
587
588

            self.tensorizer_config.tensorizer_uri = (
                self.tensorizer_config.tensorizer_uri %
                get_tensor_model_parallel_rank())
589

590
        if is_vllm_tensorized(self.tensorizer_config):
591
592
            return self._load_model_serialized(vllm_config=vllm_config)
        return self._load_model_serialized_cpu(vllm_config=vllm_config)
593

594
595
596
597
598
599
600
601
602
603
    @staticmethod
    def save_model(
        model: torch.nn.Module,
        tensorizer_config: TensorizerConfig,
    ) -> None:
        serialize_vllm_model(
            model=model,
            tensorizer_config=tensorizer_config,
        )

604

605
606
607
608
609
class ShardedStateLoader(BaseModelLoader):
    """
    Model loader that directly loads each worker's model state dict, which
    enables a fast load path for large tensor-parallel models where each worker
    only needs to read its own shard rather than the entire checkpoint. See
610
611
    `examples/offline_inference/save_sharded_state.py` for creating a sharded
    checkpoint.
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
    """

    DEFAULT_PATTERN = "model-rank-{rank}-part-{part}.safetensors"

    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)
        extra_config = ({} if load_config.model_loader_extra_config is None
                        else load_config.model_loader_extra_config.copy())
        self.pattern = extra_config.pop("pattern", self.DEFAULT_PATTERN)
        if extra_config:
            raise ValueError(f"Unexpected extra config keys for load format "
                             f"{load_config.load_format}: "
                             f"{load_config.model_loader_extra_config.keys()}")

    @staticmethod
    def _filter_subtensors(
628
        tensors: Dict[str, torch.Tensor], ) -> Dict[str, torch.Tensor]:
629
630
631
632
        """
        Filter out all tensors that share the same memory or a subset of the
        memory of another tensor.
        """
633
634
        same_storage_groups: Dict[Any, List[Tuple[str, torch.Tensor]]] = (
            collections.defaultdict(list))
635
636
637
638
639
640
641
642
        for key, tensor in tensors.items():
            if tensor.numel():
                ptr = tensor.untyped_storage().data_ptr()
                same_storage_groups[tensor.device, ptr].append((key, tensor))

        def get_end_ptr(tensor: torch.Tensor) -> int:
            return tensor.view(-1)[-1].data_ptr() + tensor.element_size()

643
        result: Dict[str, torch.Tensor] = {}
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
        for group in same_storage_groups.values():
            for k, t in group:
                a, b = t.data_ptr(), get_end_ptr(t)
                for k2, t2 in group:
                    if not t2.is_contiguous():
                        continue
                    a2, b2 = t2.data_ptr(), get_end_ptr(t2)
                    if a < a2 or b2 < b:
                        continue
                    if a2 < a or b < b2 or not t.is_contiguous():
                        break  # t2 covers strictly more memory than t.
                    if k2 < k:
                        # Same tensors, keep the one with the smaller key.
                        break
                else:
                    result[k] = t
        return result

662
663
664
665
666
667
    def _prepare_weights(self, model_name_or_path: str,
                         revision: Optional[str]):
        if os.path.isdir(model_name_or_path):
            return model_name_or_path
        else:
            allow_patterns = ["*.safetensors"]
668
669
670
671
672
673
674
            return download_weights_from_hf(
                model_name_or_path,
                self.load_config.download_dir,
                allow_patterns,
                revision,
                ignore_patterns=self.load_config.ignore_patterns,
            )
675

676
677
678
    def download_model(self, model_config: ModelConfig) -> None:
        self._prepare_weights(model_config.model, model_config.revision)

679
680
681
    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config
682
        target_device = torch.device(device_config.device)
683
684
685
        from safetensors.torch import safe_open

        from vllm.distributed import get_tensor_model_parallel_rank
686
687
688
689

        local_model_path = self._prepare_weights(model_config.model,
                                                 model_config.revision)

690
        with set_default_torch_dtype(model_config.dtype):
691
            with target_device:
692
                model = _initialize_model(vllm_config=vllm_config)
693
694
                _process_weights_after_loading(model, model_config,
                                               target_device)
695
696
            rank = get_tensor_model_parallel_rank()
            pattern = os.path.join(
697
                local_model_path,
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
                self.pattern.format(rank=rank, part="*"),
            )
            filepaths = glob.glob(pattern)
            if not filepaths:
                # TODO: support un-sharded checkpoints too
                raise ValueError(
                    f"Could not find checkpoint files '{pattern}', only "
                    f"pre-sharded checkpoints are currently supported!")
            state_dict = self._filter_subtensors(model.state_dict())
            for path in filepaths:
                with safe_open(path, framework="pt") as f:
                    for key in f.keys():  # noqa: SIM118
                        tensor = f.get_tensor(key)
                        # If loading with LoRA enabled, additional padding may
                        # be added to certain parameters. We only load into a
                        # narrowed view of the parameter data.
                        param_data = state_dict[key].data
                        param_shape = state_dict[key].shape
                        for dim, size in enumerate(tensor.shape):
                            if size < param_shape[dim]:
                                param_data = param_data.narrow(dim, 0, size)
                        if tensor.shape != param_shape:
                            logger.warning(
                                "loading tensor of shape %s into "
722
723
724
725
726
                                "parameter '%s' of shape %s",
                                tensor.shape,
                                key,
                                param_shape,
                            )
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
                        param_data.copy_(tensor)
                        state_dict.pop(key)
            if state_dict:
                raise ValueError(
                    f"Missing keys {tuple(state_dict)} in loaded state!")
        return model.eval()

    @staticmethod
    def save_model(
        model: torch.nn.Module,
        path: str,
        pattern: Optional[str] = None,
        max_size: Optional[int] = None,
    ) -> None:
        from safetensors.torch import save_file

        from vllm.distributed import get_tensor_model_parallel_rank
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
        if pattern is None:
            pattern = ShardedStateLoader.DEFAULT_PATTERN
        rank = get_tensor_model_parallel_rank()
        part_idx = 0
        total_size = 0
        state_dict = ShardedStateLoader._filter_subtensors(model.state_dict())
        state_dict_part: Dict[str, torch.Tensor] = {}
        for key, tensor in state_dict.items():
            param_size = tensor.nelement() * tensor.element_size()
            if max_size is not None and total_size + param_size > max_size:
                filename = pattern.format(rank=rank, part=part_idx)
                save_file(
                    state_dict_part,
                    os.path.join(path, filename),
                )
                part_idx += 1
                total_size = 0
                state_dict_part = {}
            state_dict_part[key] = tensor
            total_size += param_size
        if len(state_dict_part) > 0:
            filename = pattern.format(rank=rank, part=part_idx)
            save_file(
                state_dict_part,
                os.path.join(path, filename),
            )
771
772


773
774
775
776
777
778
779
780
class BitsAndBytesModelLoader(BaseModelLoader):
    """Model loader to load model weights with BitAndBytes quantization."""

    possible_config_file_names = ["adapter_config.json"]

    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)

781
782
783
784
        # Save the module names without sharding.
        self.unsharded_weights_modules: List[str] = []
        # Save the module names that are sharded by column.
        self.column_sharded_weights_modules: List[str] = []
785
786
787
        # Store all module names (from transformers) that support
        # BNB quantization.
        self.target_modules: List[str] = []
788
789
        # mapping weight names from transformers to vllm.
        self.weight_mapper: Callable = lambda name: name
790
791

    def _get_weight_files(
792
793
794
795
        self,
        model_name_or_path: str,
        allowed_patterns: List[str],
        revision: Optional[str] = None,
796
    ) -> Tuple[str, List[str], str]:
797
798
        """Retrieve weight files. Download the files if necessary.

799
800
801
802
803
804
805
806
        Return the weight files and the file pattern."""
        is_local = os.path.isdir(model_name_or_path)

        if is_local:
            for pattern in allowed_patterns:
                weight_files = glob.glob(
                    os.path.join(model_name_or_path, pattern))
                if weight_files:
807
                    return model_name_or_path, weight_files, pattern
808
809
810
811
812
813
814
        else:
            hf_api = HfApi()
            repo_files = hf_api.list_repo_files(repo_id=model_name_or_path)
            for pattern in allowed_patterns:
                matching_files = fnmatch.filter(repo_files, pattern)
                if matching_files:
                    hf_folder = download_weights_from_hf(
815
816
817
818
819
820
                        model_name_or_path,
                        self.load_config.download_dir,
                        [pattern],
                        revision,
                        ignore_patterns=self.load_config.ignore_patterns,
                    )
821
822
                    return hf_folder, glob.glob(
                        os.path.join(hf_folder, pattern)), pattern
823
824
825
826
827
828
829
830
831
832

        raise RuntimeError(
            f"No model weights found in: `{model_name_or_path}`")

    def _prepare_weights(self, model_name_or_path: str,
                         revision: Optional[str]) -> Tuple[List[str], bool]:
        """Prepare weight files for the model."""

        allowed_patterns = ["*.safetensors", "*.bin", "*.pt"]

833
        hf_folder, hf_weights_files, matched_pattern = self._get_weight_files(
834
835
            model_name_or_path, allowed_patterns, revision)

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
        use_safetensors = matched_pattern == "*.safetensors"
        is_local = os.path.isdir(model_name_or_path)
        index_file = SAFE_WEIGHTS_INDEX_NAME
        if use_safetensors:
            # For models like Mistral-7B-Instruct-v0.3
            # there are both sharded safetensors files and a consolidated
            # safetensors file. Using both breaks.
            # Here, we download the `model.safetensors.index.json` and filter
            # any files not found in the index.
            if not is_local:
                download_safetensors_index_file_from_hf(
                    model_name_or_path,
                    index_file,
                    self.load_config.download_dir,
                    revision,
                )
            hf_weights_files = filter_duplicate_safetensors_files(
                hf_weights_files, hf_folder, index_file)
        else:
855
856
857
858
859
860
861
            hf_weights_files = filter_files_not_needed_for_inference(
                hf_weights_files)

        if len(hf_weights_files) == 0:
            raise RuntimeError(
                f"Cannot find any model weights with `{model_name_or_path}`")

862
        return hf_weights_files, use_safetensors
863

864
865
    def _hf_weight_iter(self, hf_weights_files, use_safetensors: bool):
        if use_safetensors:
866
867
868
869
            iterator = safetensors_weights_iterator(
                hf_weights_files,
                self.load_config.use_tqdm_on_load,
            )
870
        else:
871
872
873
874
            iterator = pt_weights_iterator(
                hf_weights_files,
                self.load_config.use_tqdm_on_load,
            )
875
876
877
878
879
        for org_name, param in iterator:
            # mapping weight names from transformers to vllm while preserving
            # original names.
            mapped_name = self.weight_mapper(org_name)
            yield org_name, mapped_name, param
880

881
    def _get_quantized_weights_iterator(
882
883
884
885
886
        self,
        model_name_or_path: str,
        revision: Optional[str],
        pre_quant: bool,
        load_8bit: bool,
887
888
889
890
891
892
893
894
    ) -> Tuple[Generator[Tuple[str, torch.Tensor], None, None], Dict[str,
                                                                     Any]]:
        """Get an iterator to the model weights with bitsandbytes quantization,
        as well as the quantization state dictionary."""

        # only load the bitsandbytes module when needed
        try:
            import bitsandbytes
895

896
            if bitsandbytes.__version__ < "0.45.3":
897
                raise ImportError("bitsandbytes version is wrong. Please "
898
                                  "install bitsandbytes>=0.45.3.")
899
        except ImportError as err:
900
901
            raise ImportError("Please install bitsandbytes>=0.45.3 via "
                              "`pip install bitsandbytes>=0.45.3` to use "
902
903
904
905
906
                              "bitsandbytes quantizer.") from err

        hf_weights_files, use_safetensors = self._prepare_weights(
            model_name_or_path, revision)

907
        quant_state_dict: Dict[str, Any] = {}
908

909
910
911
912
913
914
915
916
917
        if pre_quant:
            if load_8bit:
                return self._quantized_8bit_generator(
                    hf_weights_files, use_safetensors,
                    quant_state_dict), quant_state_dict
            else:
                return self._quantized_4bit_generator(
                    hf_weights_files, use_safetensors,
                    quant_state_dict), quant_state_dict
918

919
920
        return self._unquantized_generator(hf_weights_files, use_safetensors,
                                           quant_state_dict), quant_state_dict
921

922
923
924
925
926
927
928
    def _is_8bit_weight_name(self, weight_name: str):
        quantized_suffix = {".scb", ".weight_format"}
        return any(weight_name.lower().endswith(suffix)
                   for suffix in quantized_suffix)

    def _is_4bit_weight_name(self, weight_name: str):
        quantized_suffix = {
929
930
931
932
933
            "absmax",
            "quant_map",
            "nested_absmax",
            "nested_quant_map",
            "bitsandbytes",
934
935
936
937
        }
        suffix = weight_name.split(".")[-1]
        return any(q_suffix in suffix for q_suffix in quantized_suffix)

938
939
    def _quantized_8bit_generator(self, hf_weights_files, use_safetensors,
                                  quant_state_dict) -> Generator:
940
941
942
943
944
945
        for (
                org_weight_name,
                mapped_weight_name,
                weight_tensor,
        ) in self._hf_weight_iter(hf_weights_files, use_safetensors):
            if not mapped_weight_name.lower().endswith(".scb"):
946
947
                continue

948
            weight_key = mapped_weight_name.lower().replace(".scb", ".weight")
949
950
            quant_state_dict[weight_key] = weight_tensor

951
952
953
954
955
956
        for (
                org_weight_name,
                mapped_weight_name,
                weight_tensor,
        ) in self._hf_weight_iter(hf_weights_files, use_safetensors):
            if self._is_8bit_weight_name(mapped_weight_name):
957
958
                continue

959
            if mapped_weight_name in quant_state_dict:
960
                set_weight_attrs(weight_tensor, {"load_in_8bit": True})
961
                yield org_weight_name, weight_tensor
962
            else:
963
                yield org_weight_name, weight_tensor
964
965
966
967
968
969
970
971
972

    def _quantized_4bit_generator(self, hf_weights_files, use_safetensors,
                                  quant_state_dict) -> Generator:
        from bitsandbytes.functional import QuantState

        # First iterate over all quant state weights
        weight_iterator = self._hf_weight_iter(hf_weights_files,
                                               use_safetensors)
        temp_state_dict = {}
973
974
975
976
977
978
        for (
                org_weight_name,
                mapped_weight_name,
                weight_tensor,
        ) in weight_iterator:
            if not self._is_4bit_weight_name(mapped_weight_name):
979
980
981
                continue
            # bitsandbytes library requires
            # weight.quant_state.bitsandbytes__* in CPU
982
983
            if "quant_state.bitsandbytes" in mapped_weight_name:
                temp_state_dict[mapped_weight_name] = weight_tensor.cpu().data
984
            else:
985
                temp_state_dict[mapped_weight_name] = weight_tensor
986
987
988
989
990
991
992
993
994

        # Closure to parse quant_state for each prequant weight
        def _parse_quant_state(param_name: str,
                               temp_state_dict: Dict) -> QuantState:
            quant_state = {}
            for k in temp_state_dict:
                if param_name + "." in k:
                    quant_state[k] = temp_state_dict[k]

995
996
            return QuantState.from_dict(quant_state,
                                        device=current_platform.device_type)
997
998
999

        # Second iterate over all prequant and normal weights
        # pre quantized weights would have a quant_state
1000
1001
1002
1003
1004
1005
        for (
                org_weight_name,
                mapped_weight_name,
                weight_tensor,
        ) in self._hf_weight_iter(hf_weights_files, use_safetensors):
            if self._is_4bit_weight_name(mapped_weight_name):
1006
                continue
1007

1008
            if (f"{mapped_weight_name}.quant_state.bitsandbytes__nf4"
1009
                    in temp_state_dict) or (
1010
                        f"{mapped_weight_name}.quant_state.bitsandbytes__fp4"
1011
                        in temp_state_dict):
1012
1013
1014
1015
                quant_state = _parse_quant_state(mapped_weight_name,
                                                 temp_state_dict)
                quant_state_dict[mapped_weight_name] = quant_state
                yield org_weight_name, weight_tensor
1016
            else:
1017
                yield org_weight_name, weight_tensor
1018
1019
1020
1021

    def _unquantized_generator(self, hf_weights_files, use_safetensors,
                               quant_state_dict) -> Generator:
        from bitsandbytes.functional import quantize_4bit
1022

1023
1024
1025
        tp_size = get_tensor_model_parallel_world_size()
        tp_rank = get_tensor_model_parallel_rank()

1026
1027
1028
1029
1030
1031
1032
1033
        for (
                org_weight_name,
                mapped_weight_name,
                weight_tensor,
        ) in self._hf_weight_iter(hf_weights_files, use_safetensors):
            if any(target_module in mapped_weight_name
                   for target_module in self.target_modules
                   ) and mapped_weight_name.endswith(".weight"):
1034
1035
                # Without sharding
                if any(
1036
                        mapped_weight_name.startswith(module)
1037
1038
1039
                        for module in self.unsharded_weights_modules):
                    weight_sub_tensor = weight_tensor
                # Shard by column
1040
                elif any(
1041
                        mapped_weight_name.startswith(module)
1042
                        for module in self.column_sharded_weights_modules):
1043
1044
1045
1046
1047
                    total_size = weight_tensor.size(-1)
                    start_index = total_size // tp_size * tp_rank
                    end_index = total_size // tp_size * (tp_rank + 1)
                    weight_sub_tensor = weight_tensor[...,
                                                      start_index:end_index]
1048
1049
1050
                # Weights have fused on disk. In this case, we assume that the
                # weight and module use same name.
                elif any(
1051
                        mapped_weight_name.startswith(module)
1052
1053
1054
1055
1056
1057
                        for module in self.maybe_fused_weights_modules):
                    # special case for fused weights
                    # get the size of each shard weight tensor
                    total_shard_sizes = next(
                        (sizes for module, sizes in
                         self.maybe_fused_weights_modules.items()
1058
                         if mapped_weight_name.startswith(module)))
1059
1060
1061
1062
1063
                    total_size = weight_tensor.size(0)
                    assert total_size == sum(total_shard_sizes)
                    # get the start/end index of each shard weight tensor
                    total_start_index = list(
                        itertools.accumulate([0] + total_shard_sizes))[:-1]
1064
1065
1066
1067
1068
                    shard_weights_index = [(
                        idx + size // tp_size * tp_rank,
                        idx + size // tp_size * (tp_rank + 1),
                    ) for idx, size in zip(total_start_index,
                                           total_shard_sizes)]
1069
1070
1071
1072
1073
1074
                    # slice and reorder the weight tensor
                    weight_tensor = [
                        weight_tensor[start_index:end_index, ...]
                        for start_index, end_index in shard_weights_index
                    ]
                    weight_sub_tensor = torch.cat(weight_tensor, dim=0)
1075
                # Shard by row
1076
1077
1078
1079
1080
1081
1082
                else:
                    total_size = weight_tensor.size(0)
                    start_index = total_size // tp_size * tp_rank
                    end_index = total_size // tp_size * (tp_rank + 1)
                    weight_sub_tensor = weight_tensor[start_index:end_index,
                                                      ...]

1083
                # bitsandbytes requires data in GPU
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
                if weight_sub_tensor.is_cuda:
                    loaded_weight = weight_sub_tensor
                else:
                    loaded_weight = weight_sub_tensor.cuda()

                # remove the following after the issue is fixed:
                # https://github.com/bitsandbytes-foundation/bitsandbytes/issues/1342
                if loaded_weight.is_contiguous() is False:
                    loaded_weight = loaded_weight.contiguous()

1094
1095
1096
1097
                with set_default_torch_dtype(torch.float32):
                    processed_weight, quant_state = quantize_4bit(
                        loaded_weight,
                        compress_statistics=True,
1098
1099
                        quant_type="nf4",
                    )
1100

1101
                quant_state_dict[mapped_weight_name] = quant_state
1102
1103
            else:
                processed_weight = weight_tensor
1104
            yield org_weight_name, processed_weight
1105

1106
1107
1108
1109
    def _get_bnb_target_modules(self, model: nn.Module) -> None:

        for name, module in model.named_modules():
            if isinstance(module, (LinearBase, )):
1110
                if modules_info := self.modules_mapping.get_sub_modules(name):
1111
                    # Map vllm's names to transformers's names.
1112
                    rep_name, sub_modules = modules_info
1113
                    for sub_name in sub_modules:
1114
                        self.target_modules.append(
1115
                            name.replace(rep_name, sub_name))
1116
1117
1118
1119
1120
                # Add original module name even if the module has stacked map,
                # in case model has a mixture of disk-merged and disk-splitted
                # weights with same last name.
                self.target_modules.append(name)

1121
1122
1123
1124
        assert (self.target_modules
                ), "vllm currently does not support BNB quantization for"
        f" {type(model).__name__}"

1125
1126
    def _load_weights(self, model_config: ModelConfig,
                      model: nn.Module) -> None:
1127
        if not hasattr(model, "load_weights"):
1128
1129
            raise AttributeError(
                "The required method 'load_weights' is not defined in class"
1130
                f" {type(model).__name__}.")
1131

1132
        if not hasattr(model, "packed_modules_mapping"):
1133
            raise AttributeError(
1134
                f"Model {type(model).__name__} does not support BitsAndBytes "
1135
1136
1137
1138
                "quantization yet. No 'packed_modules_mapping' found.")

        self.modules_mapping = ParamMapping(
            copy.deepcopy(model.packed_modules_mapping))
1139

1140
1141
1142
1143
        # For some models like Molmo, we need to use hf_to_vllm_mapper
        # to ensure correct loading of weights.
        if hf_to_vllm_mapper := getattr(model, "hf_to_vllm_mapper", None):
            self.weight_mapper = lambda name: hf_to_vllm_mapper._map_name(name)
1144

1145
1146
1147
        # Modules whose weights might have fused on disk
        # we need their output_sizes to make shard in flight correctly with TP
        self.maybe_fused_weights_modules: Dict[str, List[int]] = {}
1148
        self._get_bnb_target_modules(model)
1149
1150
1151
1152
1153
1154
        for name, module in model.named_modules():
            # Some modules like `ReplicatedLinear` should not have their weights
            # sharded. The reason for implementing it this way is to avoid new
            # static variable in the model implementation.
            if isinstance(module, (ReplicatedLinear, )):
                self.unsharded_weights_modules.append(name)
1155
1156
1157
1158
1159
1160
            # `QKVParallelLinear` and `MergedColumnParallelLinear` might have
            # fused weights on disk. We need to use the output sizes of these
            # modules to shard the weights correctly.
            elif isinstance(module,
                            (QKVParallelLinear, MergedColumnParallelLinear)):
                self.maybe_fused_weights_modules[name] = module.output_sizes
1161
1162
1163
1164
1165
            # In TP, these weights are partitioned along the column
            # dimension (dim=-1)
            elif isinstance(module, (RowParallelLinear, )):
                self.column_sharded_weights_modules.append(name)

1166
1167
        self.model_type = type(model).__name__

1168
        logger.info("Loading weights with BitsAndBytes quantization. "
1169
                    "May take a while ...")
1170

1171
1172
        quant_config = getattr(model_config.hf_config, "quantization_config",
                               None)
1173
1174
1175

        pre_quant = False
        if quant_config is not None:
1176
            quant_method = quant_config.get("quant_method")
1177
1178
1179
1180
1181
1182
1183
            if quant_method == "bitsandbytes":
                pre_quant = True
            else:
                raise ValueError(
                    f"BitsAndBytes loader does not support {quant_method} "
                    "quantization")

1184
1185
1186
1187
        # The quant_states in pre_quantized models cannot work with a split
        # weight tensor. So TP does not work with pre_quantized bnb models.
        if pre_quant and get_tensor_model_parallel_world_size() > 1:
            raise ValueError(
1188
1189
                "Prequant BitsAndBytes models with tensor parallelism is not "
                "supported. Please try with pipeline parallelism.")
1190

1191
1192
        load_8bit = False
        if pre_quant:
1193
            load_8bit = quant_config.get("load_in_8bit", False)
1194

1195
1196
1197
1198
        qweight_iterator, quant_state_dict = (
            self._get_quantized_weights_iterator(model_config.model,
                                                 model_config.revision,
                                                 pre_quant, load_8bit))
1199

1200
1201
1202
1203
1204
1205
1206
1207
        weights_to_load = {name for name, _ in model.named_parameters()}
        loaded_weights = model.load_weights(qweight_iterator)
        # Some models may have weights loading tracker unimplemented.
        if loaded_weights is not None:
            weights_not_loaded = weights_to_load - loaded_weights
            if weights_not_loaded:
                raise ValueError("Following weights were not initialized from "
                                 f"checkpoint: {weights_not_loaded}")
1208

1209
1210
        torch.cuda.empty_cache()

1211
1212
        param_dict = dict(model.named_parameters())
        stacked_quant_state_dict: Dict[str, Dict[int, Any]] = {}
1213
1214
1215
        # TODO: Change this lazy import to normal import
        # after the checks are updated to run on a new version
        from vllm.model_executor.models.utils import is_pp_missing_parameter
1216

1217
        for quant_param_name in quant_state_dict:
1218
1219
1220
            if is_pp_missing_parameter(quant_param_name, model):
                continue

1221
1222
1223
1224
            non_stacked_param_name = quant_param_name

            shard_index = 0
            for shard_name, (
1225
1226
                    weight_name,
                    index,
1227
            ) in self.modules_mapping.inverse_packed_mapping.items():
1228
1229
1230
                # Some models, such as MiniCPM V2.5/2.6, contain both
                # module names 'kv_proj' and 'qkv_proj'. To prevent 'kv_proj'
                # from being incorrectly identified as being present in
1231
                # 'vpm.encoder.layers.0.self_attn.qkv_proj.weight
1232
                shard_pos = quant_param_name.find(shard_name)
1233
1234
1235
                can_correct_rename = (shard_pos
                                      > 0) and (quant_param_name[shard_pos - 1]
                                                == ".")
1236
1237
1238
1239
1240
1241
1242
                # If the quant_param_name is packed, it won't occur in the
                # param_dict before renaming.
                new_quant_param_name = quant_param_name.replace(
                    shard_name, weight_name)
                need_rename = (quant_param_name not in param_dict) \
                              and (new_quant_param_name in param_dict)
                if can_correct_rename and need_rename:
1243
                    shard_index = index
1244
                    quant_param_name = new_quant_param_name
1245
1246
                    break

1247
1248
            # Models like Clip/Siglip may skip some layers in initialization,
            # causing unused quant_param_name in state_dict.
1249
            if quant_param_name not in param_dict:
1250
                continue
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269

            if quant_param_name not in stacked_quant_state_dict:
                stacked_quant_state_dict[quant_param_name] = {}

            stacked_quant_state_dict[quant_param_name][shard_index] = (
                quant_state_dict[non_stacked_param_name])

        # save quant_states and offsets as the attributes of the parameters
        for param_name, param in param_dict.items():
            if param_name in stacked_quant_state_dict:
                quant_states = stacked_quant_state_dict[param_name]
                set_weight_attrs(param, {"bnb_quant_state": quant_states})

                pack_ratio = getattr(param, "pack_factor", -1)
                if pack_ratio == -1:
                    raise ValueError(
                        f"pack_factor not set for parameter {param_name}.")

                num_elements = [0] * len(quant_states)
1270
                for seq, quant_state in quant_states.items():
1271
1272
                    num_elements[seq] = (math.prod(quant_state.shape) //
                                         pack_ratio)
1273
1274

                offsets = np.concatenate(([0], np.cumsum(num_elements)))
1275
1276
                # Make torch infer_schema happy
                offsets = torch.tensor(offsets).cpu()
1277
1278
                set_weight_attrs(param, {"bnb_shard_offsets": offsets})

1279
1280
1281
1282
                if load_8bit:
                    set_weight_attrs(
                        param, {"matmul_state": [None] * len(quant_states)})

1283
1284
1285
    def download_model(self, model_config: ModelConfig) -> None:
        self._prepare_weights(model_config.model, model_config.revision)

1286
1287
1288
    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config
1289
1290
        with set_default_torch_dtype(model_config.dtype):
            with torch.device(device_config.device):
1291
                model = _initialize_model(vllm_config=vllm_config)
1292
1293
1294
1295
1296
1297

                self._load_weights(model_config, model)

        return model.eval()


1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
class GGUFModelLoader(BaseModelLoader):
    """
    Model loader that can load GGUF files. This is useful for loading models
    that are quantized with GGUF and saved in the GGUF format. This loader
    supports loading both full models and sharded models.
    """

    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)
        if load_config.model_loader_extra_config:
            raise ValueError(f"Model loader extra config is not supported for "
                             f"load format {load_config.load_format}")

    def _prepare_weights(self, model_name_or_path: str):
        if os.path.isfile(model_name_or_path):
            return model_name_or_path
        else:
            raise ValueError(f"{model_name_or_path} is not a file.")

    def _get_gguf_weights_map(self, model_config: ModelConfig):
        """
        GGUF uses this naming convention for their tensors from HF checkpoint:
        `blk.N.BB.weight` and `blk.N.BB.bias`
        where N signifies the block number of a layer, and BB signifies the
        attention/mlp layer components.
        See "Standardized tensor names" in
        https://github.com/ggerganov/ggml/blob/master/docs/gguf.md for details.
        """
        config = model_config.hf_config
        model_type = config.model_type
1328
        gguf_to_hf_name_map = {}
1329
1330
1331
        # hack: ggufs have a different name than transformers
        if model_type == "cohere":
            model_type = "command-r"
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
        if model_type in ("deepseek_v3", "deepseek_v2"):
            model_type = "deepseek2"
            # GGUF layer map assumes that we will have a merged expert weights
            # so we need to map them manually
            for idx in range(config.num_hidden_layers):
                gguf_to_hf_name_map[f"blk.{idx}.exp_probs_b.bias"] = \
                        f"model.layers.{idx}.mlp.gate.e_score_correction_bias"
                gguf_to_hf_name_map[f"blk.{idx}.ffn_down_exps.weight"] = \
                        f"model.layers.{idx}.mlp.experts.0.down_proj.weight"
                gguf_to_hf_name_map[f"blk.{idx}.ffn_gate_exps.weight"] = \
                        f"model.layers.{idx}.mlp.experts.0.gate_proj.weight"
                gguf_to_hf_name_map[f"blk.{idx}.ffn_up_exps.weight"] = \
                        f"model.layers.{idx}.mlp.experts.0.up_proj.weight"

1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
        arch = None
        for key, value in gguf.MODEL_ARCH_NAMES.items():
            if value == model_type:
                arch = key
                break
        if arch is None:
            raise RuntimeError(f"Unknown gguf model_type: {model_type}")
        num_layers = config.num_hidden_layers
        name_map = gguf.get_tensor_name_map(arch, num_layers)
        with torch.device("meta"):
1356
1357
            dummy_model = AutoModelForCausalLM.from_config(
                config, trust_remote_code=model_config.trust_remote_code)
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
        state_dict = dummy_model.state_dict()

        for hf_name in state_dict:
            name, suffix = hf_name.rsplit(".", 1)
            gguf_name = name_map.get_name(name)
            gguf_to_hf_name_map[f"{gguf_name}.{suffix}"] = hf_name
        return gguf_to_hf_name_map

    def _get_weights_iterator(
        self, model_name_or_path: str, gguf_to_hf_name_map: Dict[str, str]
    ) -> Generator[Tuple[str, torch.Tensor], None, None]:
        return gguf_quant_weights_iterator(model_name_or_path,
                                           gguf_to_hf_name_map)

1372
1373
1374
    def download_model(self, model_config: ModelConfig) -> None:
        self._prepare_weights(model_config.model)

1375
1376
1377
    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config
1378
1379
1380
1381
1382
1383
1384
        local_model_path = self._prepare_weights(model_config.model)
        gguf_weights_map = self._get_gguf_weights_map(model_config)
        # we can only know if tie word embeddings after mapping weights
        if "lm_head.weight" in get_gguf_extra_tensor_names(
                local_model_path, gguf_weights_map):
            model_config.hf_config.update({"tie_word_embeddings": True})

1385
        target_device = torch.device(device_config.device)
1386
        with set_default_torch_dtype(model_config.dtype):
1387
            with target_device:
1388
                model = _initialize_model(vllm_config=vllm_config)
1389
1390
            model.load_weights(
                self._get_weights_iterator(local_model_path, gguf_weights_map))
1391
1392

            _process_weights_after_loading(model, model_config, target_device)
1393
1394
1395
        return model


1396
1397
class RunaiModelStreamerLoader(BaseModelLoader):
    """
1398
        Model loader that can load safetensors
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
        files from local FS or S3 bucket.
    """

    def __init__(self, load_config: LoadConfig):
        super().__init__(load_config)
        if load_config.model_loader_extra_config:
            extra_config = load_config.model_loader_extra_config

            if ("concurrency" in extra_config
                    and isinstance(extra_config.get("concurrency"), int)):
                os.environ["RUNAI_STREAMER_CONCURRENCY"] = str(
                    extra_config.get("concurrency"))

            if ("memory_limit" in extra_config
                    and isinstance(extra_config.get("memory_limit"), int)):
                os.environ["RUNAI_STREAMER_MEMORY_LIMIT"] = str(
                    extra_config.get("memory_limit"))

            runai_streamer_s3_endpoint = os.getenv(
                'RUNAI_STREAMER_S3_ENDPOINT')
            aws_endpoint_url = os.getenv('AWS_ENDPOINT_URL')
            if (runai_streamer_s3_endpoint is None
                    and aws_endpoint_url is not None):
                os.environ["RUNAI_STREAMER_S3_ENDPOINT"] = aws_endpoint_url

    def _prepare_weights(self, model_name_or_path: str,
                         revision: Optional[str]) -> List[str]:
        """Prepare weights for the model.

        If the model is not local, it will be downloaded."""
1429

1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
        is_s3_path = is_s3(model_name_or_path)
        is_local = os.path.isdir(model_name_or_path)
        safetensors_pattern = "*.safetensors"
        index_file = SAFE_WEIGHTS_INDEX_NAME

        hf_folder = (model_name_or_path if
                     (is_local or is_s3_path) else download_weights_from_hf(
                         model_name_or_path,
                         self.load_config.download_dir,
                         [safetensors_pattern],
                         revision,
                         ignore_patterns=self.load_config.ignore_patterns,
                     ))
        if is_s3_path:
            hf_weights_files = s3_glob(path=hf_folder,
                                       allow_pattern=[safetensors_pattern])
        else:
            hf_weights_files = glob.glob(
                os.path.join(hf_folder, safetensors_pattern))

        if not is_local and not is_s3_path:
            download_safetensors_index_file_from_hf(
                model_name_or_path, index_file, self.load_config.download_dir,
                revision)

        if not hf_weights_files:
            raise RuntimeError(
                f"Cannot find any safetensors model weights with "
                f"`{model_name_or_path}`")

        return hf_weights_files

    def _get_weights_iterator(
            self, model_or_path: str,
            revision: str) -> Generator[Tuple[str, torch.Tensor], None, None]:
        """Get an iterator for the model weights based on the load format."""
        hf_weights_files = self._prepare_weights(model_or_path, revision)
1467
1468
1469
1470
        return runai_safetensors_weights_iterator(
            hf_weights_files,
            self.load_config.use_tqdm_on_load,
        )
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492

    def download_model(self, model_config: ModelConfig) -> None:
        """Download model if necessary"""
        self._prepare_weights(model_config.model, model_config.revision)

    def load_model(self, vllm_config: VllmConfig) -> nn.Module:
        """Perform streaming of the model to destination"""
        device_config = vllm_config.device_config
        model_config = vllm_config.model_config

        target_device = torch.device(device_config.device)
        with set_default_torch_dtype(model_config.dtype):
            with target_device:
                model = _initialize_model(vllm_config=vllm_config)

            model_weights = model_config.model
            if hasattr(model_config, "model_weights"):
                model_weights = model_config.model_weights
            model.load_weights(
                self._get_weights_iterator(model_weights,
                                           model_config.revision))

1493
            _process_weights_after_loading(model, model_config, target_device)
1494
1495
1496
        return model.eval()


1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
def get_model_loader(load_config: LoadConfig) -> BaseModelLoader:
    """Get a model loader based on the load format."""
    if isinstance(load_config.load_format, type):
        return load_config.load_format(load_config)

    if load_config.load_format == LoadFormat.DUMMY:
        return DummyModelLoader(load_config)

    if load_config.load_format == LoadFormat.TENSORIZER:
        return TensorizerLoader(load_config)

1508
1509
1510
    if load_config.load_format == LoadFormat.SHARDED_STATE:
        return ShardedStateLoader(load_config)

1511
1512
1513
    if load_config.load_format == LoadFormat.BITSANDBYTES:
        return BitsAndBytesModelLoader(load_config)

1514
1515
1516
    if load_config.load_format == LoadFormat.GGUF:
        return GGUFModelLoader(load_config)

1517
1518
1519
    if load_config.load_format == LoadFormat.RUNAI_STREAMER:
        return RunaiModelStreamerLoader(load_config)

1520
    return DefaultModelLoader(load_config)