# Copyright Lightning AI. Licensed under the Apache License 2.0, see LICENSE file. """This script merges the LoRA weights with the base model""" from pathlib import Path from pprint import pprint from typing import Any, Dict, Optional, Tuple import lightning as L import torch import yaml from litgpt.lora import GPT, Config, lora_filter, merge_lora_weights from litgpt.utils import check_valid_checkpoint_dir, extend_checkpoint_dir def merge_lora( checkpoint_dir: Path, pretrained_checkpoint_dir: Optional[Path] = None, precision: Optional[str] = None ) -> None: """Merges the LoRA weights with the base model. See ``litgpt finetune lora``. Creates a new ``lit_model.pth`` file by merging the LoRA weights (``lit_model.pth.lora``) with the original checkpoint weights. Arguments: checkpoint_dir: Path to the checkpoint directory with trained LoRA weights, which is the output of ``litgpt finetune lora``. pretrained_checkpoint_dir: Optional path to the checkpoint directory with the weights of the base model corresponding to the LoRA checkpoint. By default, this will automatically be inferred from the metadata in the given `checkpoint_dir` directory. Only set this if the base model's checkpoint directory has moved or was renamed. precision: Optional precision setting to instantiate the model weights in. By default, this will automatically be inferred from the metadata in the given ``checkpoint_dir`` directory. """ checkpoint_dir = extend_checkpoint_dir(checkpoint_dir) if pretrained_checkpoint_dir is not None: pretrained_checkpoint_dir = extend_checkpoint_dir(pretrained_checkpoint_dir) pprint(locals()) check_valid_checkpoint_dir(checkpoint_dir, model_filename="lit_model.pth.lora") if pretrained_checkpoint_dir is not None: check_valid_checkpoint_dir(pretrained_checkpoint_dir) if (checkpoint_dir / "lit_model.pth").is_file(): print("LoRA weights have already been merged in this checkpoint.") return lora_params, meta_pretrained_checkpoint_dir, lora_precision = load_lora_metadata(checkpoint_dir) precision = precision if precision is not None else lora_precision if pretrained_checkpoint_dir is None: pretrained_checkpoint_dir = meta_pretrained_checkpoint_dir pretrained_checkpoint_dir = extend_checkpoint_dir(pretrained_checkpoint_dir) fabric = L.Fabric(devices=1, precision=precision, accelerator="cpu") config = Config.from_file(checkpoint_dir / "model_config.yaml", **lora_params) with fabric.init_module(), torch.device("meta"): model = GPT(config) # we don't care about these to perform merging model.cos = None model.sin = None lora_path = checkpoint_dir / "lit_model.pth.lora" pretrained_checkpoint = torch.load(str(pretrained_checkpoint_dir / "lit_model.pth"), mmap=True) lora_checkpoint = torch.load(str(lora_path), mmap=True) lora_checkpoint = lora_checkpoint.get("model", lora_checkpoint) # Merge LoRA weights into the base model pretrained_checkpoint.update(lora_checkpoint) model.load_state_dict(pretrained_checkpoint, assign=True) # since LoRA finetuning only saves the LoRA weights, we treat the lora weights dtype as the expected dtype lora_dtype = next(iter(lora_checkpoint.values())).dtype model.to(dtype=lora_dtype, device="cpu") merge_lora_weights(model) # Remove LoRA parameters and the LoRA linear substring state_dict = {k.replace("linear.", ""): v for k, v in model.state_dict().items() if not lora_filter(k, v)} save_path = checkpoint_dir / "lit_model.pth" torch.save(state_dict, save_path) fabric.print(f"Saved merged weights to {str(checkpoint_dir / 'lit_model.pth')!r}") def load_lora_metadata(checkpoint_dir: Path) -> Tuple[Dict[str, Any], Path, Optional[str]]: hparams_file = checkpoint_dir / "hyperparameters.yaml" if not hparams_file.is_file(): raise FileNotFoundError( f"The path {str(hparams_file)!r} is not a valid checkpoint directory. It is missing a" f" `hyperparameters.yaml` file. Please point to the checkpoint directory that was produced by" f" the `litgpt/finetune/lora.py` script." ) with open(hparams_file, encoding="utf-8") as file: hparams = yaml.safe_load(file) lora_params = {k: v for k, v in hparams.items() if k.startswith("lora_")} pretrained_checkpoint_dir = Path(hparams["checkpoint_dir"]) precision = hparams.get("precision") return lora_params, pretrained_checkpoint_dir, precision