soup/soup_cli/commands/export.py

349 lines
11 KiB
Python

"""soup export — convert a model to GGUF format for Ollama / llama.cpp."""
import json
import shutil
import subprocess
import sys
from pathlib import Path
from typing import Optional
import typer
from rich.console import Console
from rich.panel import Panel
console = Console()
SUPPORTED_FORMATS = ("gguf",)
GGUF_QUANT_TYPES = ("q4_0", "q4_k_m", "q5_k_m", "q8_0", "f16", "f32")
LLAMA_CPP_DIR_NAME = "llama.cpp"
# Pin to a known release tag for supply-chain safety
LLAMA_CPP_TAG = "b5270"
def export(
model: str = typer.Option(
...,
"--model",
"-m",
help="Path to model directory (full model or LoRA adapter)",
),
fmt: str = typer.Option(
"gguf",
"--format",
"-f",
help="Export format: gguf",
),
quant: str = typer.Option(
"q4_k_m",
"--quant",
"-q",
help="Quantization type: q4_0, q4_k_m, q5_k_m, q8_0, f16, f32",
),
output: Optional[str] = typer.Option(
None,
"--output",
"-o",
help="Output file path. Default: <model-name>.<quant>.gguf",
),
base: Optional[str] = typer.Option(
None,
"--base",
"-b",
help="Base model ID (for LoRA adapters). Auto-detected if not set.",
),
llama_cpp_path: Optional[str] = typer.Option(
None,
"--llama-cpp",
help="Path to llama.cpp directory. Auto-detected or cloned to ~/.soup/llama.cpp",
),
):
"""Export a model to GGUF format for use with Ollama / llama.cpp."""
model_path = Path(model)
# --- Validate ---
if not model_path.exists():
console.print(f"[red]Model path not found: {model_path}[/]")
raise typer.Exit(1)
if fmt not in SUPPORTED_FORMATS:
console.print(
f"[red]Unsupported format: {fmt}[/]\n"
f"Supported: {', '.join(SUPPORTED_FORMATS)}"
)
raise typer.Exit(1)
if quant not in GGUF_QUANT_TYPES:
console.print(
f"[red]Unsupported quantization: {quant}[/]\n"
f"Supported: {', '.join(GGUF_QUANT_TYPES)}"
)
raise typer.Exit(1)
# --- Check if LoRA adapter (needs merge first) ---
adapter_config_path = model_path / "adapter_config.json"
is_adapter = adapter_config_path.exists()
merge_dir = None
if is_adapter:
console.print("[yellow]LoRA adapter detected - merging with base model first...[/]")
base_model = base or _detect_base_model(adapter_config_path)
if not base_model:
console.print(
"[red]Cannot detect base model from adapter_config.json.[/]\n"
"Please specify with [bold]--base[/] flag."
)
raise typer.Exit(1)
merge_dir = model_path.parent / f".soup_merge_tmp_{model_path.name}"
_merge_adapter(str(model_path), base_model, str(merge_dir))
model_path = merge_dir
# --- Find llama.cpp ---
llama_dir = _find_llama_cpp(llama_cpp_path)
# --- Convert to GGUF ---
model_name = Path(model).name
if output:
output_path = Path(output)
else:
output_path = Path(model).parent / f"{model_name}.{quant}.gguf"
console.print(
Panel(
f"Model: [bold]{model_path}[/]\n"
f"Format: [bold]{fmt}[/]\n"
f"Quant: [bold]{quant}[/]\n"
f"Output: [bold]{output_path}[/]",
title="Export Plan",
)
)
try:
# Step 1: Convert HF model to GGUF (f16)
convert_script = llama_dir / "convert_hf_to_gguf.py"
if not convert_script.exists():
console.print(
f"[red]convert_hf_to_gguf.py not found in {llama_dir}[/]\n"
"Make sure llama.cpp is properly cloned."
)
raise typer.Exit(1)
if quant in ("f16", "f32"):
# Direct conversion without quantization
outtype = "f16" if quant == "f16" else "f32"
console.print(f"[dim]Converting to GGUF ({outtype})...[/]")
_run_convert(convert_script, model_path, output_path, outtype)
else:
# Convert to f16 first, then quantize
f16_path = output_path.parent / f"{model_name}.f16.gguf"
console.print("[dim]Converting to GGUF (f16)...[/]")
_run_convert(convert_script, model_path, f16_path, "f16")
# Quantize
console.print(f"[dim]Quantizing to {quant}...[/]")
_run_quantize(llama_dir, f16_path, output_path, quant)
# Clean up intermediate f16 file
if f16_path.exists() and f16_path != output_path:
f16_path.unlink()
finally:
# Clean up temporary merge directory
if merge_dir and merge_dir.exists():
console.print("[dim]Cleaning up temporary merge files...[/]")
shutil.rmtree(merge_dir, ignore_errors=True)
if not output_path.exists():
console.print("[red]Export failed - output file not created.[/]")
raise typer.Exit(1)
file_size = output_path.stat().st_size
size_str = _format_size(file_size)
console.print(
Panel(
f"Output: [bold]{output_path}[/]\n"
f"Size: [bold]{size_str}[/]\n"
f"Quant: [bold]{quant}[/]\n\n"
f"Use with Ollama:\n"
f" 1. Create a Modelfile:\n"
f" [bold]echo 'FROM {output_path}' > Modelfile[/]\n"
f" 2. Create the model:\n"
f" [bold]ollama create {model_name} -f Modelfile[/]\n"
f" 3. Run it:\n"
f" [bold]ollama run {model_name}[/]",
title="[bold green]Export Complete![/]",
)
)
def _detect_base_model(adapter_config_path: Path) -> Optional[str]:
"""Read base_model_name_or_path from adapter_config.json."""
try:
with open(adapter_config_path, encoding="utf-8") as f:
config = json.load(f)
return config.get("base_model_name_or_path")
except (json.JSONDecodeError, OSError):
return None
def _merge_adapter(adapter_path: str, base_model: str, output_dir: str):
"""Merge LoRA adapter with base model."""
import torch
from peft import PeftModel
from transformers import AutoModelForCausalLM, AutoTokenizer
console.print(f"[dim]Loading base model: {base_model}...[/]")
model = AutoModelForCausalLM.from_pretrained(
base_model,
dtype=torch.float16,
trust_remote_code=True,
device_map="cpu",
)
console.print(f"[dim]Loading LoRA adapter: {adapter_path}...[/]")
model = PeftModel.from_pretrained(model, adapter_path)
console.print("[dim]Merging weights...[/]")
model = model.merge_and_unload()
out = Path(output_dir)
out.mkdir(parents=True, exist_ok=True)
model.save_pretrained(str(out))
tokenizer = AutoTokenizer.from_pretrained(adapter_path, trust_remote_code=True)
tokenizer.save_pretrained(str(out))
console.print("[green]Adapter merged successfully.[/]")
def _find_llama_cpp(user_path: Optional[str] = None) -> Path:
"""Find or clone llama.cpp directory."""
from soup_cli.utils.constants import SOUP_DIR
# 1. User-specified path
if user_path:
path = Path(user_path)
if path.exists():
return path
console.print(f"[red]llama.cpp not found at: {path}[/]")
raise typer.Exit(1)
# 2. LLAMA_CPP_PATH env var
import os
env_path = os.environ.get("LLAMA_CPP_PATH")
if env_path:
path = Path(env_path)
if path.exists():
return path
# 3. Check ~/.soup/llama.cpp
soup_llama = Path(SOUP_DIR) / LLAMA_CPP_DIR_NAME
if soup_llama.exists() and (soup_llama / "convert_hf_to_gguf.py").exists():
return soup_llama
# 4. Auto-clone
console.print("[yellow]llama.cpp not found. Cloning to ~/.soup/llama.cpp...[/]")
console.print("[dim]This is a one-time setup for GGUF export.[/]")
try:
subprocess.run(
["git", "clone", "--depth", "1", "--branch", LLAMA_CPP_TAG,
"https://github.com/ggerganov/llama.cpp.git", str(soup_llama)],
check=True,
capture_output=True,
text=True,
)
# Install Python requirements for the convert script
requirements = soup_llama / "requirements.txt"
if requirements.exists():
subprocess.run(
[sys.executable, "-m", "pip", "install", "-r", str(requirements), "-q"],
check=True,
capture_output=True,
text=True,
)
console.print("[green]llama.cpp cloned successfully.[/]")
return soup_llama
except subprocess.CalledProcessError as exc:
console.print(f"[red]Failed to clone llama.cpp: {exc.stderr}[/]")
console.print(
"Please clone manually:\n"
f" [bold]git clone https://github.com/ggerganov/llama.cpp.git {soup_llama}[/]\n"
"Or specify path: [bold]--llama-cpp /path/to/llama.cpp[/]"
)
raise typer.Exit(1)
except FileNotFoundError:
console.print(
"[red]git not found.[/] Please install git or clone llama.cpp manually:\n"
f" [bold]git clone https://github.com/ggerganov/llama.cpp.git {soup_llama}[/]"
)
raise typer.Exit(1)
def _run_convert(script: Path, model_dir: Path, output_path: Path, outtype: str):
"""Run llama.cpp convert_hf_to_gguf.py script."""
output_path.parent.mkdir(parents=True, exist_ok=True)
cmd = [
sys.executable, str(script),
str(model_dir),
"--outfile", str(output_path),
"--outtype", outtype,
]
result = subprocess.run(cmd, capture_output=True, text=True)
if result.returncode != 0:
console.print(f"[red]Conversion failed:[/]\n{result.stderr}")
raise typer.Exit(1)
def _run_quantize(llama_dir: Path, input_path: Path, output_path: Path, quant_type: str):
"""Run llama-quantize (or llama.cpp/build/bin/llama-quantize)."""
# Try to find the quantize binary
quantize_bin = _find_quantize_binary(llama_dir)
if not quantize_bin:
console.print(
"[red]llama-quantize binary not found.[/]\n"
"Build llama.cpp first:\n"
f" [bold]cd {llama_dir} && make llama-quantize[/]\n"
"Or use [bold]--quant f16[/] to skip quantization."
)
raise typer.Exit(1)
cmd = [str(quantize_bin), str(input_path), str(output_path), quant_type.upper()]
result = subprocess.run(cmd, capture_output=True, text=True)
if result.returncode != 0:
console.print(f"[red]Quantization failed:[/]\n{result.stderr}")
raise typer.Exit(1)
def _find_quantize_binary(llama_dir: Path) -> Optional[Path]:
"""Find the llama-quantize binary."""
# Check common locations
candidates = [
llama_dir / "build" / "bin" / "llama-quantize",
llama_dir / "build" / "bin" / "llama-quantize.exe",
llama_dir / "llama-quantize",
llama_dir / "llama-quantize.exe",
llama_dir / "build" / "llama-quantize",
]
for candidate in candidates:
if candidate.exists():
return candidate
# Check if it's in PATH
which_result = shutil.which("llama-quantize")
if which_result:
return Path(which_result)
return None
def _format_size(size_bytes: int) -> str:
"""Format bytes into human-readable string."""
for unit in ("B", "KB", "MB", "GB"):
if size_bytes < 1024:
return f"{size_bytes:.1f} {unit}"
size_bytes /= 1024
return f"{size_bytes:.1f} TB"