Provide an initial support to FP8 computation. This PR is inspired by HuggingFace TGI: huggingface/text-generation-inference#1726 This feature can be enabled with --quantization fp8 or -q fp8 when launching an engine. Algorithm: We still load a model checkpoint in FP16/BF16. After the weights are loaded, Fp8LinearMethod calculates the per-tensor scaling factor of weights and quantizes the weights accordingly. The scaling factor will then be stored for future use. Meanwhile, the per-tensor scaling factor for activations is calculated in every forward pass. Initial Results: Currently tested Mistral-7B on 1xH100. With prompt length ~5 and decoding length 128: BF16: 1.47s FP8: 1.66s I'll try to use larger models and try to find more performance bottleneck. Meanwhile, you're welcome to try this code.
364 lines
13 KiB
Python
364 lines
13 KiB
Python
"""Utilities for downloading and initializing model weights."""
|
|
import fnmatch
|
|
import glob
|
|
import hashlib
|
|
import json
|
|
import os
|
|
import tempfile
|
|
from collections import defaultdict
|
|
from typing import Any, Generator, Iterable, List, Optional, Tuple
|
|
|
|
import filelock
|
|
import huggingface_hub.constants
|
|
import numpy as np
|
|
import torch
|
|
from huggingface_hub import HfFileSystem, snapshot_download
|
|
from safetensors.torch import load_file, safe_open, save_file
|
|
from tqdm.auto import tqdm
|
|
|
|
from vllm.config import LoadConfig, ModelConfig
|
|
from vllm.logger import init_logger
|
|
from vllm.model_executor.layers.quantization import (QuantizationConfig,
|
|
get_quantization_config)
|
|
from vllm.model_executor.layers.quantization.schema import QuantParamSchema
|
|
|
|
logger = init_logger(__name__)
|
|
|
|
# use system-level temp directory for file locks, so that multiple users
|
|
# can share the same lock without error.
|
|
# lock files in the temp directory will be automatically deleted when the
|
|
# system reboots, so users will not complain about annoying lock files
|
|
temp_dir = tempfile.gettempdir()
|
|
|
|
|
|
def enable_hf_transfer():
|
|
"""automatically activates hf_transfer
|
|
"""
|
|
if "HF_HUB_ENABLE_HF_TRANSFER" not in os.environ:
|
|
try:
|
|
# enable hf hub transfer if available
|
|
import hf_transfer # type: ignore # noqa
|
|
huggingface_hub.constants.HF_HUB_ENABLE_HF_TRANSFER = True
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
enable_hf_transfer()
|
|
|
|
|
|
class DisabledTqdm(tqdm):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs, disable=True)
|
|
|
|
|
|
def get_lock(model_name_or_path: str, cache_dir: Optional[str] = None):
|
|
lock_dir = cache_dir or temp_dir
|
|
os.makedirs(os.path.dirname(lock_dir), exist_ok=True)
|
|
model_name = model_name_or_path.replace("/", "-")
|
|
hash_name = hashlib.sha256(model_name.encode()).hexdigest()
|
|
# add hash to avoid conflict with old users' lock files
|
|
lock_file_name = hash_name + model_name + ".lock"
|
|
# mode 0o666 is required for the filelock to be shared across users
|
|
lock = filelock.FileLock(os.path.join(lock_dir, lock_file_name),
|
|
mode=0o666)
|
|
return lock
|
|
|
|
|
|
def _shared_pointers(tensors):
|
|
ptrs = defaultdict(list)
|
|
for k, v in tensors.items():
|
|
ptrs[v.data_ptr()].append(k)
|
|
failing = []
|
|
for _, names in ptrs.items():
|
|
if len(names) > 1:
|
|
failing.append(names)
|
|
return failing
|
|
|
|
|
|
def convert_bin_to_safetensor_file(
|
|
pt_filename: str,
|
|
sf_filename: str,
|
|
) -> None:
|
|
loaded = torch.load(pt_filename, map_location="cpu")
|
|
if "state_dict" in loaded:
|
|
loaded = loaded["state_dict"]
|
|
shared = _shared_pointers(loaded)
|
|
for shared_weights in shared:
|
|
for name in shared_weights[1:]:
|
|
loaded.pop(name)
|
|
|
|
# For tensors to be contiguous
|
|
loaded = {k: v.contiguous() for k, v in loaded.items()}
|
|
|
|
dirname = os.path.dirname(sf_filename)
|
|
os.makedirs(dirname, exist_ok=True)
|
|
save_file(loaded, sf_filename, metadata={"format": "pt"})
|
|
|
|
# check file size
|
|
sf_size = os.stat(sf_filename).st_size
|
|
pt_size = os.stat(pt_filename).st_size
|
|
if (sf_size - pt_size) / pt_size > 0.01:
|
|
raise RuntimeError(f"""The file size different is more than 1%:
|
|
- {sf_filename}: {sf_size}
|
|
- {pt_filename}: {pt_size}
|
|
""")
|
|
|
|
# check if the tensors are the same
|
|
reloaded = load_file(sf_filename)
|
|
for k in loaded:
|
|
pt_tensor = loaded[k]
|
|
sf_tensor = reloaded[k]
|
|
if not torch.equal(pt_tensor, sf_tensor):
|
|
raise RuntimeError(f"The output tensors do not match for key {k}")
|
|
|
|
|
|
# TODO(woosuk): Move this to other place.
|
|
def get_quant_config(model_config: ModelConfig,
|
|
load_config: LoadConfig) -> QuantizationConfig:
|
|
quant_cls = get_quantization_config(model_config.quantization)
|
|
# Read the quantization config from the HF model config, if available.
|
|
hf_quant_config = getattr(model_config.hf_config, "quantization_config",
|
|
None)
|
|
if hf_quant_config is not None:
|
|
return quant_cls.from_config(hf_quant_config)
|
|
model_name_or_path = model_config.model
|
|
is_local = os.path.isdir(model_name_or_path)
|
|
if not is_local:
|
|
# Download the config files.
|
|
with get_lock(model_name_or_path, load_config.download_dir):
|
|
hf_folder = snapshot_download(model_name_or_path,
|
|
revision=model_config.revision,
|
|
allow_patterns="*.json",
|
|
cache_dir=load_config.download_dir,
|
|
tqdm_class=DisabledTqdm)
|
|
else:
|
|
hf_folder = model_name_or_path
|
|
|
|
possible_config_filenames = quant_cls.get_config_filenames()
|
|
|
|
# If the quantization config is not found, use the default config.
|
|
if not possible_config_filenames:
|
|
return quant_cls()
|
|
|
|
config_files = glob.glob(os.path.join(hf_folder, "*.json"))
|
|
|
|
quant_config_files = [
|
|
f for f in config_files if any(
|
|
f.endswith(x) for x in possible_config_filenames)
|
|
]
|
|
if len(quant_config_files) == 0:
|
|
raise ValueError(
|
|
f"Cannot find the config file for {model_config.quantization}")
|
|
if len(quant_config_files) > 1:
|
|
raise ValueError(
|
|
f"Found multiple config files for {model_config.quantization}: "
|
|
f"{quant_config_files}")
|
|
|
|
quant_config_file = quant_config_files[0]
|
|
with open(quant_config_file, "r") as f:
|
|
config = json.load(f)
|
|
return quant_cls.from_config(config)
|
|
|
|
|
|
def download_weights_from_hf(model_name_or_path: str,
|
|
cache_dir: Optional[str],
|
|
allow_patterns: List[str],
|
|
revision: Optional[str] = None) -> str:
|
|
"""Download model weights from Hugging Face Hub.
|
|
|
|
Args:
|
|
model_name_or_path (str): The model name or path.
|
|
cache_dir (Optional[str]): The cache directory to store the model
|
|
weights. If None, will use HF defaults.
|
|
allow_patterns (List[str]): The allowed patterns for the
|
|
weight files. Files matched by any of the patterns will be
|
|
downloaded.
|
|
revision (Optional[str]): The revision of the model.
|
|
|
|
Returns:
|
|
str: The path to the downloaded model weights.
|
|
"""
|
|
# Before we download we look at that is available:
|
|
fs = HfFileSystem()
|
|
file_list = fs.ls(model_name_or_path, detail=False, revision=revision)
|
|
|
|
# depending on what is available we download different things
|
|
for pattern in allow_patterns:
|
|
matching = fnmatch.filter(file_list, pattern)
|
|
if len(matching) > 0:
|
|
allow_patterns = [pattern]
|
|
break
|
|
|
|
logger.info(f"Using model weights format {allow_patterns}")
|
|
# Use file lock to prevent multiple processes from
|
|
# downloading the same model weights at the same time.
|
|
with get_lock(model_name_or_path, cache_dir):
|
|
hf_folder = snapshot_download(model_name_or_path,
|
|
allow_patterns=allow_patterns,
|
|
cache_dir=cache_dir,
|
|
tqdm_class=DisabledTqdm,
|
|
revision=revision)
|
|
return hf_folder
|
|
|
|
|
|
def filter_files_not_needed_for_inference(
|
|
hf_weights_files: List[str]) -> List[str]:
|
|
"""
|
|
Exclude files that are not needed for inference.
|
|
|
|
See https://github.com/huggingface/transformers/blob/v4.34.0/src/transformers/trainer.py#L227-L233
|
|
"""
|
|
blacklist = [
|
|
"training_args.bin",
|
|
"optimizer.bin",
|
|
"optimizer.pt",
|
|
"scheduler.pt",
|
|
"scaler.pt",
|
|
]
|
|
hf_weights_files = [
|
|
f for f in hf_weights_files
|
|
if not any(f.endswith(x) for x in blacklist)
|
|
]
|
|
return hf_weights_files
|
|
|
|
|
|
def np_cache_weights_iterator(
|
|
model_name_or_path: str, cache_dir: Optional[str], hf_folder: str,
|
|
hf_weights_files: List[str]
|
|
) -> Generator[Tuple[str, torch.Tensor], None, None]:
|
|
"""Iterate over the weights in the model np files.
|
|
|
|
Will dump the model weights to numpy files if they are not already dumped.
|
|
"""
|
|
# Convert the model weights from torch tensors to numpy arrays for
|
|
# faster loading.
|
|
np_folder = os.path.join(hf_folder, "np")
|
|
os.makedirs(np_folder, exist_ok=True)
|
|
weight_names_file = os.path.join(np_folder, "weight_names.json")
|
|
# Use file lock to prevent multiple processes from
|
|
# dumping the same model weights to numpy at the same time.
|
|
with get_lock(model_name_or_path, cache_dir):
|
|
if not os.path.exists(weight_names_file):
|
|
weight_names = []
|
|
for bin_file in hf_weights_files:
|
|
state = torch.load(bin_file, map_location="cpu")
|
|
for name, param in state.items():
|
|
param_path = os.path.join(np_folder, name)
|
|
with open(param_path, "wb") as f:
|
|
np.save(f, param.cpu().detach().numpy())
|
|
weight_names.append(name)
|
|
with open(weight_names_file, "w") as f:
|
|
json.dump(weight_names, f)
|
|
|
|
with open(weight_names_file, "r") as f:
|
|
weight_names = json.load(f)
|
|
|
|
for name in weight_names:
|
|
param_path = os.path.join(np_folder, name)
|
|
with open(param_path, "rb") as f:
|
|
param = np.load(f)
|
|
yield name, torch.from_numpy(param)
|
|
|
|
|
|
def safetensors_weights_iterator(
|
|
hf_weights_files: List[str]
|
|
) -> Generator[Tuple[str, torch.Tensor], None, None]:
|
|
"""Iterate over the weights in the model safetensor files."""
|
|
for st_file in hf_weights_files:
|
|
with safe_open(st_file, framework="pt") as f:
|
|
for name in f.keys(): # noqa: SIM118
|
|
param = f.get_tensor(name)
|
|
yield name, param
|
|
|
|
|
|
def pt_weights_iterator(
|
|
hf_weights_files: List[str]
|
|
) -> Generator[Tuple[str, torch.Tensor], None, None]:
|
|
"""Iterate over the weights in the model bin/pt files."""
|
|
for bin_file in hf_weights_files:
|
|
state = torch.load(bin_file, map_location="cpu")
|
|
for name, param in state.items():
|
|
yield name, param
|
|
del state
|
|
torch.cuda.empty_cache()
|
|
|
|
|
|
def kv_cache_scales_loader(
|
|
filename: str, tp_rank: int, tp_size: int, num_hidden_layers: int,
|
|
model_type: Optional[str]) -> Iterable[Tuple[int, float]]:
|
|
"""
|
|
A simple utility to read in KV cache scaling factors that have been
|
|
previously serialized to disk. Used by the model to populate the appropriate
|
|
KV cache scaling factors. The serialization should represent a dictionary
|
|
whose keys are the TP ranks and values are another dictionary mapping layers
|
|
to their KV cache scaling factors.
|
|
Keep this function in sync with the output of examples/fp8/extract_scales.py
|
|
"""
|
|
try:
|
|
with open(filename) as f:
|
|
context = {
|
|
"model_type": model_type,
|
|
"num_hidden_layers": num_hidden_layers,
|
|
"tp_rank": tp_rank,
|
|
"tp_size": tp_size,
|
|
}
|
|
schema_dct = json.load(f)
|
|
schema = QuantParamSchema.model_validate(schema_dct,
|
|
context=context)
|
|
layer_scales_map = schema.kv_cache.scaling_factor[tp_rank]
|
|
return layer_scales_map.items()
|
|
|
|
except FileNotFoundError:
|
|
logger.error(f"File or directory '{filename}' not found.")
|
|
except json.JSONDecodeError:
|
|
logger.error(f"Error decoding JSON in file '{filename}'.")
|
|
except Exception as e:
|
|
logger.error(f"An error occurred while reading '{filename}': {e}")
|
|
# This section is reached if and only if any of the excepts are hit
|
|
# Return an empty iterable (list) => no KV cache scales are loaded
|
|
# which ultimately defaults to 1.0 scales
|
|
logger.warning("Defaulting to KV cache scaling factors = 1.0 "
|
|
f"for all layers in TP rank {tp_rank} "
|
|
"as an error occurred during loading.")
|
|
return []
|
|
|
|
|
|
def convert_pyslice_to_tensor(x: Any) -> torch.Tensor:
|
|
"""convert PySafeSlice object from safetensors to torch.Tensor
|
|
|
|
PySafeSlice object supports indexing, which is done before loading the
|
|
actual tensor and can reduce the amount of memory being read into the
|
|
memory. However, it does not support more advanced functionalities
|
|
like `.view()` or `.t()`. Therefore, if we need to modify the loaded
|
|
tensor with these more complicated operators, we need to convert to
|
|
tensor first.
|
|
"""
|
|
if not isinstance(x, torch.Tensor):
|
|
x = x[:]
|
|
return x
|
|
|
|
|
|
def default_weight_loader(param: torch.Tensor,
|
|
loaded_weight: torch.Tensor) -> None:
|
|
"""Default weight loader."""
|
|
assert param.size() == loaded_weight.size()
|
|
param.data.copy_(loaded_weight)
|
|
|
|
|
|
def initialize_dummy_weights(
|
|
model: torch.nn.Module,
|
|
low: float = -1e-3,
|
|
high: float = 1e-3,
|
|
) -> None:
|
|
"""Initialize model weights with random values.
|
|
|
|
The model weights must be randomly initialized for accurate performance
|
|
measurements. Additionally, the model weights should not cause NaNs in the
|
|
forward pass. We empirically found that initializing the weights with
|
|
values between -1e-3 and 1e-3 works well for most models.
|
|
"""
|
|
for param in model.state_dict().values():
|
|
if torch.is_floating_point(param):
|
|
param.data.uniform_(low, high)
|