unsloth/studio/backend/utils/transformers_latest.py
Daniel Han d50f49e105
Ask for the transformers a training model needs, before the run starts (#8721)
* Ask for the transformers a training model needs, before the run starts

Muse Glimmer needs a transformers release no installed version ships. Chat
already handles this: /validate reports requires_transformers_upgrade, and the
composer offers to install the latest sidecar before loading. Training never
asked. Starting a Muse Glimmer run went straight to the loader and died there
with an architecture the installed transformers does not know.

Training now runs the same consent step chat does, before the custom code gate,
because installing a newer transformers changes what the load would run.

Two things the Configure preview got wrong and now discloses:

- A model no installed transformers ships reads as ready to train. It is not;
  the run stops on a consent dialog first.
- The latest sidecar loads 16-bit only, so a run that installs it cannot honour
  a 4-bit request. A "QLoRA, 4-bit" preview understated VRAM by roughly
  threefold. The preview now says 4-bit is unavailable for that model.

/validate grows forces_16bit so the frontend does not have to re-derive the
sidecar's rule, and resume runs go through the same gate as fresh ones.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Ask the upgrade gate about the model the run actually loads

Three things the gate got wrong.

A resume can be attested against a 4-bit model load that the latest sidecar
permanently refuses: effective_training_load_in_4bit raises
ExactResumeResourcesUnavailable for it the moment latest_tier_active_for turns
true, and that sidecar is a persistent overlay. Accepting Install from the new
resume gate therefore stranded a checkpoint that would otherwise have resumed.
The stored config cannot say so on its own (_sanitize_db_config strips
require_exact_resume_resources and require_exact_model_resource before the row
is written), so the resume names its run on /transformers-upgrade-check and the
backend recomputes the requirement from the provenance marker. With a
custom-code fallback the resume loads on the current runtime in the 4-bit mode
it needs, so no install is offered; without one the install is the only way the
run starts at all, and the dialog is raised as before.

The check was handed the Hub identifier for a cached model while the
remote-code gate and the worker both open the pinned snapshot, so a repo whose
current config.json names a different architecture than the snapshot on disk
was inspected instead of the model being loaded. The check now takes the same
four cache-pin fields as /models/remote-code-scan and resolves them by that
route's precedence, and each start path resolves the pin once for both gates.

A merely offered upgrade no longer claims 16-bit when the model can load
through its own repo code: the dialog offers that way out, taking it installs
nothing, and the run loads bnb 4-bit. /validate already exempts this case.

* Answer the upgrade gate for the load the run really performs

Three follow-ups on the training transformers-upgrade preflight.

Resolve a LoRA's base from the load target, not the Hub identifier. The
worker reads the base out of the adapter config it opens, and so does the
scan route; this route still read the repo's current one, so a pin taken
before the repo repointed base_model_name_or_path had the upgrade,
custom-code and precision answers describing a base the run never loads.

Stop offering an install that cannot rescue an exact 4-bit resume. Once the
sidecar is active, effective_training_load_in_4bit raises for exactly the
config the backend answered install_breaks_exact_resume with, so the resume
fails with or without the install and consent buys only a persistent overlay
that also retires 4-bit for later runs on that model. The start is now
refused with the reason instead. A model with custom code keeps the way out
it had.

Re-ask the Configure preview after an install. The notice cache outlived the
sidecar it described, so returning to Configure in the same session kept
offering a release that was already installed and kept previewing 4-bit for
a run the new overlay loads in 16-bit. The dialog store now counts completed
installs and the cache keys on that count.

Declining a dev-only upgrade no longer says to start the run again to
install it: that dialog has no install action, so the instruction could
never be carried out.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Let the test project see the ambient globals it now reaches

The training upgrade gate hands the chat feature a dynamic import, so the
tests that drive the gate pull src/features/chat into the test project for
the first time, and with it the Web Speech dictation adapter. That adapter
relies on the ambient declarations in src/speech-recognition.d.ts, which
nothing imports, so "include": ["tests"] never reached them and the
Typecheck step failed with five Cannot find name errors in a file this
branch does not touch. The app project only avoids it by including all of
src. Add the ambient declarations to the test project's include.

* Pin an implicit cache selection, and carry the custom-code verdict

Two more follow-ups on the training upgrade preflight.

Take the cache pin whenever prefer_local_cache is set, not only when a path
came with it. A cached inventory row can carry a null cachePath, and the Train
tab still sends the flag for it, so _resolve_model_snapshot has to search the
cache roots exactly as routes/models.py and /train/start already do with it.
Requiring a path left those selections judged on the repo's current
architecture while the worker loads the snapshot. The Configure preview now
resolves the same way, so the flag travels on its own rather than being read
back off the path, and the preview cache keys on it.

Carry the upgrade check's custom-code verdict into the custom-code gate.
confirmRemoteCodeIfNeeded falls back to the caller's requiresTrustRemoteCode
when the scan request itself fails, and the training callers were handing it
the stored config flag, which a fresh run leaves false. For a model that
needs its own modeling code the fallback then skipped consent and started a
worker with trust_remote_code off, which cannot load it. The check has
already answered that question, so the outcome now reports it and both start
paths pass it on, the way chat passes its validate result.

* Wait for the in-flight support snapshot instead of answering no upgrade

The Configure preview starts its own transformers-upgrade check the moment the
tab renders. On a cold snapshot that check fetches PyPI and the transformers
config mapping, and a user who presses Start before it lands sends a second,
concurrent check. _get_snapshot deduplicated those by handing the loser None,
which reads as "no upgrade needed" through latest_transformers_supports and
check_upgrade_for_model, so the start gate proceeded and the run launched on a
model no installed transformers can load.

The loser now waits on the running fetch and returns its snapshot, bounded at
20s so a request can never sit for a refresh's worst case; past that it falls
through to the same graceful answer a failed refresh gives. Still exactly one
fetch in flight.

* Answer the upgrade gate from the fetch, the release and the live generation

Four ways the gate still answered something other than what it knows.

The wait a concurrent caller makes for an in-flight support snapshot was a flat
20 seconds, but a refresh is five sequential URLs, each allowed one retry at the
five-second fetch timeout, so it can legitimately run for fifty. A wait that
expires mid-fetch answers None, and None reads as "no upgrade needed" all the
way up to Start, which launches the run on the architecture the gate exists to
stop. The bound is now derived from the refresh's own budget, so tuning a
timeout or a retry cannot silently reopen it.

The consent dialog offered "Continue with custom code" only once an install had
failed. Training raises that dialog before a run starts, so for a model that
ships its own modeling code the first dialog was Install or Cancel, and Install
activates the latest sidecar, which trains 16-bit. The 4-bit run the user asked
for had no way to start. The fallback is now offered next to Install whenever it
exists, out of one shared decision the dialog and its tests both read.

install_breaks_exact_resume is answered from the run's own provenance, without
regard to whether any release exists to install, so a resume on a dev-only
architecture was told that installing would strand it and to start a new run
instead: nothing can be installed, and a new run cannot load either. That branch
now applies only to an installable release, and the dev-only path explains the
real situation.

The Configure preview's notice cache keyed on the sidecar generation but let any
mismatch redefine it. A check fired before an install can still be in flight when
it lands and resolve after the post-install check has answered; its write rewound
the generation, cleared the fresh entry and stored the stale one, and since the
effect behind it was already cleaned up nothing re-rendered and nothing re-asked.
Superseded reads and writes are now ignored.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Bound the refresh transfer, and disclose the 16-bit Install

urlopen's timeout is a socket timeout: CPython documents it as "a timeout in
seconds for blocking operations like the connection attempt", so it bounds each
individual read, never the whole transfer. A response that dribbles bytes just
inside it therefore never expires -- measured here at 12.0s under timeout=5.0 --
which made every bound derived from that timeout an underestimate, the in-flight
wait included. A loser whose wait expired mid-refresh answered None, and None
reads as "no upgrade needed" all the way up to Start, so the run launched on the
architecture this gate exists to stop.

So the transfer gets its own wall-clock budget, checked between read1 calls,
and the per-attempt worst case is derived from that budget plus the one socket
read still blocking when it runs out. The in-flight wait is derived from the
attempt, and is now only a backstop: a waiter re-waits while that same refresh
is genuinely still running, since the winner clears the busy flag and sets the
event in one locked finally.

Separately, the Configure preview reported one precision for a run whose
precision depends on which action the user takes. A model that both ships its
own modeling code and is shipped by the offered release gets both dialog
actions: keeping the custom code loads it on the current transformers in 4-bit,
which is what forces_16bit answers for, while Install activates the latest
sidecar, which trains 16-bit. The card offered that install next to an
unqualified "QLoRA - 4-bit", understating the VRAM of the run by roughly
threefold if the user picked it. An offered install the backend does not already
call 16-bit is exactly that case and nothing else, so the card now names the
choice.

* Tighten the comments across the upgrade gate for PR #8721

Same explanations, fewer lines. The comments had grown to the point of
restating the code around them and repeating the same VRAM argument in
five places; each one now makes its point once.

Comments and docstrings only, verified per file with an AST comparison of
the code either side of the edit (24/24 unchanged). typecheck clean, ruff
clean, 37 frontend tests and 197 backend tests pass.

* Pin the compatibility guarantees for PR #8721 with regression tests

The existing tests prove the gate fires. These pin the opposite property,
which is what decides whether merging is safe: everything that worked
before it has to behave exactly as it did.

Backend, test_training_transformers_upgrade_gate.py:
  - an old client sends model_name alone, and a minimal response reads as
    the pre-gate behaviour, so a bundle newer than its backend still starts
  - forces_16bit over all eight combinations of sidecar, installable
    release and custom code, since the preview draws its VRAM claim from it
  - four failure types out of the preflights, none of which may escape a
    route that now runs in front of every start
  - the route stays behind authentication

Backend, test_transformers_latest.py, which chat reaches through /validate:
  - ordinary responses, plain and chunked, come back whole
  - a multi-chunk body is not truncated by the transfer budget
  - a 404 stays distinguishable from a failure, since auto_mappings.py does
    not exist on pre-5.10 tags
  - a truncated source fails the lookup rather than caching a short map that
    would offer an upgrade to every model missing from it

Frontend, training-transformers-upgrade.test.ts:
  - 404, 405, 500 and a network failure each leave the start untouched and
    raise no dialog
  - a partially populated upgrade is never offered as an install
  - a field from a newer backend is ignored rather than fatal

Measured while writing these: against a hostile mirror the snapshot refresh
returns in 20s where the derived bound is 150s, a second start after a
failure costs 0.000s behind the 300s backoff, and 50 offline checks take
0.1ms. The Configure notice and the consent dialog render identically in
Chromium, Firefox and WebKit with no console errors.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Key the sidecar guard on every target, and drop a redundant bool()

Two failures CI caught that the local suites did not, both introduced by
this branch and both passing on main.

The offline guard on latest_tier_active_for was keyed on the bare name
targets. The guard argument is what the call READS, and that function
resolves a remote adapter's base itself, so the whole tuple is the honest
key; the repo's other two call sites pass a tuple literal for the same
reason. tests/test_offline_gguf_cache_fallback.py asserts it.

requires_trust_remote_code was re-wrapped in bool() when constructing the
response. The value is already a bool, and the literal text reads as the
raw-YAML pattern the GGUF security-gate consistency test forbids. Dropped
there and on the two beside it.

218 gate/provenance/latest tests pass, ruff clean.

* Tighten the comments added with the regression tests

Final pass over what landed after the last one. Same points, fewer lines.

Comments only, AST-verified (3/3 code unchanged). 125 backend and 20
frontend tests pass, ruff clean.

* Drop an incomplete regex escape in the training upgrade test for PR #8721

---------

Co-authored-by: danielhanchen <unslothshared@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2026-08-14 04:59:56 -07:00

682 lines
28 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-only
# Copyright 2026-present the Unsloth AI Inc. team. All rights reserved. See /studio/LICENSE.AGPL-3.0
"""Latest-transformers support check for brand-new model architectures.
When a model's ``model_type`` is absent from every installed transformers overlay
(base 4.57.x plus the .venv_t5_530/550/510 sidecars and, if provisioned, .venv_t5_latest),
Unsloth cannot load it today. This module answers, without authentication, code execution,
or trust_remote_code:
1. Does the LATEST transformers release on PyPI ship this ``model_type``?
2. Does transformers ``main`` on GitHub ship it (dev-only, not yet installable)?
Sources (all unauthenticated; raw.githubusercontent.com is not API rate-limited and
api.github.com is deliberately never used):
- https://pypi.org/pypi/transformers/json -> latest release version
- https://raw.githubusercontent.com/huggingface/transformers/{ref}/src/transformers/
models/auto/configuration_auto.py + auto_mappings.py -> CONFIG_MAPPING_NAMES
The fetched sources are parsed with the same AST extractor the static router uses
(:func:`utils.transformers_version._model_types_from_source`), so the remote answer is
computed exactly like the local overlay answer.
Results are cached in memory and in a small JSON snapshot under ``studio_root()/cache``
(ttl ~1 day) so repeated tier resolutions never re-fetch; failures are backed off in
memory. Every fetch is bounded by an explicit wall-clock budget on the transfer (not just
the socket timeout, which only bounds one read), so a hung or drip-feeding network cannot
block model loading. Fully offline-safe: offline env vars or the kill switch
``UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS=1`` make every check return None (current
behavior preserved).
The consented install path (:func:`install_latest_transformers`) provisions the
persistent ``.venv_t5_latest`` sidecar via
:func:`utils.transformers_version.ensure_latest_transformers_venv`.
"""
import json
import os
import threading
import time
from pathlib import Path
from loggers import get_logger
from utils.paths.storage_roots import studio_root as _studio_root
from utils.transformers_version import (
_env_offline,
_load_config_json,
_model_types_from_source,
_tier_from_config_mapping,
_config_model_types,
_NESTED_CONFIG_KEYS,
_TIER_RANK,
_model_types_from_config,
_TRANSFORMERS_510_MODEL_TYPES,
_TRANSFORMERS_530_MODEL_TYPES,
_TRANSFORMERS_550_MODEL_TYPES,
ensure_latest_transformers_venv,
latest_venv_pinned_version,
)
logger = get_logger(__name__)
_PYPI_JSON_URL = "https://pypi.org/pypi/transformers/json"
_RAW_URL = (
"https://raw.githubusercontent.com/huggingface/transformers/{ref}"
"/src/transformers/models/auto/{name}"
)
_AUTO_FILES = ("configuration_auto.py", "auto_mappings.py")
_FETCH_TIMEOUT_SECONDS = 5.0
_FETCH_RETRIES = 1
# urlopen's timeout bounds each individual read, never the whole transfer, so a mirror
# dribbling a few bytes just inside it keeps resp.read() alive indefinitely (measured:
# 12 chunks 1s apart read in 12.0s under timeout=5.0). The transfer gets its own
# wall-clock budget instead: one timeout for the connect, one for the body.
_FETCH_DEADLINE_SECONDS = 2 * _FETCH_TIMEOUT_SECONDS
# One attempt's true worst case: the budget, plus the single socket read already blocking
# when it runs out (the deadline is only tested between reads).
_FETCH_ATTEMPT_SECONDS = _FETCH_DEADLINE_SECONDS + _FETCH_TIMEOUT_SECONDS
_READ_CHUNK_BYTES = 1 << 16
_CACHE_TTL_SECONDS = 24 * 60 * 60
_FAILURE_BACKOFF_SECONDS = 300
_CACHE_FILE_NAME = "transformers_latest_check.json"
_SNAPSHOT_SCHEMA = 1
# Snapshot: {"schema", "fetched_at", "pypi_version", "pypi_model_types", "main_model_types"}.
# Install-in-progress state lives in utils.transformers_version (the sidecar swap reservation).
_lock = threading.Lock()
_memory_snapshot: dict | None = None
_last_failure_at: float = 0.0
_is_fetching: bool = False
# Set whenever no refresh is in flight; a concurrent caller waits on it for the running
# fetch's answer instead of reporting "no answer" (see _get_snapshot).
_fetch_done: threading.Event = threading.Event()
_fetch_done.set()
# Backstop for that wait, bounded by the refresh's OWN worst case: the PyPI version plus
# both auto files at each of the two refs, each allowed its retry at _FETCH_ATTEMPT_SECONDS.
# Derived rather than a literal, so tuning a timeout, a retry or the transfer budget cannot
# silently shrink it below what it bounds. Only a backstop: giving up early is not graceful
# here, since the answer it falls through to reads as "no upgrade needed" all the way to the
# Start button, launching the run on the architecture this gate exists to stop. So the
# waiter re-waits while the refresh is genuinely in flight (_get_snapshot).
_REFRESH_URL_COUNT = 1 + 2 * len(_AUTO_FILES)
_INFLIGHT_WAIT_SECONDS = _REFRESH_URL_COUNT * (1 + _FETCH_RETRIES) * _FETCH_ATTEMPT_SECONDS + 5.0
_TRUE_VALUES = {"1", "true", "yes", "on"}
def _disabled() -> bool:
"""True if the operator disabled the latest-transformers check entirely."""
return (
os.environ.get("UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS", "").strip().lower() in _TRUE_VALUES
)
def _cache_file() -> Path:
return _studio_root() / "cache" / _CACHE_FILE_NAME
# Sentinel for HTTP 404 (absent at ref), distinct from transient failures.
_FETCH_MISSING = "__unsloth_fetch_missing__"
def _read_within(resp, deadline: float) -> str | None:
"""Body of *resp*, or None if the transfer is still running at *deadline*.
``resp.read()`` in one call has no bound at all: the socket timeout only fires on a
read that stalls longer than itself, so a drip-fed response never trips it. ``read1``
returns what has arrived instead of blocking for a full chunk, which is what lets the
budget be checked as the body comes in.
"""
read1 = getattr(resp, "read1", None)
if read1 is None:
# A file-like that hands back the whole body in one go has nothing to dribble.
return resp.read().decode("utf-8", "replace")
chunks: list[bytes] = []
while True:
if time.monotonic() >= deadline:
return None
chunk = read1(_READ_CHUNK_BYTES)
if not chunk:
return b"".join(chunks).decode("utf-8", "replace")
chunks.append(chunk)
def _fetch_text(url: str) -> str | None:
"""GET *url* within a bounded wall-clock budget, one retry; None on any failure.
Returns ``_FETCH_MISSING`` (without retrying) on HTTP 404 so callers can tell
"absent at this ref" apart from "network flaked".
"""
import urllib.error
import urllib.request
for attempt in range(1 + _FETCH_RETRIES):
deadline = time.monotonic() + _FETCH_DEADLINE_SECONDS
try:
req = urllib.request.Request(url, headers = {"User-Agent": "unsloth-studio"})
with urllib.request.urlopen(req, timeout = _FETCH_TIMEOUT_SECONDS) as resp:
body = _read_within(resp, deadline)
if body is not None:
return body
logger.debug(
"Fetch (attempt %d) for %s outran its %.1fs budget",
attempt + 1,
url,
_FETCH_DEADLINE_SECONDS,
)
except urllib.error.HTTPError as exc:
if exc.code == 404:
return _FETCH_MISSING
logger.debug("Fetch failed (attempt %d) for %s: %s", attempt + 1, url, exc)
except Exception as exc:
logger.debug("Fetch failed (attempt %d) for %s: %s", attempt + 1, url, exc)
return None
def _fetch_latest_pypi_version() -> str | None:
"""Latest transformers release version from PyPI's unauthenticated JSON API."""
body = _fetch_text(_PYPI_JSON_URL)
if body is None or body == _FETCH_MISSING:
return None
try:
version = json.loads(body).get("info", {}).get("version")
except Exception as exc:
logger.debug("Could not parse PyPI JSON: %s", exc)
return None
return version if isinstance(version, str) and version else None
def _fetch_remote_model_types(ref: str) -> frozenset[str] | None:
"""CONFIG_MAPPING_NAMES keys at *ref* (a release tag like ``v5.12.0`` or ``main``).
Fetches configuration_auto.py plus auto_mappings.py (the 5.10+ split) from
raw.githubusercontent.com and parses them with the shared AST extractor. A file
that 404s (auto_mappings.py on pre-5.10 tags) is skipped, but a transient fetch
or parse failure of EITHER file fails the whole lookup: most model types live in
auto_mappings.py on current releases, so a partial map cached for the TTL would
make /validate skip the upgrade prompt for architectures the release does ship.
An empty result is likewise a failure so it is never cached as "supports nothing".
"""
keys: set[str] = set()
fetched_any = False
for name in _AUTO_FILES:
source = _fetch_text(_RAW_URL.format(ref = ref, name = name))
if source is None:
return None
if source == _FETCH_MISSING:
continue
fetched_any = True
try:
keys |= _model_types_from_source(source)
except Exception as exc:
logger.debug("Could not parse %s at %s: %s", name, ref, exc)
return None
if not fetched_any or not keys:
return None
return frozenset(keys)
def _load_snapshot_file() -> dict | None:
"""Persisted snapshot from disk, or None (missing/corrupt/old schema)."""
try:
with open(_cache_file(), encoding = "utf-8") as f:
data = json.load(f)
except Exception:
return None
if not isinstance(data, dict) or data.get("schema") != _SNAPSHOT_SCHEMA:
return None
if not isinstance(data.get("fetched_at"), (int, float)):
return None
if not isinstance(data.get("pypi_version"), str):
return None
for key in ("pypi_model_types", "main_model_types"):
value = data.get(key)
if not isinstance(value, list) or not all(isinstance(v, str) for v in value):
return None
return data
def _save_snapshot_file(snapshot: dict) -> None:
"""Atomic best-effort write (tmp + os.replace, Windows-safe); failures only log."""
path = _cache_file()
tmp = path.with_name(path.name + ".tmp")
try:
path.parent.mkdir(parents = True, exist_ok = True)
tmp.write_text(json.dumps(snapshot), encoding = "utf-8")
os.replace(tmp, path)
except Exception as exc:
logger.debug("Could not persist %s: %s", path, exc)
try:
tmp.unlink(missing_ok = True)
except Exception:
pass
def _snapshot_is_fresh(snapshot: dict | None) -> bool:
return (
snapshot is not None
and (time.time() - float(snapshot.get("fetched_at", 0))) < _CACHE_TTL_SECONDS
)
def _refresh_snapshot() -> dict | None:
"""Fetch a fresh snapshot from PyPI + raw.githubusercontent.com; None on failure.
The PyPI version and its tagged mapping are required; the ``main`` mapping is
best-effort (recorded as an empty list plus ``main_checked=False`` when unavailable,
so a dev-only architecture is reported as "unknown" rather than "unsupported").
"""
version = _fetch_latest_pypi_version()
if version is None:
return None
pypi_types = _fetch_remote_model_types(f"v{version}")
if pypi_types is None:
return None
main_types = _fetch_remote_model_types("main")
return {
"schema": _SNAPSHOT_SCHEMA,
"fetched_at": time.time(),
"pypi_version": version,
"pypi_model_types": sorted(pypi_types),
"main_model_types": sorted(main_types) if main_types is not None else [],
"main_checked": main_types is not None,
}
def _get_snapshot() -> dict | None:
"""Current support snapshot: memory -> disk -> network, with TTL and failure backoff.
The network refresh runs outside the lock so a slow fetch cannot stall other
threads in the ASGI pool; _is_fetching deduplicates concurrent refreshes, and a
loser waits (bounded) for the winner's answer rather than stacking a second fetch.
Waiting is what makes this safe to gate on: the Configure preview and the Start
button both ask, and a loser that answered "no answer" told the start there was no
upgrade, so the run launched on a model no installed transformers can load.
"""
global _memory_snapshot, _last_failure_at, _is_fetching, _fetch_done
with _lock:
if _snapshot_is_fresh(_memory_snapshot):
return _memory_snapshot
disk = _load_snapshot_file()
if _snapshot_is_fresh(disk):
_memory_snapshot = disk
return disk
if _disabled() or _env_offline():
return None
if time.time() - _last_failure_at < _FAILURE_BACKOFF_SECONDS:
return None
if _is_fetching:
in_flight = _fetch_done
else:
in_flight = None
_is_fetching = True
_fetch_done = done = threading.Event()
if in_flight is not None:
# Wait for the refresh's actual completion, not for a clock. An expiry here is
# not "no upgrade needed", it is "the answer is still being fetched", and the
# callers above cannot tell those apart. So re-wait while this same refresh is
# running; the winner clears _is_fetching and sets the event in one locked
# finally, so either condition means it is done.
while not in_flight.wait(_INFLIGHT_WAIT_SECONDS):
with _lock:
if not _is_fetching or _fetch_done is not in_flight:
break
logger.debug("Still waiting on the in-flight transformers support refresh")
with _lock:
return _memory_snapshot if _snapshot_is_fresh(_memory_snapshot) else None
fresh = None
try:
fresh = _refresh_snapshot()
finally:
with _lock:
_is_fetching = False
done.set()
if fresh is None:
_last_failure_at = time.time()
else:
_memory_snapshot = fresh
if fresh is None:
# A stale positive could offer a version PyPI no longer serves; be strict.
return None
_save_snapshot_file(fresh)
return fresh
def clear_caches() -> None:
"""Test helper: drop the in-memory snapshot, failure backoff, and busy flags."""
global _memory_snapshot, _last_failure_at, _is_fetching
with _lock:
_memory_snapshot = None
_last_failure_at = 0.0
_is_fetching = False
_fetch_done.set()
from utils.transformers_version import end_sidecar_swap
end_sidecar_swap()
def latest_transformers_supports(model_type: str) -> dict | None:
"""Whether the newest transformers (PyPI release and/or GitHub main) ships *model_type*.
Returns ``{"pypi_version": str, "supported_in_pypi": bool, "supported_in_main": bool}``
or None when the answer is unavailable (offline, kill switch, network failure) — the
caller must then fall through to current behavior. Cached (memory + JSON snapshot on
disk, ttl ~1 day) so repeated tier resolutions never re-fetch.
"""
if not isinstance(model_type, str) or not model_type:
return None
if _disabled() or _env_offline():
return None
snapshot = _get_snapshot()
if snapshot is None:
return None
return {
"pypi_version": snapshot["pypi_version"],
"supported_in_pypi": model_type in set(snapshot["pypi_model_types"]),
"supported_in_main": model_type in set(snapshot["main_model_types"]),
}
# model_types the hardcoded tier tables already route; never remote-check these.
def _hardcoded_model_types() -> frozenset[str]:
return frozenset(
_TRANSFORMERS_530_MODEL_TYPES
| _TRANSFORMERS_550_MODEL_TYPES
| _TRANSFORMERS_510_MODEL_TYPES
)
def check_upgrade_for_model(model_name: str, hf_token: str | None = None) -> dict | None:
"""Upgrade signal for *model_name*, or None when current routing already handles it.
The tier hook for the pre-load ``/validate`` path: fires ONLY when the model's
``model_type`` is absent from every installed overlay (and from the hardcoded tier
tables), i.e. exactly when today's load would fail with an unrecognized-architecture
error. Returns ``{"model_type", "pypi_version", "supported_in_pypi",
"supported_in_main"}`` when the newest transformers knows the type, else None.
Never raises; every network touch is bounded and cached. Offline or with the
``UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS`` kill switch it returns None immediately.
"""
try:
if _disabled() or _env_offline():
return None
cfg = _load_config_json(model_name, hf_token)
if not isinstance(cfg, dict):
return None
candidates = _model_types_from_config(cfg)
if not candidates:
return None
# Without a readable base mapping every type looks brand new; bail out.
if not _config_model_types("default"):
return None
hardcoded = _hardcoded_model_types()
missing = [
candidate
for candidate in candidates
if candidate not in hardcoded
and not any(candidate in _config_model_types(tier) for tier in _TIER_RANK)
]
if not missing:
return None
# Latest must load EVERY missing type (wrappers build nested sub-configs
# through CONFIG_MAPPING) or the load still fails.
supports = [latest_transformers_supports(candidate) for candidate in missing]
if any(
s is None or not (s["supported_in_pypi"] or s["supported_in_main"]) for s in supports
):
return None
# Offer the PyPI install only if the release ships every missing type; a
# main-only type in the mix surfaces as dev-only.
model_type = missing[0]
supported_in_pypi = all(s["supported_in_pypi"] for s in supports)
supported_in_main = all(s["supported_in_pypi"] or s["supported_in_main"] for s in supports)
logger.info(
"Model %s has model_type=%s unknown to every installed transformers "
"(latest PyPI %s: %s, main: %s)",
model_name,
model_type,
supports[0]["pypi_version"],
"supported" if supported_in_pypi else "unsupported",
"supported" if supported_in_main else "unsupported",
)
return {
"model_type": model_type,
"pypi_version": supports[0]["pypi_version"],
"supported_in_pypi": supported_in_pypi,
"supported_in_main": supported_in_main,
}
except Exception as exc:
logger.debug("Latest-transformers check failed for '%s': %s", model_name, exc)
return None
# --- Dependency compatibility preflight ------------------------------------------------------
# Sidecars install transformers --no-deps atop the base env. Before installing, compare
# requires_dist: unsatisfied shadowable deps become exact --target pins, anything else blocks.
# Safe to shadow inside the sidecar dir (pure wheels, no torch coupling).
_SHADOWABLE_DEPS = frozenset({"tokenizers", "safetensors"})
# Provided by the sidecar recipe; checked against its pin, not the base env.
_SIDECAR_PROVIDED = {"huggingface-hub": "1.8.0", "hf-xet": "1.4.2"}
# CLI-only; never imported at runtime in Unsloth's workers.
_IGNORED_DEPS = frozenset({"typer"})
def _canonical_dep_name(name: str) -> str:
return name.lower().replace("_", "-")
def _fetch_requires_dist(version: str) -> list[str] | None:
"""Core (marker-free, non-extra) requires_dist of transformers *version* from PyPI."""
body = _fetch_text(f"https://pypi.org/pypi/transformers/{version}/json")
if body is None or body == _FETCH_MISSING:
return None
try:
reqs = json.loads(body).get("info", {}).get("requires_dist")
except Exception:
return None
if not isinstance(reqs, list):
return None
return [r for r in reqs if isinstance(r, str)]
def _resolve_exact_version(name: str, specifier) -> str | None:
"""Newest PyPI release of *name* satisfying *specifier* (exact pin for the shadow)."""
body = _fetch_text(f"https://pypi.org/pypi/{name}/json")
if body is None or body == _FETCH_MISSING:
return None
try:
from packaging.version import InvalidVersion, Version
releases = json.loads(body).get("releases", {})
best = None
for candidate in releases:
try:
parsed = Version(candidate)
except InvalidVersion:
continue
if parsed.is_prerelease or not specifier.contains(candidate):
continue
if best is None or parsed > Version(best):
best = candidate
return best
except Exception as exc:
logger.debug("Could not resolve an exact %s version: %s", name, exc)
return None
def compat_plan(version: str) -> tuple[tuple[str, ...], list[str]]:
"""(extra exact pins to shadow-install, blocking requirement strings) for *version*.
Compares the release's core requires_dist against the running base env (the env the
workers overlay the sidecar onto). A requirement the base env satisfies needs nothing;
an unsatisfied shadowable dep becomes an exact pin inside the sidecar; any other
unsatisfied requirement is a blocker. An unavailable requires_dist BLOCKS the
install: proceeding unverified could pin a sidecar whose imports then crash the
workers, and the caller just reached PyPI for the version check so a retry is cheap.
"""
reqs = _fetch_requires_dist(version)
if reqs is None:
return (), ["dependency metadata for this release (could not be fetched from PyPI; retry)"]
try:
from importlib.metadata import PackageNotFoundError
from importlib.metadata import version as _installed_version
from packaging.requirements import InvalidRequirement, Requirement
except Exception:
return (), []
extras: list[str] = []
blockers: list[str] = []
for raw in reqs:
try:
req = Requirement(raw)
except InvalidRequirement:
continue
if req.extras or (req.marker is not None and not req.marker.evaluate()):
continue
name = _canonical_dep_name(req.name)
if name in _IGNORED_DEPS:
continue
if name in _SIDECAR_PROVIDED:
if not req.specifier.contains(_SIDECAR_PROVIDED[name], prereleases = True):
blockers.append(raw)
continue
try:
installed = _installed_version(req.name)
except PackageNotFoundError:
installed = None
if installed is not None and req.specifier.contains(installed, prereleases = True):
continue
if name in _SHADOWABLE_DEPS:
exact = _resolve_exact_version(name, req.specifier)
if exact is None:
blockers.append(raw)
else:
extras.append(f"{name}=={exact}")
else:
blockers.append(raw)
return tuple(extras), blockers
def is_install_in_progress() -> bool:
"""True while a latest-transformers install or lazy repair holds the sidecar swap
reservation. Training and export starts check this so a fresh worker never
activates the sidecar mid-swap."""
from utils.transformers_version import sidecar_swap_in_progress
return sidecar_swap_in_progress()
def install_latest_transformers(
version: str,
before_swap = None,
reserved: bool = False,
) -> dict:
"""Consented install of the latest transformers sidecar; returns a structured result.
Guards: the requested *version* must match the current PyPI latest from the (cached)
snapshot, so a client cannot pin an arbitrary package version through this endpoint.
On success ``.venv_t5_latest`` is provisioned and pinned; routing then resolves the
new tier automatically on this and every future start. *before_swap* is forwarded
to the stage-and-swap: it runs only after the staged install succeeded, right
before the live sidecar is replaced. *reserved* means the caller already holds the
sidecar swap reservation (the install route takes it before waiting on the
inference lifecycle gate, so worker starts see it for the whole window).
"""
from utils.transformers_version import end_sidecar_swap, try_begin_sidecar_swap
if not reserved and not try_begin_sidecar_swap():
return {
"success": False,
"version": version,
"message": "A transformers installation is already in progress.",
}
try:
return _install_latest_transformers_locked(version, before_swap = before_swap)
finally:
if not reserved:
end_sidecar_swap()
def _install_latest_transformers_locked(version: str, before_swap = None) -> dict:
"""Body of install_latest_transformers; runs with the in-progress flag held."""
if _disabled():
return {
"success": False,
"version": version,
"message": "Latest-transformers installs are disabled "
"(UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS).",
}
if _env_offline():
return {
"success": False,
"version": version,
"message": "Cannot install: Unsloth is in offline mode.",
}
# Re-verify against a LIVE snapshot (a release may land inside the cache TTL);
# fall back to the cached one on fetch failure.
global _memory_snapshot
snapshot = _refresh_snapshot()
if snapshot is not None:
with _lock:
_memory_snapshot = snapshot
_save_snapshot_file(snapshot)
else:
snapshot = _get_snapshot()
if snapshot is None:
return {
"success": False,
"version": version,
"message": "Could not verify the latest transformers release on PyPI.",
}
if version != snapshot["pypi_version"]:
return {
"success": False,
"version": version,
"message": f"Requested version {version!r} is not the latest transformers "
f"release ({snapshot['pypi_version']}).",
# Lets the consent dialog retry with the release that superseded the
# one /validate saw, instead of re-sending the stale version forever.
"latest_version": snapshot["pypi_version"],
}
extra_packages, blockers = compat_plan(version)
if blockers:
return {
"success": False,
"version": version,
"message": "Cannot install transformers "
f"{version}: this environment does not satisfy {', '.join(blockers)}. "
"An Unsloth update is required first.",
}
if not ensure_latest_transformers_venv(version, extra_packages, before_swap = before_swap):
return {
"success": False,
"version": version,
"message": f"Installing transformers {version} failed; see the Unsloth logs.",
}
_invalidate_capability_caches()
return {
"success": True,
"version": version,
"message": f"Installed transformers {version} into the latest sidecar "
f"(pinned: {latest_venv_pinned_version()}).",
}
def _invalidate_capability_caches():
"""Drop caches computed before the new sidecar existed: tier probes and the
latest tier's model_type mapping (stale on upgrade) plus vision detection
(a raw-heuristic False may now defer to the sidecar AutoConfig probe)."""
try:
from utils import transformers_version as tv
tv._probe_tier_cache.clear()
tv._config_mapping_cache.pop("latest", None)
except Exception:
pass
try:
from utils.models import model_config as mc
mc._vision_detection_cache.clear()
except Exception:
pass