184 lines
6.7 KiB
Python
184 lines
6.7 KiB
Python
"""
|
|
Automatic transformers version switching.
|
|
|
|
Some newer model architectures (Ministral-3, GLM-4.7-Flash, Qwen3-30B-A3B MoE,
|
|
tiny_qwen3_moe) require transformers>=5.1.0, while everything else needs the
|
|
default 4.57.x that ships with Unsloth.
|
|
|
|
When loading a LoRA adapter with a custom name, we resolve the base model from
|
|
``adapter_config.json`` and check *that* against the model list.
|
|
|
|
This module detects the model being loaded and ensures the correct transformers
|
|
version is installed before proceeding. The pip install is done *without*
|
|
``--force-reinstall`` to avoid rebuilding unrelated dependencies.
|
|
"""
|
|
|
|
import importlib
|
|
import importlib.metadata
|
|
import json
|
|
import logging
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Detection
|
|
# ---------------------------------------------------------------------------
|
|
|
|
# Lowercase substrings — if ANY appears anywhere in the lowered model name,
|
|
# we need transformers 5.x.
|
|
TRANSFORMERS_5_MODEL_SUBSTRINGS: tuple[str, ...] = (
|
|
"ministral-3-", # Ministral-3-{3,8,14}B-{Instruct,Reasoning,Base}-2512
|
|
"glm-4.7-flash", # GLM-4.7-Flash
|
|
"qwen3-30b-a3b", # Qwen3-30B-A3B-Instruct-2507 and variants
|
|
"tiny_qwen3_moe", # imdatta0/tiny_qwen3_moe_2.8B_0.7B
|
|
)
|
|
|
|
# Versions
|
|
TRANSFORMERS_5_VERSION = "5.1.0"
|
|
TRANSFORMERS_DEFAULT_VERSION = "4.57.1"
|
|
|
|
|
|
def _resolve_base_model(model_name: str) -> str:
|
|
"""If *model_name* points to a LoRA adapter, return its base model.
|
|
|
|
Checks for ``adapter_config.json`` locally first (covers the common case of
|
|
local output directories with custom names). Falls back to the existing
|
|
``get_base_model_from_lora`` utility which also handles remote HF LoRAs.
|
|
|
|
Returns the original *model_name* unchanged if it is not a LoRA adapter.
|
|
"""
|
|
# --- Fast local check ---------------------------------------------------
|
|
adapter_cfg_path = Path(model_name) / "adapter_config.json"
|
|
if adapter_cfg_path.is_file():
|
|
try:
|
|
with open(adapter_cfg_path) as f:
|
|
cfg = json.load(f)
|
|
base = cfg.get("base_model_name_or_path")
|
|
if base:
|
|
logger.info(
|
|
"Resolved LoRA adapter '%s' → base model '%s'", model_name, base,
|
|
)
|
|
return base
|
|
except Exception as exc:
|
|
logger.debug("Could not read %s: %s", adapter_cfg_path, exc)
|
|
|
|
# --- Fallback: use the project's existing helper (handles HF repos too) --
|
|
try:
|
|
from utils.models import get_base_model_from_lora
|
|
base = get_base_model_from_lora(model_name)
|
|
if base:
|
|
logger.info(
|
|
"Resolved LoRA adapter '%s' → base model '%s' (via get_base_model_from_lora)",
|
|
model_name, base,
|
|
)
|
|
return base
|
|
except Exception as exc:
|
|
logger.debug("get_base_model_from_lora failed for '%s': %s", model_name, exc)
|
|
|
|
return model_name
|
|
|
|
|
|
def needs_transformers_5(model_name: str) -> bool:
|
|
"""Return True if *model_name* belongs to an architecture that requires
|
|
``transformers>=5.1.0``."""
|
|
lowered = model_name.lower()
|
|
return any(sub in lowered for sub in TRANSFORMERS_5_MODEL_SUBSTRINGS)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Version switching
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _installed_transformers_version() -> str | None:
|
|
"""Return the currently installed transformers version, or None."""
|
|
try:
|
|
return importlib.metadata.version("transformers")
|
|
except importlib.metadata.PackageNotFoundError:
|
|
return None
|
|
|
|
|
|
def _pip_install(package_spec: str) -> None:
|
|
"""Run ``pip install <package_spec>`` using the running interpreter's pip.
|
|
|
|
Mirrors the approach used in ``unsloth_zoo.llama_cpp.check_pip`` —
|
|
``sys.executable -m pip`` is always the safest choice.
|
|
"""
|
|
cmd = [sys.executable, "-m", "pip", "install", package_spec]
|
|
logger.info("Running: %s", " ".join(cmd))
|
|
result = subprocess.run(
|
|
cmd,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT,
|
|
text=True,
|
|
)
|
|
if result.returncode != 0:
|
|
logger.error("pip install failed:\n%s", result.stdout)
|
|
raise RuntimeError(
|
|
f"Failed to install {package_spec}. "
|
|
f"pip output:\n{result.stdout}"
|
|
)
|
|
logger.info("pip install succeeded for %s", package_spec)
|
|
|
|
|
|
def _reload_transformers() -> None:
|
|
"""Invalidate importlib caches and force-reload transformers so the new
|
|
version is visible in the current process."""
|
|
# Clear the metadata cache so importlib.metadata.version() returns the
|
|
# freshly installed version.
|
|
importlib.invalidate_caches()
|
|
|
|
# Remove cached transformers modules so the next import picks up the new
|
|
# package on disk.
|
|
to_remove = [k for k in sys.modules if k == "transformers" or k.startswith("transformers.")]
|
|
for key in to_remove:
|
|
del sys.modules[key]
|
|
|
|
|
|
def ensure_transformers_version(model_name: str) -> None:
|
|
"""Ensure the correct ``transformers`` version is installed for *model_name*.
|
|
|
|
* If the model needs 5.x and the installed version is already 5.x → no-op.
|
|
* If the model needs 5.x but 4.x is installed → ``pip install transformers==5.1.0``.
|
|
* If the model does NOT need 5.x but 5.x is installed → downgrade to 4.57.1.
|
|
* Otherwise → no-op.
|
|
|
|
For LoRA adapters with custom names, the base model is resolved from
|
|
``adapter_config.json`` before checking.
|
|
|
|
Call this at the top of every model-loading code path (training ``/start``,
|
|
inference ``/load``).
|
|
"""
|
|
# Resolve LoRA adapters to their base model for accurate detection
|
|
resolved = _resolve_base_model(model_name)
|
|
want_5 = needs_transformers_5(resolved)
|
|
current = _installed_transformers_version()
|
|
|
|
if current is None:
|
|
logger.warning("transformers is not installed — skipping version check")
|
|
return
|
|
|
|
current_major = int(current.split(".")[0])
|
|
target_version = TRANSFORMERS_5_VERSION if want_5 else TRANSFORMERS_DEFAULT_VERSION
|
|
target_major = int(target_version.split(".")[0])
|
|
|
|
if current_major == target_major:
|
|
logger.debug(
|
|
"transformers %s already satisfies requirement (need major=%d) for model '%s'",
|
|
current, target_major, model_name,
|
|
)
|
|
return
|
|
|
|
logger.info(
|
|
"Model '%s' requires transformers %s but %s is installed — switching…",
|
|
model_name, target_version, current,
|
|
)
|
|
|
|
_pip_install(f"transformers=={target_version}")
|
|
_reload_transformers()
|
|
|
|
new_version = _installed_transformers_version()
|
|
logger.info("Transformers version is now %s", new_version)
|