unsloth/studio/backend/utils/transformers_version.py
Daniel Han 815f242970
Studio: offer the latest transformers release for brand-new architectures (#7056)
* Studio: offer the latest transformers release for brand-new architectures

When a model's config.json model_type is absent from every installed
transformers overlay (base 4.57.x and the .venv_t5_530/550/510 sidecars),
Studio now checks, unauthenticated and cached, whether the newest
transformers ships it:

- utils/transformers_latest.py fetches the latest release version from
  https://pypi.org/pypi/transformers/json and the CONFIG_MAPPING_NAMES
  sources for that tag and for main from raw.githubusercontent.com
  (never api.github.com), parsing them with the same AST extractor the
  static router uses (no code execution, no trust_remote_code). Results
  are cached in memory and in a JSON snapshot under studio_root()/cache
  with a one day ttl; fetches are bounded to 5s with one retry and a
  failure backoff, and offline mode or the new kill switch
  UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS=1 short-circuits to None.

- POST /api/inference/validate gains requires_transformers_upgrade plus
  a transformers_upgrade payload (model_type, pypi_version,
  supported_in_pypi, supported_in_main) so the frontend can raise the
  install consent dialog before /load, mirroring the existing
  remote-code consent flow. The check fires only when the model_type is
  unknown to all installed overlays and the hardcoded tier tables.

- POST /api/inference/install-latest-transformers provisions a new
  persistent .venv_t5_latest sidecar after user consent, pinned to the
  exact PyPI version (re-verified server-side) with the same
  --target/--no-deps recipe as the fixed sidecars. A JSON pin marker
  inside the dir records the installed package set, so restarts
  revalidate it and routing resolves the new highest-ranked tier
  automatically. A dependency preflight (compat_plan) compares the
  release's requires_dist against the running env: unsatisfied
  tokenizers/safetensors floors are shadow-installed as exact pins into
  the sidecar, anything else unsatisfied blocks the install with a
  clear message.

Routing for every already-supported model_type is unchanged: the
hardcoded lists and the 530/550/510 static resolver run first, the new
tier only participates once its venv exists, and the probe order gains
the latest sidecar only when provisioned. Verified against live PyPI
and GitHub (transformers 5.13.0: 674 model_types, 26 absent from all
installed overlays, e.g. cosmos3_omni; 4 dev-only on main) and with a
real sidecar install plus restart persistence. 64 new tests; the
existing 200-test transformers_version suite passes unchanged.

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

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

* Latest-transformers check: fetch outside the lock, serialize installs

Release the module lock during the network refresh so a slow fetch cannot
stall other threads in the ASGI pool; concurrent callers during a fetch get
None (the graceful fallthrough) via an in-flight flag instead of stacking
fetches. Serialize install_latest_transformers with an in-progress flag so
concurrent consents cannot race the sidecar delete and recreate; the loser
gets a structured already-in-progress refusal.

* Latest-transformers check: LoRA bases, pin-gated mapping, live reverify

Run the upgrade check over the [adapter, base] target set so a LoRA whose
base model is a brand-new architecture surfaces the prompt (the worker
activates transformers for the base, not the adapter).

Gate the latest overlay's mapping lookup on a valid pin marker, matching
activation and the probe order, so a partial or manual .venv_t5_latest dir
cannot be routed to and then refused at activation.

Re-verify the requested version against a live PyPI snapshot at install
time, falling back to the cached one on fetch failure, so a release
published inside the cache TTL is not silently missed.

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

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

* Latest-transformers check: nested config types and latest-tier vision probe

Collect every model_type in the config (top level plus each nested
sub-config) and signal on the first one missing from all installed
overlays, so a supported wrapper carrying a brand-new backbone still
surfaces the upgrade prompt; wrappers instantiate sub-configs through
CONFIG_MAPPING and would fail on the nested type.

Route the vision capability subprocess through the pinned latest sidecar
when the model resolves to the latest tier, so latest-only VLMs are not
misclassified as text-only; every other tier keeps the 5.5 sidecar used
today.

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

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

* Latest tier: nested routing, vision probe after raw miss, safe upgrades

Route by every model_type in the config: a nested sub-config type can raise
the tier (wrappers instantiate sub-configs through CONFIG_MAPPING), so a
supported wrapper with a latest-only backbone routes to latest once
installed instead of staying on default. An unknown nested type never
vetoes; the primary type keeps its previous semantics. The collector is
shared with the upgrade checker.

Vision detection: when the raw heuristics say False for a model that routes
to the latest tier, run the AutoConfig subprocess under the pinned latest
sidecar instead of trusting heuristics built from older transformers.

Provisioning: stage-and-swap. Build the new sidecar in .venv_t5_latest.staging
and swap it in only when the install and pin marker are complete, so a failed
upgrade never destroys a previously working sidecar; restore the old dir if
the final swap fails.

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

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

* Latest-transformers checker, vision subprocess, and cache fixes

Require the latest release to support every missing model_type (the
primary included) before prompting; a nested-only match cannot make the
model loadable, so no install is offered for it.

The vision-check subprocess now unions the active sidecar's own
registry mappings into the inlined parent-process detection sets, so
architectures only the sidecar knows classify correctly.

A successful sidecar install clears the tier probe cache, the latest
tier's model_type mapping, and the vision-detection cache so the new
venv takes effect without a restart. Tests for all three.

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

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

* Aggregate upgrade support flags and keep install off /v1

The upgrade signal now reports supported_in_pypi only when the latest
release covers every missing model_type; a mix with a main-only nested
type surfaces as dev-only so no PyPI install is offered that would
still fail at load. The consented install endpoint moves to
studio_router so it is not reachable through the OpenAI-compatible /v1
mount. Tests for both.

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

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

* Honor the latest-transformers kill switch in routing

With UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS set after the sidecar was
provisioned, the latest tier still joined mapping and probe routing
because only the pin was checked. Both admission points now also check
the kill switch, so operators can roll back a problematic sidecar
without deleting files.

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

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

* Repair the latest sidecar through stage-and-swap

The lazy repair path installed into the live .venv_t5_latest, which
_ensure_venv_dir wipes first, so a failed repair deleted the pinned
sidecar and its marker. Both the consented install and the repair now
share one stage-and-swap helper: the incomplete-but-pinned dir survives
any failure and a later attempt can still repair it.

* Tighten comments

* Remove the staging dir when a latest-sidecar install fails

A pip failure inside _ensure_venv_dir returns False without raising, so
the except cleanup never ran and the partial .venv_t5_latest.staging
leaked until a later attempt. Also note on the validate response fields
that frontend consumption ships in the follow-up PR.

* Add the transformers-upgrade consent dialog to the frontend

When /validate reports requires_transformers_upgrade, every explicit load
path (chat runtime and the compare composer) now pauses on a consent
dialog modeled on the remote-code one: it names the model_type and the
latest PyPI transformers version, and on Accept calls
/api/inference/install-latest-transformers itself, shows an installing
state, and resumes the original load automatically on success. Errors
surface in the dialog with a retry; Cancel aborts the load like the
trust dialog's deny path. Architectures shipped only on transformers
main get a dev-only notice with no install button. Background auto-load
skips upgrade-requiring candidates instead of prompting, mirroring the
trust_remote_code rule. The dialog mounts once in the root layout and
runs before the security dialogs, since no load can proceed without the
runtime.

* Route a non-installable new architecture to the custom-code consent as a last resort

When the upgrade dialog has no installable PyPI release (the architecture
is only on transformers main, which Studio never installs), the dialog now
says so explicitly, and when the model also declares custom (auto_map)
code it offers Continue with custom code: resolving the paused load into
the existing trust_remote_code consent gate instead of hard-aborting.
Models with no custom code keep the Cancel-only notice. The backend
returns no upgrade signal at all for architectures unknown to both PyPI
and main, so those still route straight to the unchanged security gate.

* Force a 16-bit load for models on the latest-transformers sidecar

Live validation with Zyphra/ZAYA1-8B (model_type zaya, shipped by
transformers 5.13.1 but unknown to every installed tier) surfaced a
generation crash when the consented sidecar load kept the default bnb
4-bit quantization: transformers' grouped-MoE kernels feed the packed
uint8 expert weights straight into torch._grouped_mm, and generation
dies (plain 16-bit works). New latest_tier_active_for() mirrors the
sidecar activation's tier resolution and never raises; the inference
worker flips load_in_4bit off when it reports true, and the load route
applies the same flip so the pre-load VRAM guard and the worker command
agree. Fixed tiers are untouched. With the guard, ZAYA1-8B loads and
generates correctly in Studio chat.

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

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

* Offer the custom-code fallback when a latest-sidecar install fails

* Fail remote mapping fetches wholesale and mirror the 16-bit flip in validate

A transient fetch or parse failure of one auto-mapping file no longer caches
a partial latest-release map for the TTL (a real 404 on pre-5.10 tags is
still tolerated), and validate_model now applies the same latest-sidecar
16-bit sizing flip as /load before the training guard so the two agree.

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

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

* Tighten comments in the latest-transformers changes

* Resolve remote LoRA bases, fold nested tiers, and guard the sidecar swap

latest_tier_active_for now resolves a remote adapter's base model the same
way worker pre-activation does (and returns early without a sidecar pin), a
hardcoded fast-path tier is raised when a nested sub-config's model_type
needs a higher sidecar, and the install route refuses to swap .venv_t5_latest
while training runs on it and unloads a latest-tier chat model first.

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

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

* Gate the sidecar install on worker liveness and size installable upgrades 16-bit

The install route now refuses while any training or export runs (tier
re-resolution without the load token is unreliable for gated repos), holds
the inference lifecycle gate across the unload and the swap so no load can
interleave, and passes the model name to unload_model. validate_model runs
the upgrade check before the training guard and sizes an installable
upgrade as 16-bit, matching what /load and the worker will force after the
consented install.

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

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

* Close the sidecar install races and honor the kill switch over cached mappings

Training starts and mutating export routes now refuse while a transformers
install is in progress (shared is_install_in_progress flag), the chat unload
and idle export-worker teardown moved into a before_swap hook that runs only
once the staged install succeeded, and _config_model_types checks the kill
switch before returning a cached latest mapping.

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

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

* Reserve the sidecar swap before the gate wait and abort it on failed teardown

The install-in-progress flag moved into a shared sidecar swap reservation in
transformers_version, taken by the install route before awaiting the
inference lifecycle gate (so training and export starts see it for the whole
window) and by the lazy .venv_t5_latest repair path. The before_swap hook
now raises when the chat unload or export teardown reports failure, leaving
the previous sidecar untouched.

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

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

* Back the sidecar swap reservation with a cross-process lock file

The lazy repair runs inside worker subprocesses, where a module-level flag
is invisible to the parent's route checks. The reservation now also creates
a lock file next to .venv_t5_latest (O_EXCL, owner-only removal, stale after
two hours for crashed owners), so is_install_in_progress sees a repair from
any Studio process.

* Hand the swap reservation to the installer thread and harden pre-swap teardown

A cancelled install request no longer releases the reservation while the
installer thread is still staging (the thread owns and releases it, shielded
from cancellation). The route refuses while another inference request is
generating, export teardown runs before the chat unload and is judged by
worker liveness rather than the cleanup return value, and a live inference
worker with no active model (failed load residue) is shut down before the
swap.

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

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

* Keep the lifecycle gate with the installer and recheck the swap at spawn time

The gate moved into the shielded install task so a cancelled POST cannot
release the guard /load honors while the installer still runs, cached latest
probe results are ignored while the kill switch is set, and the training and
export subprocess spawns recheck the sidecar swap reservation right before
spawning (the route-level guards are one-shot and validation can outlast an
install's start).

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

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

* Close the spawn-registration windows against the sidecar install

Training marks the spawn in progress before its reservation recheck and
is_training_active honors the flag, so the install route sees a start that
has passed proc.start() but not yet recorded _proc. Export load-checkpoint
rechecks the reservation after setting _export_active and before tearing
down the old worker, so losing the race keeps the loaded checkpoint instead
of surfacing a 500.

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

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

* Refine the install-window interleavings around worker teardown

The inference busy count is rechecked under the lifecycle gate (streams
start by taking that gate, so nothing slips past a held gate), the training
handshake moved ahead of the VRAM-freeing before_spawn hook so a lost race
leaves chat/export intact, the export spawn-time check is op-aware (inside
an active op the install is the side that aborts), and the Xet-stall respawn
waits out a transient reservation instead of stranding the run.

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

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

* Track the install's server-side unload and guard export ops against the swap

The upgrade dialog store records when its install actually ran (the server
unloads the active chat model before swapping), and the load flow then marks
the previous model as unloaded so a later cancelled gate still triggers
rollback; the custom-code fallback leaves the flag unset. _run_export gained
the same reservation handshake as load_checkpoint so an install cannot block
behind an hours-long export op instead of returning 409.

* Tighten comments in the install-guard and upgrade-consent changes

* Surface install-race refusals cleanly and roll back after a failed swap unload

/load refuses while the sidecar swap is reserved so a load cannot succeed
and immediately be unloaded by the pre-swap teardown, worker starts that
lose the install race raise a typed SidecarSwapInProgress mapped to 409
instead of a 500, the install response reports model_unloaded even on a
structured failure so the client can restore its state, and the compare
flow tracks the server-side unload like the primary load path and clears a
stale checkpoint on abort.

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

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

* Type the export install races, scope the lock release, and keep the unload signal

Export load-checkpoint and export ops raise SidecarSwapInProgress (mapped to
409 in every export route) instead of a 400-shaped failure, the export spawn
check distinguishes repair reservations (always refused) from install ones
(op-aware), the swap lock release only unlinks a lock this process wrote so
a stale-superseded owner cannot drop the new owner's live lock, and the
frontend unload signal survives a superseding consent via read-and-clear
consumption instead of a reset.

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

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

* Finalize a stalled run when the respawn loses the install race and latch the unload signal

The Xet-stall respawn timeout now finalizes the run as a failure instead of
raising into the pump's broad finalization catch (which stranded it in a
training state with no worker), and a successful install retry ORs the
model_unloaded signal with the latched value so a failed-after-unload first
attempt still triggers rollback.

* Recheck the swap under the load gate and latch the unload before resolver checks

/load rechecks the sidecar reservation after acquiring the lifecycle gate
(an install can reserve while the load queues on it), and the dialog store
latches model_unloaded as soon as the install response arrives, before any
resolver-identity guard, so a superseded consent's unload still reaches
whichever load consumes the signal next.

* Report cleared-state unload failures, guard queued installs, and fold name tiers

A failed chat unload that still cleared the orchestrator's model state now
reports model_unloaded so the client rolls back, the installer aborts with
a 409 when a model load completed while it waited on the lifecycle gate,
and the fixed-tier name fast path consults the config mapping when a latest
sidecar is pinned so an accepted upgrade routes to the sidecar it installed
(no I/O added to the unpinned path).

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

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

* Report cleared-state unload failures and harden the spawn handshake flag

The failed-unload branch in before_swap now detects that the orchestrator
cleared its model state and reports model_unloaded before aborting (the
earlier commit claimed this fix but a scripting error dropped the edit),
the installer's queued-load check compares a load generation counter so a
same-model reload is caught, and both training spawn sites wrap everything
after the handshake in a guard that resets _spawn_in_progress on any
exception so a failed start cannot wedge is_training_active.

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

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

* Bump the load generation when the load is published, not at load start

A start-time bump is already visible when the installer snapshots mid-load,
so a same-model reload completing after the snapshot looked unchanged and
could be unloaded by the swap. The counter now increments alongside the
active_model_name publish.

* Self-heal a broken pinned sidecar, guard lazy repairs, and refresh stale retries

A valid pin whose transformers source dir vanished now triggers the repair
from the routing path (with a five minute backoff after failures) instead of
silently routing latest-only models to older tiers, the lazy repair refuses
while parent-visible chat/training/export workers are active since it has no
teardown of its own, and a version-mismatch install failure carries the
superseding release so the dialog's Retry re-requests a version that can
succeed.

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

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

* Flip latest-tier loads to 16-bit outside chat and protect export state

Training and export workers now apply the same latest-sidecar 16-bit flip
as the chat worker so a brand-new grouped-MoE architecture cannot reach bnb
4-bit through those paths, the latest-tier vision override returns None on
an inconclusive probe so a transient failure is not cached as not-vision,
and the install route refuses while an idle export checkpoint is loaded
rather than discard it with no rollback signal on a failed swap.

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

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

* Address parallel-review findings on the sidecar guards and install checks

The training route sizes latest-tier jobs 16-bit before GPU selection, the
inference subprocess spawn rechecks the swap reservation like training and
export (covering the OpenAI auto-switch path) with the typed error mapped
to a retryable 409, compat_plan blocks the install when dependency metadata
cannot be fetched instead of proceeding unverified, snapshot model-type
lists must contain only strings, and pin-marker package specs are validated
against the sidecar's own package set before ever reaching pip.

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

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

* Parent-only repairs, live-owner locks, remote-base activation, pre-teardown recheck

Lazy sidecar repairs now refuse inside worker children (whose empty backend
singletons cannot see live siblings) and run only in the parent where the
active-worker guard is real, swap-lock staleness requires the owner pid to
be dead so a slow live install is never superseded, both activation entry
points resolve a remote adapter's base model like the inference worker and
latest_tier_active_for already do, and load_model rechecks the reservation
before tearing down the old worker so losing the race keeps the current
model loaded.

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

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

* Check workers under the repair reservation and keep state on refused swaps

The lazy repair now reserves first and checks workers under the reservation
(worker starts set their active markers before rechecking, so every
interleaving aborts one side), with export ops and in-flight inference loads
counted as active. The inference pre-teardown and spawn guards refuse only
repair reservations since an install shares the load's lifecycle gate and
aborts via its queued-load snapshot, a SidecarSwapInProgress raised before
teardown no longer clears the live model mirrors, and an export spawn abort
after teardown clears current_checkpoint so the page cannot claim a loaded
checkpoint with no worker.

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

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

* Repair a present-but-incomplete latest sidecar from routing

The routing self-heal only fired when the pinned sidecar's transformers/
dir was missing. A sidecar that kept transformers/ but lost another pinned
package still routed models to the latest tier, and workers refuse
parent-only repairs, so every load failed until a manual reinstall. Routing
now validates the full pin (via _venv_dir_is_valid) and repairs any
incomplete sidecar under the same swap reservation and 5-minute backoff.

* Treat an unrepaired latest sidecar as unavailable in routing

When the pinned sidecar is incomplete and the lazy repair fails (offline,
pip failure, workers active) or is inside the backoff window, routing
returned the source dir anyway, sending models to a tier whose worker
activation is known to fail. Return None instead so models an older tier
supports keep loading there until a repair succeeds, matching the behavior
when the sidecar dir is missing entirely.

* Harden sidecar swap and repair against crash, survivor, and 16-bit paths

Reclaim a swap lock as soon as its recorded owner PID is dead instead of
waiting out the two-hour cutoff, so a crash mid-install no longer wedges
/load, training, export, and repair for hours. A lock whose PID cannot be
read yet still uses the long cutoff so the create-before-write window is
never mistaken for dead.

Probe process liveness with OpenProcess on Windows: os.kill(pid, 0) there
is CTRL_C_EVENT (a real Ctrl+C via GenerateConsoleCtrlEvent), not a
harmless check, and psutil is not always present.

Return whether _shutdown_subprocess actually killed the worker and keep the
live handle when it survives terminate/kill (an uninterruptible CUDA
syscall can outlive SIGKILL). The pre-swap liveness guard now trusts that
result, so the destructive .venv_t5_latest rename cannot proceed while a
live worker still holds sidecar modules.

Recover a sidecar stranded at .old when a swap's activation rename and its
rollback both fail: reading the pin restores it when no swap holds the
reservation, so latest-tier models are not permanently broken.

Resolve the latest tier in the parent for export loads and for explicitly
16-bit training runs, not only 4-bit ones: tier resolution self-heals an
incomplete sidecar, and repairs are parent-only, so those paths could not
recover before. Sidecar integrity and quantization are independent.

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

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

* Revert the parent-side latest-tier repair probe on training and export loads

The probe ran before the route freed VRAM, so a resident chat or export worker
made _workers_active_for_repair() refuse the parent-only repair; the route then
tore that worker down and spawned a child that also cannot repair, so an
incomplete sidecar still failed to load. Repairing correctly requires running the
repair between the worker teardown and the child spawn, decoupled from VRAM
sizing, which is a larger change tracked separately. Restore the prior behavior
so these paths match the reviewed form and do not partially attempt a repair that
cannot complete while workers are resident.

* Honor failed worker shutdowns on load and revalidate the cached latest mapping

The fresh-load paths spawned a new worker straight after _shutdown_subprocess
without checking its result, so a worker that outlived terminate/kill (a wedged
CUDA syscall) had its handle overwritten by the replacement while it still held
GPU memory, and is_worker_alive/the pre-swap guard could no longer see it. Both
the inference load and the export checkpoint load now abort when the old worker
did not exit, so the load can be retried once it does.

_config_model_types returned a cached latest mapping without re-checking the
sidecar, so a sidecar deleted or broken in-process after its first parse was
never re-validated: routing kept sending latest-only models to the stale latest
tier while activation failed. The cached latest mapping is now dropped and
re-resolved (self-healing) when the sidecar is no longer intact.

* Drop cached latest mapping when the pin is gone; keep 4-bit for custom-code fallback

_latest_sidecar_intact now returns False when the pin marker itself is gone, not
just when a pinned package is missing. Otherwise a cached latest mapping outlived
a deleted pin: _config_model_types kept returning it, so routing sent latest-only
models to a tier whose worker activation then failed (no pinned version) until
restart. It now drops the cache and re-resolves to no latest tier. The
_overlay_transformers_dir caller already gates on a present pin, so it is
unaffected.

validate_model forced 16-bit sizing whenever a PyPI upgrade was merely offered,
even for a model that can fall back to its own auto_map code. /load loads such a
model 4-bit without the install, and the install route refuses while training is
active, so 16-bit sizing here returned a VRAM 409 for the only viable 4-bit path.
The offered-upgrade flip is now gated on the absence of a custom-code fallback;
an already-active latest sidecar still always sizes 16-bit.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2026-07-15 05:25:26 -07:00

2630 lines
104 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
"""Automatic transformers version switching.
Some newer model architectures (Ministral-3, GLM-4.7-Flash, Qwen3-30B-A3B MoE,
tiny_qwen3_moe) require transformers>=5.3.0, while Gemma 4 models require a
newer 5.x sidecar. Dense NemotronH models (e.g. NVIDIA-Nemotron-3-Nano-4B) use
MLP layers that only transformers>=5.10 can parse natively, so they go on the
5.10 sidecar too. Everything else needs the default 4.57.x that ships with
Unsloth.
Two separate target directories are maintained:
- .venv_t5_530/ — transformers 5.3.0 (Ministral-3, GLM, Qwen3 MoE, etc.)
- .venv_t5_550/ — transformers 5.5.0 (Gemma 4)
- .venv_t5_510/ — transformers 5.10.2 (Gemma 4 Unified / 12B)
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.
Strategy:
Training and inference run in subprocesses that activate the correct version
via sys.path (prepending the appropriate .venv_t5_*/ directory). See:
- core/training/worker.py
- core/inference/worker.py
For export (still in-process), ensure_transformers_version() does a lightweight
sys.path swap using the same directories pre-installed by setup.sh.
"""
import ast
import importlib
import importlib.util
import json
import structlog
from loggers import get_logger
import os
import re
import shutil
import subprocess
import sys
import threading
import time
from pathlib import Path
from utils.native_path_leases import child_env_without_native_path_secret
from utils.subprocess_compat import (
windows_hidden_subprocess_kwargs as _windows_hidden_subprocess_kwargs,
)
logger = get_logger(__name__)
_OFFLINE_TRUE_VALUES = {"1", "true", "yes", "on"}
def _env_offline() -> bool:
"""True if an HF offline env var is truthy (canonical strip+lower parse); gates the urllib fetches below."""
return (
os.environ.get("HF_HUB_OFFLINE", "").strip().lower() in _OFFLINE_TRUE_VALUES
or os.environ.get("TRANSFORMERS_OFFLINE", "").strip().lower() in _OFFLINE_TRUE_VALUES
)
def hf_endpoint_unreachable(timeout: int = 3) -> bool:
"""Bounded reachability probe to the HF endpoint. A HEAD request runs in a daemon thread
joined with a deadline, so a resolver blackhole cannot block past ~timeout+1s. True if
unreachable. urllib natively honors *_PROXY / NO_PROXY, so this verifies real egress
(the proxy can reach HF), not just that the proxy is up. No ML imports, so it is safe to
call before transformers version activation. Mirrors the probe in export._hf_offline."""
import ssl
import threading
import urllib.error
import urllib.request
endpoint = os.environ.get("HF_ENDPOINT", "https://huggingface.co")
if "://" not in endpoint:
endpoint = "https://" + endpoint
result = {"online": False}
def _probe():
try:
req = urllib.request.Request(endpoint, method = "HEAD")
with urllib.request.urlopen(req, timeout = timeout):
result["online"] = True
except urllib.error.HTTPError as exc:
# The server/proxy answered: reachable unless it is a gateway error.
result["online"] = exc.code not in (502, 503, 504)
except urllib.error.URLError as exc:
# A TLS/cert failure means we DID reach the server; treat as reachable so the real
# load surfaces it (consistent with _is_offline_related_error not retrying TLS).
result["online"] = isinstance(exc.reason, ssl.SSLError)
except ssl.SSLError:
result["online"] = True
except Exception:
result["online"] = False
t = threading.Thread(target = _probe, daemon = True)
t.start()
t.join(timeout + 1)
return t.is_alive() or not result["online"]
def _safe_is_file(p: Path) -> bool:
"""``p.is_file()`` returning False instead of raising on a bad path."""
try:
return p.is_file()
except (OSError, ValueError):
return False
def _safe_is_dir(p: Path) -> bool:
"""``p.is_dir()`` returning False instead of raising on a bad path."""
try:
return p.is_dir()
except (OSError, ValueError):
return False
# ---------------------------------------------------------------------------
# Detection
# ---------------------------------------------------------------------------
# Lowercase substrings — any match in the lowered model name needs transformers 5.3.0.
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
"qwen3.5", # Qwen3.5 family (35B-A3B, etc.)
"qwen3-next", # Qwen3-Next and variants
"tiny_qwen3_moe", # imdatta0/tiny_qwen3_moe_2.8B_0.7B
"lfm2.5-vl-450m", # LiquidAI/LFM2.5-VL-450M
)
# Lowercase substrings for models that require transformers 5.10.x (checked first).
TRANSFORMERS_510_MODEL_SUBSTRINGS: tuple[str, ...] = (
"gemma-4-12b", # Gemma 4 Unified 12B
"gemma4-12b",
)
# Lowercase substrings for models that require the Gemma 4 transformers 5.5 sidecar.
TRANSFORMERS_550_MODEL_SUBSTRINGS: tuple[str, ...] = (
"gemma-4", # Gemma-4 (E2B-it, E4B-it, 31B-it, 26B-A4B-it)
"gemma4", # Gemma-4 alternate naming
"qwen3.6",
)
# Architecture classes / model_type values that require transformers 5.10.x.
# Checked via config.json (local or HuggingFace).
_TRANSFORMERS_510_ARCHITECTURES: set[str] = {
"Gemma4UnifiedForConditionalGeneration",
"Gemma4AssistantForCausalLM",
"Gemma4UnifiedAssistantForCausalLM",
}
_TRANSFORMERS_510_MODEL_TYPES: set[str] = {
"gemma4_unified",
"gemma4_assistant",
"gemma4_unified_assistant",
}
# Architecture classes / model_type values that require transformers 5.5.0.
# Checked via config.json (local or HuggingFace).
_TRANSFORMERS_550_ARCHITECTURES: set[str] = {
"Gemma4ForConditionalGeneration",
}
_TRANSFORMERS_550_MODEL_TYPES: set[str] = {
"gemma4",
}
# Architecture classes / model_type values that require transformers 5.3.0.
# Checked via config.json (local or HuggingFace).
_TRANSFORMERS_530_ARCHITECTURES: set[str] = {
"Qwen3_5ForCausalLM",
"Qwen3_5ForConditionalGeneration",
"Qwen3_5MoeForCausalLM",
"Qwen3_5MoeForConditionalGeneration",
"Qwen3MoeForCausalLM",
"Qwen3NextForCausalLM",
"Glm4MoeLiteForCausalLM",
"Lfm2MoeForCausalLM",
"Lfm2VlForConditionalGeneration",
}
_TRANSFORMERS_530_MODEL_TYPES: set[str] = {
"qwen3_5",
"qwen3_5_text",
"qwen3_5_moe",
"qwen3_5_moe_text",
"qwen3_moe",
"qwen3_next",
"glm4_moe_lite",
"lfm2_moe",
"lfm2_vl",
}
# Tokenizer classes that only exist in transformers>=5.x.
_TRANSFORMERS_5_TOKENIZER_CLASSES: set[str] = {
"TokenizersBackend",
}
# Caches keyed on (model_name, token-hash) so authed/unauthed reads stay separate (a
# gated/private repo's unauthenticated miss must not poison a later authenticated lookup).
# Offline negatives are NOT written (see the _env_offline branches) so they cannot poison a
# later online read in this persistent worker.
_tokenizer_class_cache: dict[tuple[str, str | None], bool] = {}
_config_json_cache: dict[tuple[str, str | None], dict | None] = {}
_config_needs_510_cache: dict[tuple[str, str | None], bool] = {}
_config_needs_550_cache: dict[tuple[str, str | None], bool] = {}
_config_needs_530_cache: dict[tuple[str, str | None], bool] = {}
# AutoConfig-probe tier cache for the process lifetime (cleared on restart), keyed by
# model_name plus a local config.json signature (see _probe_cache_key) so an overwritten
# checkpoint re-probes. Not keyed by Hub sha, so the probe never imports huggingface_hub
# before a worker's sidecar venv is activated (which would pin the wrong hub).
_probe_tier_cache: dict[str, str] = {}
# Versions
TRANSFORMERS_510_VERSION = "5.10.2"
TRANSFORMERS_550_VERSION = "5.5.0"
TRANSFORMERS_530_VERSION = "5.3.0"
TRANSFORMERS_DEFAULT_VERSION = "4.57.6"
# Backwards-compat alias — points to the highest 5.x tier.
# Consumers should prefer TRANSFORMERS_510_VERSION / TRANSFORMERS_550_VERSION /
# TRANSFORMERS_530_VERSION.
TRANSFORMERS_5_VERSION = TRANSFORMERS_510_VERSION
# Pre-installed directories — created by setup.sh / setup.ps1.
from utils.paths.storage_roots import studio_root as _studio_root # noqa: E402
_VENV_T5_530_DIR = str(_studio_root() / ".venv_t5_530")
_VENV_T5_550_DIR = str(_studio_root() / ".venv_t5_550")
_VENV_T5_510_DIR = str(_studio_root() / ".venv_t5_510")
# Backwards-compat alias
_VENV_T5_DIR = _VENV_T5_550_DIR
# llm-compressor-main shadow for FP8/FP4 export of newer-transformers models. Like the .venv_t5_*
# sidecars but also shadows llm-compressor main + compressed-tensors; installed --no-deps so it
# reuses the workspace torch (torch-agnostic).
_VENV_LLMCOMPRESSOR_DIR = str(_studio_root() / ".venv_llmcompressor")
# User-consented "latest transformers" sidecar (utils/transformers_latest.py); pinned version in a marker file.
_VENV_T5_LATEST_DIR = str(_studio_root() / ".venv_t5_latest")
_LATEST_PIN_MARKER = ".unsloth_pinned_transformers"
# Tier precedence: higher rank wins in _higher_tier. "latest" outranks every fixed tier.
_TIER_RANK = {"default": 0, "530": 1, "550": 2, "510": 3, "latest": 4}
def _higher_tier(a: str, b: str) -> str:
return a if _TIER_RANK.get(a, 0) >= _TIER_RANK.get(b, 0) else b
def activate_transformers_for_subprocess(model_name: str, hf_token: str | None = None) -> None:
"""Activate the correct transformers version in a subprocess worker.
Call BEFORE any ML imports. Resolves LoRA adapters to their base model,
determines the required tier, prepends the appropriate ``.venv_t5_*`` dir to
``sys.path``, and propagates it via ``PYTHONPATH`` for child processes
(e.g. GGUF converter). Used by training, inference, and export workers.
``hf_token`` is forwarded to tier detection so a gated/private model whose only 5.x
signal is an authenticated config/tokenizer reaches the right sidecar, not the default.
"""
# Pre-resolve LoRA adapters (local dir or remote adapter repo); full checkpoints
# go to get_transformers_tier so their local config.json drives the tier (a full
# checkpoint with a private/offline _name_or_path must not resolve to an
# unreachable HF id and skip its own config). Remote adapters activate for their
# BASE model, matching latest_tier_active_for and the inference worker.
if _is_lora_adapter_dir(Path(model_name)):
resolved = _resolve_base_model(model_name)
else:
resolved = _remote_lora_base(model_name, hf_token = hf_token) or model_name
tier = get_transformers_tier(resolved, hf_token)
if model_name != resolved and _safe_is_file(Path(model_name) / "config.json"):
# Gate on a real local config.json: a checkpoint carries config the base may not
# surface, but path names alone must not upgrade a plain adapter.
tier = _higher_tier(tier, get_transformers_tier(model_name, hf_token))
if tier == "latest":
pinned = latest_venv_pinned_version()
if pinned is None or not _ensure_venv_t5_latest_exists():
raise RuntimeError(
f"Cannot activate the latest-transformers sidecar: "
f".venv_t5_latest missing or unpinned at {_VENV_T5_LATEST_DIR}"
)
if _VENV_T5_LATEST_DIR not in sys.path:
sys.path.insert(0, _VENV_T5_LATEST_DIR)
logger.info(
"Prepended transformers %s venv to sys.path from %s "
"(path only; the loaded version is confirmed later by "
"'Subprocess loaded transformers ...' on first import)",
pinned,
_VENV_T5_LATEST_DIR,
)
_pp = os.environ.get("PYTHONPATH", "")
os.environ["PYTHONPATH"] = _VENV_T5_LATEST_DIR + (os.pathsep + _pp if _pp else "")
elif tier == "510":
if not _ensure_venv_t5_510_exists():
raise RuntimeError(
f"Cannot activate transformers {TRANSFORMERS_510_VERSION}: "
f".venv_t5_510 missing at {_VENV_T5_510_DIR}"
)
if _VENV_T5_510_DIR not in sys.path:
sys.path.insert(0, _VENV_T5_510_DIR)
logger.info(
"Prepended transformers %s venv to sys.path from %s "
"(path only; the loaded version is confirmed later by "
"'Subprocess loaded transformers ...' on first import)",
TRANSFORMERS_510_VERSION,
_VENV_T5_510_DIR,
)
_pp = os.environ.get("PYTHONPATH", "")
os.environ["PYTHONPATH"] = _VENV_T5_510_DIR + (os.pathsep + _pp if _pp else "")
elif tier == "550":
if not _ensure_venv_t5_550_exists():
raise RuntimeError(
f"Cannot activate transformers {TRANSFORMERS_550_VERSION}: "
f".venv_t5_550 missing at {_VENV_T5_550_DIR}"
)
if _VENV_T5_550_DIR not in sys.path:
sys.path.insert(0, _VENV_T5_550_DIR)
logger.info(
"Prepended transformers %s venv to sys.path from %s "
"(path only; the loaded version is confirmed later by "
"'Subprocess loaded transformers ...' on first import)",
TRANSFORMERS_550_VERSION,
_VENV_T5_550_DIR,
)
_pp = os.environ.get("PYTHONPATH", "")
os.environ["PYTHONPATH"] = _VENV_T5_550_DIR + (os.pathsep + _pp if _pp else "")
elif tier == "530":
if not _ensure_venv_t5_530_exists():
raise RuntimeError(
f"Cannot activate transformers 5.3.0: "
f".venv_t5_530 missing at {_VENV_T5_530_DIR}"
)
if _VENV_T5_530_DIR not in sys.path:
sys.path.insert(0, _VENV_T5_530_DIR)
logger.info(
"Prepended transformers %s venv to sys.path from %s "
"(path only; the loaded version is confirmed later by "
"'Subprocess loaded transformers ...' on first import)",
TRANSFORMERS_530_VERSION,
_VENV_T5_530_DIR,
)
_pp = os.environ.get("PYTHONPATH", "")
os.environ["PYTHONPATH"] = _VENV_T5_530_DIR + (os.pathsep + _pp if _pp else "")
else:
logger.info("Using default transformers (4.57.x) for %s", model_name)
def latest_tier_active_for(model_name: str, hf_token: str | None = None) -> bool:
"""True when *model_name* routes to the consented latest-transformers sidecar.
Mirrors the inference worker's pre-activation resolution (local adapter dir,
then a remote adapter's Hub adapter_config.json). ``latest`` only wins when
the sidecar exists with a valid pin, i.e. exactly the loads that will import
the newest release. Never raises: any resolution failure returns False so
callers treat the model as a known tier.
"""
try:
# No consented sidecar pin means nothing routes to latest; return before
# any resolution so the common case costs no config or network reads.
if latest_venv_pinned_version() is None:
return False
if _is_lora_adapter_dir(Path(model_name)):
resolved = _resolve_base_model(model_name)
else:
# A remote LoRA activates the sidecar for its BASE model; sizing and the
# worker's 4-bit guard must see that base too, not the adapter repo.
resolved = _remote_lora_base(model_name, hf_token = hf_token) or model_name
tier = get_transformers_tier(resolved, hf_token)
if model_name != resolved and _safe_is_file(Path(model_name) / "config.json"):
tier = _higher_tier(tier, get_transformers_tier(model_name, hf_token))
return tier == "latest"
except Exception:
return False
def _has_adapter_weights(path: Path) -> bool:
"""True if *path* holds LoRA adapter weight files (``adapter_model.*``)."""
try:
return any(path.glob("adapter_model*.safetensors")) or any(path.glob("adapter_model*.bin"))
except OSError:
return False
def _is_lora_adapter_dir(path: Path) -> bool:
"""True if *path* is a local LoRA dir (adapter_config.json or adapter_model-only
weights). Import-light so it can run during subprocess activation."""
try:
if not path.is_dir():
return False
return (path / "adapter_config.json").is_file() or _has_adapter_weights(path)
except OSError:
return False
def _is_same_path(value: str, local_path: Path) -> bool:
"""True if *value* resolves to *local_path* (relative/absolute/symlink)."""
if value == str(local_path):
return True
try:
return os.path.realpath(value) == os.path.realpath(str(local_path))
except OSError:
return False
def _resolve_base_model(model_name: str) -> str:
"""If *model_name* points to a LoRA adapter, return its base model.
Checks ``adapter_config.json`` locally first. Only calls the heavier
``get_base_model_from_lora`` for real local directories (avoids noisy
warnings for plain HF model IDs). Returns *model_name* unchanged if not a
LoRA adapter.
"""
# --- Fast local check ---------------------------------------------------
local_path = Path(model_name)
adapter_cfg_path = local_path / "adapter_config.json"
if _safe_is_file(adapter_cfg_path):
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)
# --- config.json fallback (works for both LoRA and full fine-tune) ------
config_json_path = local_path / "config.json"
if _safe_is_file(config_json_path):
try:
with open(config_json_path) as f:
cfg = json.load(f)
# Unsloth writes model_name, HF writes _name_or_path; skip a self-reference.
for _key in ("model_name", "_name_or_path"):
base = cfg.get(_key)
if isinstance(base, str) and base and not _is_same_path(base, local_path):
logger.info(
"Resolved checkpoint '%s' → base model '%s' (via config.json)",
model_name,
base,
)
return base
except Exception as exc:
logger.debug("Could not read %s: %s", config_json_path, exc)
# Gate the heavy resolver on adapter_config.json: importing utils.models pulls
# in transformers, which would pin the default into sys.modules before the
# sidecar venv is prepended during activation.
if _safe_is_file(adapter_cfg_path):
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,
)
# adapter_model-only LoRA: no config to resolve from, so use the
# unsloth_<model>_<timestamp> dir-name convention (pure string parse).
if local_path.name.startswith("unsloth_") and _has_adapter_weights(local_path):
parts = local_path.name.split("_")
if len(parts) >= 2: # unsloth_<model...>_<timestamp>
base = "unsloth/" + "_".join(parts[1:-1])
logger.info(
"Resolved adapter-only LoRA '%s' → base model '%s' (via directory name)",
model_name,
base,
)
return base
return model_name
def _token_cache_key(model_name: str, hf_token: str | None) -> tuple[str, str | None]:
"""Cache key that keeps authenticated and unauthenticated reads separate, so an
unauthenticated miss on a gated/private repo never poisons a later authed lookup."""
import hashlib
tok = hashlib.sha256(hf_token.encode()).hexdigest()[:16] if hf_token else None
return (model_name, tok)
def _is_canonical_repo_id(model_name: str) -> bool:
"""True for a canonical ``owner/repo`` Hub id (not a local or relative path)."""
return bool(
model_name
and model_name.count("/") == 1
and model_name[0] not in "/.~"
and "\\" not in model_name
)
def _adapter_base_from_hf_cache(model_name: str) -> str | None:
"""``base_model_name_or_path`` from a remote adapter's cached ``adapter_config.json``.
Stdlib path resolution of the HF hub cache (no ``huggingface_hub`` import); the newest
snapshot wins. Lets an offline cached LoRA still resolve its base.
"""
if not _is_canonical_repo_id(model_name):
return None
hub = (
os.environ.get("HF_HUB_CACHE")
or os.environ.get("HUGGINGFACE_HUB_CACHE")
or os.path.join(
os.environ.get("HF_HOME") or os.path.expanduser("~/.cache/huggingface"), "hub"
)
)
repo_dir = Path(hub) / ("models--" + model_name.replace("/", "--"))
candidates = []
ref_main = repo_dir / "refs" / "main"
def _mtime(p: Path) -> float:
try:
return p.stat().st_mtime
except OSError:
return 0.0
try:
if ref_main.is_file():
candidates.append(
repo_dir / "snapshots" / ref_main.read_text().strip() / "adapter_config.json"
)
candidates += sorted(
repo_dir.glob("snapshots/*/adapter_config.json"), key = _mtime, reverse = True
)
for cfg_path in candidates:
if cfg_path.is_file():
base = json.loads(cfg_path.read_text()).get("base_model_name_or_path")
return base or None
except Exception as exc:
logger.debug("HF cache adapter_config.json lookup failed for '%s': %s", model_name, exc)
return None
def _remote_lora_base(model_name: str, hf_token: str | None = None) -> str | None:
"""``base_model_name_or_path`` from a remote adapter's ``adapter_config.json``, or None.
Raw HTTP (no huggingface_hub / transformers import), so a remote LoRA's base is known
before any ML import. Offline (or on a transient failure) it reads the local hub cache,
since a cached adapter is still loadable; a definitive 404 returns None (the repo is not
a LoRA) rather than a stale cached base. Skipped for local/non-canonical ids.
"""
if not _is_canonical_repo_id(model_name):
return None
try:
from utils.paths import is_local_path
if is_local_path(model_name):
return None # an existing relative path is a local checkpoint, not a Hub repo
except Exception:
pass
if _env_offline():
return _adapter_base_from_hf_cache(model_name)
import urllib.error
import urllib.request
endpoint = (os.environ.get("HF_ENDPOINT") or "https://huggingface.co").rstrip("/")
url = f"{endpoint}/{model_name}/raw/main/adapter_config.json"
headers = {"User-Agent": "unsloth-studio"}
if hf_token:
headers["Authorization"] = f"Bearer {hf_token}"
try:
req = urllib.request.Request(url, headers = headers)
with urllib.request.urlopen(req, timeout = 10) as resp:
cfg = json.loads(resp.read().decode())
base = cfg.get("base_model_name_or_path")
if base:
logger.info("Resolved remote LoRA adapter '%s' → base model '%s'", model_name, base)
return base or None
except urllib.error.HTTPError as exc:
if exc.code == 404:
return None # definitively not a LoRA; do not serve a stale cached base
logger.debug("adapter_config.json fetch failed for '%s': %s", model_name, exc)
return _adapter_base_from_hf_cache(model_name)
except Exception as exc:
logger.debug("No remote adapter_config.json for '%s': %s", model_name, exc)
return _adapter_base_from_hf_cache(model_name)
def _check_tokenizer_config_needs_v5(model_name: str, hf_token: str | None = None) -> bool:
"""True if the model's tokenizer_class requires transformers 5.x.
Checks local tokenizer_config.json, else fetches from HuggingFace (authenticated
with ``hf_token`` so gated/private repos resolve). Cached in
``_tokenizer_class_cache``, keyed by (model, token) so an unauthenticated miss does
not poison a later authed read. Returns False on any network/parse error
(fail-open to default version).
"""
cache_key = _token_cache_key(model_name, hf_token)
if cache_key in _tokenizer_class_cache:
return _tokenizer_class_cache[cache_key]
# --- Check local tokenizer_config.json first ---------------------------
local_path = Path(model_name)
local_tc = local_path / "tokenizer_config.json"
if _safe_is_file(local_tc):
try:
with open(local_tc) as f:
data = json.load(f)
tokenizer_class = data.get("tokenizer_class", "")
result = tokenizer_class in _TRANSFORMERS_5_TOKENIZER_CLASSES
if result:
logger.info(
"Local check: %s uses tokenizer_class=%s (requires transformers 5.x)",
model_name,
tokenizer_class,
)
_tokenizer_class_cache[cache_key] = result
return result
except Exception as exc:
logger.debug("Could not read %s: %s", local_tc, exc)
# Local checkpoint without the file yet: don't fetch it as a Hub id or cache the miss,
# so a file written later this process (in-progress checkpoint) is read next call.
if _safe_is_dir(local_path):
return False
# Offline: skip the 10s urllib fetch (fail-open to lower tier). Do NOT cache this
# assumed negative, so a later online read of the same id re-fetches the real value.
if _env_offline():
return False
# --- Fall back to fetching from HuggingFace ----------------------------
import urllib.request
url = f"https://huggingface.co/{model_name}/raw/main/tokenizer_config.json"
headers = {"User-Agent": "unsloth-studio"}
if hf_token:
headers["Authorization"] = f"Bearer {hf_token}"
try:
req = urllib.request.Request(url, headers = headers)
with urllib.request.urlopen(req, timeout = 10) as resp:
data = json.loads(resp.read().decode())
tokenizer_class = data.get("tokenizer_class", "")
result = tokenizer_class in _TRANSFORMERS_5_TOKENIZER_CLASSES
if result:
logger.info(
"Dynamic check: %s uses tokenizer_class=%s (requires transformers 5.x)",
model_name,
tokenizer_class,
)
_tokenizer_class_cache[cache_key] = result
return result
except Exception as exc:
logger.debug("Could not fetch tokenizer_config.json for '%s': %s", model_name, exc)
_tokenizer_class_cache[cache_key] = False
return False
def _safe_mtime(path: Path) -> float:
try:
return path.stat().st_mtime
except OSError:
return 0.0
def _config_json_from_hf_cache(model_name: str) -> dict | None:
"""Parsed ``config.json`` from the local HF hub cache, or None.
Stdlib-only path resolution (no ``huggingface_hub`` import) so tier detection never
loads the default-env hub before a sidecar venv is activated.
"""
# Only a canonical ``owner/repo`` Hub id maps to a cache dir; reject local paths.
if not model_name or model_name.count("/") != 1 or model_name[0] in "/.~" or "\\" in model_name:
return None
hub = (
os.environ.get("HF_HUB_CACHE")
or os.environ.get("HUGGINGFACE_HUB_CACHE")
or os.path.join(
os.environ.get("HF_HOME") or os.path.expanduser("~/.cache/huggingface"), "hub"
)
)
repo_dir = Path(hub) / ("models--" + model_name.replace("/", "--"))
candidates = []
ref_main = repo_dir / "refs" / "main"
try:
if ref_main.is_file():
candidates.append(repo_dir / "snapshots" / ref_main.read_text().strip() / "config.json")
# No refs/main (e.g. commit-pinned downloads): newest snapshot by mtime, not a stale
# lexicographically-first SHA, matching what the Hub cache would actually load.
candidates += sorted(
repo_dir.glob("snapshots/*/config.json"), key = _safe_mtime, reverse = True
)
for cfg_path in candidates:
if cfg_path.is_file():
with open(cfg_path) as f:
return json.load(f)
except Exception as exc:
logger.debug("HF cache config.json lookup failed for '%s': %s", model_name, exc)
return None
def _load_config_json(model_name: str, hf_token: str | None = None) -> dict | None:
"""Return parsed ``config.json`` for *model_name*, checking local files first.
``hf_token`` authenticates the raw fetch so gated/private repos resolve. The
cache is keyed on the token so an unauthenticated miss never poisons a later
authenticated read. The HF hub cache is consulted only offline or after a failed
network fetch, so an online read never serves stale metadata.
"""
import hashlib
tok = hashlib.sha256(hf_token.encode()).hexdigest()[:16] if hf_token else None
cache_key = (model_name, tok)
if cache_key in _config_json_cache:
return _config_json_cache[cache_key]
local_cfg = Path(model_name) / "config.json"
if _safe_is_file(local_cfg):
try:
with open(local_cfg) as f:
cfg = json.load(f)
_config_json_cache[cache_key] = cfg
return cfg
except Exception as exc:
logger.debug("Could not read %s: %s", local_cfg, exc)
_config_json_cache[cache_key] = None
return None
# Local checkpoint without the file yet: don't fetch it as a Hub id or cache the miss,
# so a file written later this process (in-progress checkpoint) is read next call.
if _safe_is_dir(Path(model_name)):
return None
if _env_offline():
# No network: a previously downloaded repo can still tier from the hub cache. Cache a
# real hit, but never the miss (None) so a later online read still fetches the config.
cfg = _config_json_from_hf_cache(model_name)
if cfg is not None:
_config_json_cache[cache_key] = cfg
return cfg
import urllib.error
import urllib.request
url = f"https://huggingface.co/{model_name}/raw/main/config.json"
headers = {"User-Agent": "unsloth-studio"}
if hf_token:
headers["Authorization"] = f"Bearer {hf_token}"
try:
req = urllib.request.Request(url, headers = headers)
with urllib.request.urlopen(req, timeout = 10) as resp:
cfg = json.loads(resp.read().decode())
_config_json_cache[cache_key] = cfg
return cfg
except urllib.error.HTTPError as exc:
# 401/403/404 is a definitive access answer: never serve another caller's cached
# private metadata to an unauthenticated/wrong-token request.
if exc.code in (401, 403, 404):
logger.debug("config.json access denied for '%s': %s", model_name, exc)
return None
logger.debug("Could not fetch config.json for '%s': %s", model_name, exc)
return _config_json_from_hf_cache(model_name)
except Exception as exc:
logger.debug("Could not fetch config.json for '%s': %s", model_name, exc)
# Transient: serve the hub cache uncached so the next call retries the network.
return _config_json_from_hf_cache(model_name)
def _config_json_is_definitive(model_name: str, hf_token: str | None = None) -> bool:
"""True if the last ``_load_config_json`` read for this model+token was cached
(definitive), not a transient fallback (not stored, so callers re-check next call)."""
return _token_cache_key(model_name, hf_token) in _config_json_cache
def _config_matches_tier(cfg: dict, architectures: set[str], model_types: set[str]) -> bool:
# Defensive: a malformed config may carry non-string values (e.g. list model_type).
archs = cfg.get("architectures")
if isinstance(archs, (list, tuple)) and any(a in architectures for a in archs):
return True
mt = cfg.get("model_type")
return isinstance(mt, str) and mt in model_types
def _config_needs_550(cfg: dict) -> bool:
return _config_matches_tier(
cfg,
_TRANSFORMERS_550_ARCHITECTURES,
_TRANSFORMERS_550_MODEL_TYPES,
)
_NESTED_CONFIG_KEYS = ("llm_config", "text_config", "language_config", "thinker_config")
def _nemotron_h_needs_mlp_support(cfg: dict) -> bool:
"""True for a dense NemotronH config using MLP (``-``) layers.
transformers only gained ``-`` -> ``mlp`` in 5.10; 5.3/5.5 raise ``KeyError: '-'``.
Read from ``hybrid_override_pattern`` or ``layers_block_type``, recursing into nested
language configs (VL wrappers hold the dense LM under ``llm_config``/``text_config``).
"""
if not isinstance(cfg, dict):
return False
if cfg.get("model_type") == "nemotron_h":
pattern = cfg.get("hybrid_override_pattern")
if isinstance(pattern, str) and "-" in pattern:
return True
block_types = cfg.get("layers_block_type")
if isinstance(block_types, (list, tuple)) and "mlp" in block_types:
return True
return any(_nemotron_h_needs_mlp_support(cfg.get(key)) for key in _NESTED_CONFIG_KEYS)
def _config_needs_510(cfg: dict) -> bool:
if _config_matches_tier(
cfg,
_TRANSFORMERS_510_ARCHITECTURES,
_TRANSFORMERS_510_MODEL_TYPES,
):
return True
return _nemotron_h_needs_mlp_support(cfg)
def _config_needs_530(cfg: dict) -> bool:
return _config_matches_tier(
cfg,
_TRANSFORMERS_530_ARCHITECTURES,
_TRANSFORMERS_530_MODEL_TYPES,
)
def _check_config_needs_550(model_name: str, hf_token: str | None = None) -> bool:
"""True if ``config.json`` needs transformers 5.5.0 (e.g. Gemma 4). Local first, else
fetched (authenticated with ``hf_token``); cached by (model, token) only for a definitive
read so a transient miss retries. False on error.
"""
cache_key = _token_cache_key(model_name, hf_token)
if cache_key in _config_needs_550_cache:
return _config_needs_550_cache[cache_key]
cfg = _load_config_json(model_name, hf_token)
result = bool(cfg) and _config_needs_550(cfg)
if result:
logger.info(
"config.json check: %s needs transformers %s (architectures=%s, model_type=%s)",
model_name,
TRANSFORMERS_550_VERSION,
cfg.get("architectures", []),
cfg.get("model_type"),
)
if _config_json_is_definitive(model_name, hf_token):
_config_needs_550_cache[cache_key] = result
return result
def _check_config_needs_530(model_name: str, hf_token: str | None = None) -> bool:
"""True if ``config.json`` needs transformers 5.3.0 (Qwen3.5, Qwen3 MoE, GLM-4.7, LFM2.5-VL).
Local first, else fetched (authenticated with ``hf_token``); cached by (model, token) only
for a definitive read so a transient miss retries. False on error.
"""
cache_key = _token_cache_key(model_name, hf_token)
if cache_key in _config_needs_530_cache:
return _config_needs_530_cache[cache_key]
cfg = _load_config_json(model_name, hf_token)
result = bool(cfg) and _config_needs_530(cfg)
if result:
logger.info(
"config.json check: %s needs transformers %s (architectures=%s, model_type=%s)",
model_name,
TRANSFORMERS_530_VERSION,
cfg.get("architectures", []),
cfg.get("model_type"),
)
if _config_json_is_definitive(model_name, hf_token):
_config_needs_530_cache[cache_key] = result
return result
def _check_config_needs_510(model_name: str, hf_token: str | None = None) -> bool:
"""Check ``config.json`` for Gemma 4 Unified / 12B architectures (authenticated with
``hf_token``; cached by (model, token) only for a definitive read)."""
cache_key = _token_cache_key(model_name, hf_token)
if cache_key in _config_needs_510_cache:
return _config_needs_510_cache[cache_key]
cfg = _load_config_json(model_name, hf_token)
result = bool(cfg) and _config_needs_510(cfg)
if result:
logger.info(
"config.json check: %s needs transformers %s (architectures=%s, model_type=%s)",
model_name,
TRANSFORMERS_510_VERSION,
cfg.get("architectures", []),
cfg.get("model_type"),
)
if _config_json_is_definitive(model_name, hf_token):
_config_needs_510_cache[cache_key] = result
return result
def _config_saved_by_transformers_5(cfg: dict | None) -> bool:
"""True if ``config.json``'s ``transformers_version`` is >= 5. Only a cheap "worth
probing" hint (the saving version, not the minimum to load); the default-first probe
decides the actual tier."""
if not isinstance(cfg, dict):
return False
ver = cfg.get("transformers_version")
if not isinstance(ver, str):
return False
try:
return int(ver.strip().split(".", 1)[0]) >= 5
except ValueError:
return False
def _cached_config_json(model_name: str, hf_token: str | None) -> dict | None:
"""Already-fetched config.json from the in-process cache (no new fetch); the tier checks
above populate it, and a miss just skips the version-field probe."""
return _config_json_cache.get(_token_cache_key(model_name, hf_token))
# --- Static tier from CONFIG_MAPPING_NAMES (AST only: no import/network/exec) ---
# A model_type absent from an overlay's mapping can't load there. Parse each sidecar's
# config map from source and pick the lowest tier that ships it, so a new arch routes
# correctly with no per-model table edit. Only ever upgrades default, never lowers.
_config_mapping_cache: dict[str, frozenset[str]] = {}
def _latest_tier_disabled() -> bool:
"""Kill switch shared with utils.transformers_latest: lets operators roll
back a provisioned latest sidecar without deleting files."""
return os.environ.get("UNSLOTH_STUDIO_NO_LATEST_TRANSFORMERS", "").strip().lower() in (
"1",
"true",
"yes",
"on",
)
# Failed lazy repairs back off so a broken sidecar can't turn every routing
# call into a pip install attempt.
_latest_repair_failed_at: float = 0.0
_LATEST_REPAIR_BACKOFF_SECS = 5 * 60
def _latest_sidecar_intact() -> bool:
"""The pinned latest sidecar exists with its transformers dir and every pinned
package. False when the pin itself is gone: a cached 'latest' mapping must then be
dropped (routing re-resolves to no latest tier), not trusted, and a sidecar that kept
transformers/ but lost a pinned package must self-heal rather than route models to a
latest tier that fails activation in workers, which refuse parent-only repairs.
(_overlay_transformers_dir only calls this after gating on a present pin, so the
pin-missing case here is the cache-revalidation caller whose pin was deleted after
the mapping was first cached.)"""
pin = _latest_pin_data()
if pin is None:
return False
return _venv_dir_is_valid(_VENV_T5_LATEST_DIR, tuple(pin["packages"]))
def _overlay_transformers_dir(tier: str) -> str | None:
"""transformers source dir for a tier, located without importing it."""
global _latest_repair_failed_at
if tier != "default":
# latest requires a valid pin and the kill switch off.
if tier == "latest" and (_latest_tier_disabled() or latest_venv_pinned_version() is None):
return None
root = {
"530": _VENV_T5_530_DIR,
"550": _VENV_T5_550_DIR,
"510": _VENV_T5_510_DIR,
"latest": _VENV_T5_LATEST_DIR,
}.get(tier)
src = os.path.join(root, "transformers") if root else None
if src and tier == "latest" and not _latest_sidecar_intact():
# A valid pin whose sidecar vanished or lost a pinned package (partial
# deletion, disk issue, interrupted external edits) must self-heal, or
# latest-only models either silently route to older tiers or reach a
# worker that cannot repair, failing every load until a manual
# reinstall. Repair under the swap reservation; back off after a
# failure so routing calls don't hammer pip.
repaired = False
if time.time() - _latest_repair_failed_at >= _LATEST_REPAIR_BACKOFF_SECS:
if _ensure_venv_t5_latest_exists():
_latest_repair_failed_at = 0.0
repaired = True
else:
_latest_repair_failed_at = time.time()
if not repaired:
# Still broken: treat the overlay as unavailable rather than route
# models to a tier whose worker activation is known to fail. Models
# an older tier supports keep loading there until a repair succeeds,
# matching the behavior when the sidecar dir is missing entirely.
return None
return src if src and _safe_is_dir(Path(src)) else None
# default: the base 4.x transformers. find_spec resolves to a 5.x sidecar if one
# is already on sys.path, so skip any .venv_t5_* / llmcompressor overlay dir.
sidecars = tuple(
os.path.abspath(d) + os.sep
for d in (
_VENV_T5_530_DIR,
_VENV_T5_550_DIR,
_VENV_T5_510_DIR,
_VENV_T5_LATEST_DIR,
_VENV_LLMCOMPRESSOR_DIR,
)
)
candidates = []
try:
spec = importlib.util.find_spec("transformers")
if spec and spec.origin:
candidates.append(os.path.dirname(spec.origin))
except Exception:
pass
candidates += [os.path.join(e, "transformers") for e in sys.path if e]
for c in candidates:
if _safe_is_dir(Path(c)) and not os.path.abspath(c).startswith(sidecars):
return c
return None
def _mapping_first_keys(value: ast.AST) -> set[str]:
"""First keys of a dict literal, or of an OrderedDict(...)/dict(...)/.update(...)
built from 2-tuple lists and **{...} unpacking."""
def keys_of(node):
if isinstance(node, ast.Dict):
return list(node.keys)
if isinstance(node, (ast.List, ast.Tuple)):
return [
el.elts[0] for el in node.elts if isinstance(el, (ast.Tuple, ast.List)) and el.elts
]
return []
nodes = keys_of(value)
if isinstance(value, ast.Call):
for a in value.args:
nodes += keys_of(a)
for kw in value.keywords: # **{...} unpacking has kw.arg is None
if kw.arg is None:
nodes += keys_of(kw.value)
return {n.value for n in nodes if isinstance(n, ast.Constant) and isinstance(n.value, str)}
def _model_types_from_source(source: str) -> set[str]:
"""model_type keys of CONFIG_MAPPING_NAMES in *source* (AST only, no execution).
Handles the direct ``CONFIG_MAPPING_NAMES = ...`` binding (dict literal or
OrderedDict/dict call over 2-tuple lists and **{...} unpacking) and any
``CONFIG_MAPPING_NAMES.update({...})`` mutation. Shared by the on-disk overlay
reader below and the remote latest-release checker (utils/transformers_latest.py).
"""
keys: set[str] = set()
tree = ast.parse(source)
for node in ast.walk(tree):
if isinstance(node, ast.Assign) and any(
isinstance(t, ast.Name) and t.id == "CONFIG_MAPPING_NAMES" for t in node.targets
):
keys |= _mapping_first_keys(node.value)
elif isinstance(node, ast.Expr) and isinstance(node.value, ast.Call):
fn = node.value.func
if (
isinstance(fn, ast.Attribute)
and fn.attr == "update"
and isinstance(fn.value, ast.Name)
and fn.value.id == "CONFIG_MAPPING_NAMES"
):
keys |= _mapping_first_keys(node.value)
return keys
def _config_model_types(tier: str) -> frozenset[str]:
"""model_type keys in a tier's CONFIG_MAPPING_NAMES (5.10 moved it to auto_mappings.py)."""
# Kill switch beats the cache: a stale mapping must not keep routing latest-only models until restart.
if tier == "latest" and _latest_tier_disabled():
return frozenset()
cached = _config_mapping_cache.get(tier)
if cached is not None:
# A cached 'latest' mapping can outlive the sidecar it was parsed from: if the
# pinned sidecar was since deleted or lost a package in this process, drop the
# cache so routing re-resolves through _overlay_transformers_dir (which self-heals)
# instead of routing latest-only models to a broken tier until restart.
if tier != "latest" or _latest_sidecar_intact():
return cached
_config_mapping_cache.pop("latest", None)
tdir = _overlay_transformers_dir(tier)
if tdir is None:
return frozenset() # overlay not provisioned yet; do not cache so a later call re-reads
keys: set[str] = set()
for rel in ("models/auto/configuration_auto.py", "models/auto/auto_mappings.py"):
path = Path(tdir) / rel
if not _safe_is_file(path):
continue
try:
keys |= _model_types_from_source(path.read_text(encoding = "utf-8"))
except Exception:
continue
result = frozenset(keys)
_config_mapping_cache[tier] = result
return result
def _model_types_from_config(cfg: dict) -> list[str]:
"""All model_types in the config: the primary (top-level, else first nested)
first, then every other nested sub-config. Wrappers instantiate sub-configs
through CONFIG_MAPPING, so nested types matter for routing too."""
seen: list[str] = []
def add(value):
if isinstance(value, str) and value and value not in seen:
seen.append(value)
add(cfg.get("model_type"))
for key in _NESTED_CONFIG_KEYS:
sub = cfg.get(key)
if isinstance(sub, dict):
add(sub.get("model_type"))
for value in cfg.values():
if isinstance(value, dict):
add(value.get("model_type"))
return seen
def _lowest_tier_for(model_type: str) -> str | None:
for tier in sorted(_TIER_RANK, key = _TIER_RANK.get):
if model_type in _config_model_types(tier):
return tier
return None
def _tier_from_config_mapping(cfg: dict) -> str | None:
"""Lowest tier able to load every model_type in cfg, or None when the
primary type is unknown everywhere. A nested type can raise the tier (its
sub-config is built through CONFIG_MAPPING); an unknown nested type never
vetoes, since no installed tier could load it either way (the latest
checker handles surfacing the install prompt for it)."""
types = _model_types_from_config(cfg)
if not types:
return None
best = _lowest_tier_for(types[0])
if best is None:
return None
for model_type in types[1:]:
tier = _lowest_tier_for(model_type)
if tier is not None and _TIER_RANK[tier] > _TIER_RANK[best]:
best = tier
return best
def _raise_tier_for_nested(cfg: dict | None, tier: str) -> str:
"""Raise *tier* when the mapping resolver needs a higher one for *cfg*.
A wrapper's top-level model_type can match a hardcoded fast path while a
nested text/vision config's type only exists in a newer sidecar (e.g. the
installed latest); its sub-config is built through CONFIG_MAPPING, so the
fast-path tier would fail to load it. Raise-only: never lowers a fast-path
match, so name overrides (Qwen3.6) keep their tier. Never raises an
exception: a resolution failure keeps the fast-path tier."""
if not isinstance(cfg, dict):
return tier
try:
mapped = _tier_from_config_mapping(cfg)
if mapped is not None and _TIER_RANK.get(mapped, 0) > _TIER_RANK.get(tier, 0):
return mapped
except Exception:
pass
return tier
# --- AutoConfig probe: general tier resolution for ambiguous models ----------
# When the cheap signals only say "needs some 5.x", parse config.json with the built-in
# parser in each candidate sidecar (lowest first) instead of guessing. Generalizes beyond
# the hardcoded lists, e.g. dense NemotronH whose '-' (MLP) layer only 5.10 can parse.
_PROBE_TIER_ORDER = ("530", "550", "510")
_PROBE_TIMEOUT_SECS = 60
# config.json-only parse in a sidecar (--target dir on sys.path, no per-venv python).
# Built-in parser only, no repo code, no weights. Exit 0 = parses; token via env, not argv.
_PROBE_CONFIG_SCRIPT = r"""
import sys, os
os.environ["TOKENIZERS_PARALLELISM"] = "false"
target_dir, model_name = sys.argv[1], sys.argv[2]
if target_dir: # empty = probe the ambient (default 4.57.x) transformers, no sidecar prepend
sys.path.insert(0, target_dir)
try:
from transformers import AutoConfig
AutoConfig.from_pretrained(model_name, trust_remote_code=False)
sys.exit(0)
except Exception as exc:
# stderr encoding may not be UTF-8 (e.g. cp1252 on Windows); write bytes so a
# non-ASCII error message cannot itself raise UnicodeEncodeError.
sys.stderr.buffer.write((type(exc).__name__ + ": " + str(exc)).encode("utf-8", "replace"))
sys.exit(1)
"""
# stderr fragments meaning "couldn't fetch/auth", NOT "needs a newer parser".
_PROBE_TRANSIENT_MARKERS = (
"ConnectionError",
"HTTPError",
"Timeout",
"Max retries",
"Temporary failure",
"GatedRepoError",
"RepositoryNotFoundError",
"LocalEntryNotFoundError",
"OfflineModeIsEnabled",
"401",
"403",
"404",
)
def _stderr_is_transient(err: str) -> bool:
return any(marker in err for marker in _PROBE_TRANSIENT_MARKERS)
def _probe_tier_venvs():
"""tier -> (target_dir, ensure_fn), a function so the later _ensure_* defs resolve. The
``default`` entry (empty target_dir = ambient 4.57.x) is only probed with include_default."""
return {
"default": ("", lambda: True),
"530": (_VENV_T5_530_DIR, _ensure_venv_t5_530_exists),
"550": (_VENV_T5_550_DIR, _ensure_venv_t5_550_exists),
"510": (_VENV_T5_510_DIR, _ensure_venv_t5_510_exists),
"latest": (_VENV_T5_LATEST_DIR, _ensure_venv_t5_latest_exists),
}
def _probe_tier_order() -> tuple[str, ...]:
"""Sidecar probe order. The consented "latest" sidecar joins only once it is
provisioned (pin marker present): an absent optional tier must not flip the probe's
skipped-tier bookkeeping, keeping pre-latest behavior byte-identical."""
if not _latest_tier_disabled() and latest_venv_pinned_version() is not None:
return _PROBE_TIER_ORDER + ("latest",)
return _PROBE_TIER_ORDER
def _probe_autoconfig(target_dir: str, model_name: str, hf_token: str | None) -> bool | None:
"""Parse config.json with the built-in parser inside *target_dir*'s sidecar.
True = parses, False = parse/version failure (escalate), None = transient
(auth/network/offline/spawn) so the caller fails safe and does not cache.
"""
env = child_env_without_native_path_secret()
if hf_token:
env["HF_TOKEN"] = hf_token
# The probe relies on the implicit HF_TOKEN env (no token= arg). Clear any inherited
# HF_HUB_DISABLE_IMPLICIT_TOKEN=1 so a gated repo authenticates instead of 401ing
# into the 530 fail-safe.
env["HF_HUB_DISABLE_IMPLICIT_TOKEN"] = "0"
if _env_offline():
env["HF_HUB_OFFLINE"] = "1"
env["TRANSFORMERS_OFFLINE"] = "1"
try:
result = subprocess.run(
[sys.executable, "-c", _PROBE_CONFIG_SCRIPT, target_dir, model_name],
capture_output = True,
text = True,
errors = "replace",
timeout = _PROBE_TIMEOUT_SECS,
env = env,
**_windows_hidden_subprocess_kwargs(),
)
except subprocess.TimeoutExpired:
logger.warning("AutoConfig probe timed out for '%s' in %s", model_name, target_dir)
return None
except Exception as exc:
logger.warning("AutoConfig probe could not spawn for '%s': %s", model_name, exc)
return None
if result.returncode == 0:
return True
err = (result.stderr or "").strip()
if _stderr_is_transient(err):
logger.warning("AutoConfig probe transient failure for '%s': %s", model_name, err)
return None
logger.info("AutoConfig probe parse failure for '%s' in %s: %s", model_name, target_dir, err)
return False
def _probe_cache_key(model_name: str) -> str:
"""Cache key for the probe result. A local checkpoint can be overwritten in place, so
fold in a cheap config.json signature (size + mtime) and re-probe when it changes.
Remote ids key by name alone (resolving a Hub revision would need a pre-activation hub
import that pins the wrong env)."""
try:
config_path = (Path(model_name) / "config.json").resolve()
st = config_path.stat()
except OSError:
return model_name
return f"{config_path}\0{st.st_size}:{st.st_mtime_ns}"
def _probe_tier(
model_name: str,
hf_token: str | None,
reason: str,
*,
include_default: bool = False,
floor: str = "530",
) -> str:
"""Lowest tier whose built-in parser loads the config; *floor* is the fail-safe.
Escalates ``_PROBE_TIER_ORDER`` (prefixed with the ambient ``default`` tier when
``include_default``), returning the first that parses; never raises or escalates on
uncertainty:
- first success wins (cached unless a lower tier was skipped);
- transient failure (auth/network/offline) -> *floor*, uncached;
- a skipped/uninstallable sidecar -> uncached (a lower tier may yet be the answer);
- all tiers probed, none parse -> remote-code/custom model_type; keep *floor*.
Known-5.x callers use ``floor='530'``; weak-signal callers (config saved by transformers
5.x) use ``include_default=True, floor='default'`` so a model that still parses on 4.57.x
stays on the default. Cached per _probe_cache_key (process lifetime). No Hub sha is
resolved: that would import huggingface_hub before the sidecar is on sys.path.
"""
if os.environ.get("UNSLOTH_DISABLE_TIER_PROBE", "").lower() in ("1", "true", "yes", "on"):
return floor
key = _probe_cache_key(model_name)
# Key by probe mode: the default-first path can return 'default', which must not be
# reused for a tokenizer/known-5.x caller (floor='530'). Legacy 530 keeps the bare key.
if include_default or floor != "530":
key = f"{key}\0floor={floor}:def={int(include_default)}"
if key in _probe_tier_cache:
cached = _probe_tier_cache[key]
# Kill switch beats the cache (like _config_model_types): a stale 'latest' probe must not keep activating it.
if cached != "latest" or not _latest_tier_disabled():
return cached
def _cache(tier: str, *, skipped: bool) -> str:
# Do not pin a result that depended on a skipped lower tier: once that sidecar is
# available the lowest valid tier may differ, so re-probe next call.
if not skipped:
_probe_tier_cache[key] = tier
return tier
venvs = _probe_tier_venvs()
sidecar_order = _probe_tier_order()
order = (("default",) + sidecar_order) if include_default else sidecar_order
probed_count = 0
skipped_any = False
for tier in order:
target_dir, ensure_fn = venvs[tier]
try:
available = ensure_fn()
except Exception:
available = False
if not available:
skipped_any = True
continue
probed_count += 1
ok = _probe_autoconfig(target_dir, model_name, hf_token)
if ok is True:
logger.info(
"Transformers tier %s selected for %s (AutoConfig probe; %s)",
tier,
model_name,
reason,
)
return _cache(tier, skipped = skipped_any)
if ok is None:
logger.info("Tier probe inconclusive for %s (%s); using %s", model_name, reason, floor)
return floor # transient: retry next load
# Nothing parsed. Only treat it as conclusive (and cache) when every tier was actually
# probed; a skipped sidecar means the environment is incomplete, so retry uncached.
if skipped_any or probed_count == 0:
logger.info(
"Tier probe incomplete for %s (%s); using %s (uncached)", model_name, reason, floor
)
return floor
logger.info(
"Transformers tier %s selected for %s (AutoConfig probe found no higher tier; %s)",
floor,
model_name,
reason,
)
return _cache(floor, skipped = False)
def _norm_separators(s: str) -> str:
"""Collapse ``_``/whitespace to ``-`` (underscore aliases) but keep ``.`` so a
version dot (``qwen3.5``) isn't conflated with a size separator (``Qwen3-5B``)."""
return "".join("-" if ch in "_ \t" else ch for ch in s)
def _looks_like_hf_id(value: str) -> bool:
"""True if *value* looks like a Hub id (``org/name``), not a local path. An
existing path is treated as a path, mirroring transformers' own resolution."""
if not value or not value.strip():
return False
if os.path.isabs(value) or value.startswith((".", "~")) or "\\" in value:
return False
if os.path.exists(value):
return False
return value.count("/") <= 1
def _tier_from_name(name: str) -> tuple[str, str] | None:
"""``(tier, reason)`` from name substrings (order 510 > 550 > 530), or ``None``.
Underscore aliases match (``Qwen3_5`` == ``Qwen3.5``); a dot-version substring
matches only the dot/underscore form, never a hyphen, so ``Qwen3-6B`` size names
aren't promoted.
"""
lowered = name.lower()
norm = _norm_separators(lowered)
dotted = lowered.replace("_", ".")
if "assistant" in lowered and ("gemma-4" in norm or "gemma4" in norm):
return "510", "gemma-4 assistant variant"
for substrings, tier in (
(TRANSFORMERS_510_MODEL_SUBSTRINGS, "510"),
(TRANSFORMERS_550_MODEL_SUBSTRINGS, "550"),
(TRANSFORMERS_5_MODEL_SUBSTRINGS, "530"),
):
for s in substrings:
if "." in s:
if s in lowered or s in dotted:
return tier, s
elif s in lowered or _norm_separators(s) in norm:
return tier, s
return None
def _higher_tier_name_override(name_hint: str | None) -> str | None:
"""510/550 tier if *name_hint* names a higher-tier model, else ``None``. Qwen3.6
reuses Qwen3.5 config ids but needs the 5.5 sidecar, so a name hint overrides 530."""
if not name_hint:
return None
hint = _tier_from_name(name_hint)
return hint[0] if hint is not None and hint[0] in ("510", "550") else None
def get_transformers_tier(
model_name: str,
hf_token: str | None = None,
probe: bool = True,
) -> str:
"""Return the transformers tier required for *model_name*.
Returns ``"510"`` for models needing transformers 5.10.x (Gemma 4 Unified),
``"550"`` for models needing transformers 5.5.0 (Gemma 4),
``"530"`` for models needing transformers 5.3.0 (e.g. Ministral-3, Qwen3 MoE),
or ``"default"`` for everything else (4.57.x).
Strong signals (architecture/model_type, name substrings) are fast paths. For local paths,
``config.json`` is checked before name heuristics to avoid false-positives from directory
name fragments. When the only signal is the 5.x tokenizer class, the exact tier is resolved
by probing AutoConfig in each sidecar; a config saved by transformers 5.x with no fast-path
match is probed default-first, catching a new 5.x-only arch while 4.57.x-loadable models
stay on default.
``probe=False`` skips the sidecar subprocesses (used by the cheap
:func:`needs_transformers_5`); it still classifies via cheap signals (a 5.x-saved config
returns ``"530"``). ``probe=True`` (the activation path) resolves the exact tier.
Higher 5.x tiers run first.
"""
# Local path: trust config.json. If its arch matches a known sidecar, return;
# else fall back to the HF id in the config (not the folder name) for renamed dirs.
local_cfg = Path(model_name) / "config.json"
if _safe_is_file(local_cfg):
cfg = _load_config_json(model_name, hf_token)
if cfg is not None:
if _config_needs_510(cfg):
tier = _raise_tier_for_nested(cfg, "510")
logger.info(
"Transformers tier %s selected for %s (local config.json check)",
tier,
model_name,
)
return tier
if _config_needs_550(cfg):
tier = _raise_tier_for_nested(cfg, "550")
logger.info(
"Transformers tier %s selected for %s (local config.json check)",
tier,
model_name,
)
return tier
if _config_needs_530(cfg):
# Qwen3.6 reuses Qwen3.5 config ids but needs 5.5 by name. Only a real
# Hub id (or the folder basename) may override 530, so a stale local
# path in _name_or_path can't flip a correct 530 config to 550.
base = _resolve_base_model(model_name)
hint_src = (
base
if (base != model_name and _looks_like_hf_id(base))
else Path(model_name).name
)
override = _higher_tier_name_override(hint_src)
if override is not None:
override = _raise_tier_for_nested(cfg, override)
logger.info(
"Transformers tier %s selected for %s (name overrides 530 config)",
override,
model_name,
)
return override
tier = _raise_tier_for_nested(cfg, "530")
logger.info(
"Transformers tier %s selected for %s (local config.json check)",
tier,
model_name,
)
return tier
# Unknown arch: resolve the base id from config. A resolved local dir
# recurses (config check); a Hub id uses name rules only (no network).
resolved = _resolve_base_model(model_name)
if resolved != model_name:
if _safe_is_dir(Path(resolved)):
tier = get_transformers_tier(resolved, hf_token, probe = probe)
if tier != "default":
logger.info(
"Transformers tier %s selected for %s (resolved local path: %s)",
tier,
model_name,
resolved,
)
return tier
elif _looks_like_hf_id(resolved):
result = _tier_from_name(resolved)
if result is not None:
tier, match = result
logger.info(
"Transformers tier %s selected for %s (resolved HF ID: %s, match: %s)",
tier,
model_name,
resolved,
match,
)
return tier
static = _tier_from_config_mapping(cfg)
if static is not None and static != "default":
logger.info(
"Transformers tier %s selected for %s (config mapping: model_type absent below)",
static,
model_name,
)
return static
local_tc = Path(model_name) / "tokenizer_config.json"
if _safe_is_file(local_tc) and _check_tokenizer_config_needs_v5(model_name, hf_token):
if not probe:
return "530"
return _probe_tier(model_name, hf_token, "local tokenizer needs 5.x")
if _config_saved_by_transformers_5(cfg):
if not probe:
return "530" # cheap 5.x hint; the real path resolves the exact tier
tier = _probe_tier(
model_name,
hf_token,
"local config saved by transformers 5.x",
include_default = True,
floor = "default",
)
if tier != "default":
return tier
logger.info(
"Transformers tier default (4.57.x) selected for %s (local config.json no match)",
model_name,
)
return "default"
# --- Fast substring checks (no I/O) ------------------------------------
result = _tier_from_name(model_name)
if result is not None:
tier, match = result
# With a consented latest sidecar pinned, a name that matches a fixed
# tier can still carry a latest-only model_type (e.g. a newer variant
# reusing a family name); consult the config so an accepted upgrade
# actually routes to the sidecar it installed. Costs a config read only
# in the pinned case, keeping the pre-latest path I/O-free.
if latest_venv_pinned_version() is not None:
tier = _raise_tier_for_nested(_load_config_json(model_name, hf_token), tier)
logger.info(
"Transformers tier %s selected for %s (substring match: %s)",
tier,
model_name,
match,
)
return tier
# --- Slow config fallbacks (network for HF IDs; authenticated with hf_token) --------
if _check_config_needs_510(model_name, hf_token):
tier = _raise_tier_for_nested(_load_config_json(model_name, hf_token), "510")
logger.info("Transformers tier %s selected for %s (config.json check)", tier, model_name)
return tier
if _check_config_needs_550(model_name, hf_token):
tier = _raise_tier_for_nested(_load_config_json(model_name, hf_token), "550")
logger.info("Transformers tier %s selected for %s (config.json check)", tier, model_name)
return tier
if _check_config_needs_530(model_name, hf_token):
# Qwen3.6 reuses Qwen3.5 config ids but needs 5.5 by name; honor a real Hub-id name
# hint from _name_or_path before selecting 530.
remote_cfg = _load_config_json(model_name, hf_token) or {}
base = remote_cfg.get("_name_or_path") or remote_cfg.get("model_name")
override = _higher_tier_name_override(
base if isinstance(base, str) and base != model_name else None
)
if override is not None:
override = _raise_tier_for_nested(remote_cfg, override)
logger.info(
"Transformers tier %s selected for %s (name overrides 530 config)",
override,
model_name,
)
return override
tier = _raise_tier_for_nested(remote_cfg, "530")
logger.info("Transformers tier %s selected for %s (config.json check)", tier, model_name)
return tier
# _load_config_json (not the cache-only reader) so a config served from the hub
# cache during a transient outage still feeds the mapping resolver.
remote_cfg = _load_config_json(model_name, hf_token)
if remote_cfg is not None:
static = _tier_from_config_mapping(remote_cfg)
if static is not None and static != "default":
logger.info(
"Transformers tier %s selected for %s (config mapping: model_type absent below)",
static,
model_name,
)
return static
if _check_tokenizer_config_needs_v5(model_name, hf_token):
if not probe:
return "530"
return _probe_tier(model_name, hf_token, "tokenizer needs 5.x")
if _config_saved_by_transformers_5(_cached_config_json(model_name, hf_token)):
if not probe:
return "530" # cheap 5.x hint; the real path resolves the exact tier
tier = _probe_tier(
model_name,
hf_token,
"config saved by transformers 5.x",
include_default = True,
floor = "default",
)
if tier != "default":
return tier
logger.info("Transformers tier default (4.57.x) selected for %s (no match)", model_name)
return "default"
def needs_transformers_5(model_name: str) -> bool:
"""Return True if *model_name* requires any transformers 5.x version.
Convenience wrapper around :func:`get_transformers_tier`. Passes ``probe=False`` so a
log-only parent caller never spawns sidecar probes (the worker re-resolves the exact
tier with ``probe=True`` on the real activation path).
"""
return get_transformers_tier(model_name, probe = False) != "default"
# ---------------------------------------------------------------------------
# Version switching (in-process — used only by export)
# ---------------------------------------------------------------------------
def _get_in_memory_version() -> str | None:
"""Return the transformers version currently loaded in this process."""
tf = sys.modules.get("transformers")
if tf is not None:
return getattr(tf, "__version__", None)
return None
# All top-level prefixes that hold references to transformers internals.
_PURGE_PREFIXES = (
"transformers",
"huggingface_hub",
"unsloth",
"unsloth_zoo",
"peft",
"trl",
"accelerate",
"auto_gptq",
# NOTE: bitsandbytes is intentionally EXCLUDED -- it registers torch custom
# operators via torch.library.define() into torch's global registry, which
# survives module purge; re-importing after purge -> duplicate registration
# -> crash.
# Our own modules that import from transformers at module level.
"utils.models",
"core.training",
"core.inference",
"core.export",
)
def _purge_modules() -> int:
"""Remove all cached modules for transformers and its dependents.
Returns the number of modules purged.
"""
importlib.invalidate_caches()
to_remove = [
k
for k in list(sys.modules.keys())
if any(k == p or k.startswith(p + ".") for p in _PURGE_PREFIXES)
]
for key in to_remove:
del sys.modules[key]
return len(to_remove)
_VENV_T5_530_PACKAGES = (
f"transformers=={TRANSFORMERS_530_VERSION}",
"huggingface_hub==1.8.0",
"hf_xet==1.4.2",
"tiktoken",
)
_VENV_T5_510_PACKAGES = (
f"transformers=={TRANSFORMERS_510_VERSION}",
"huggingface_hub==1.8.0",
"hf_xet==1.4.2",
"tiktoken",
)
_VENV_T5_550_PACKAGES = (
f"transformers=={TRANSFORMERS_550_VERSION}",
"huggingface_hub==1.8.0",
"hf_xet==1.4.2",
"tiktoken",
)
# Backwards-compat alias
_VENV_T5_PACKAGES = _VENV_T5_550_PACKAGES
def _venv_dir_is_valid(venv_dir: str, packages: tuple[str, ...]) -> bool:
"""Return True if *venv_dir* has all *packages* at the correct versions."""
if not os.path.isdir(venv_dir) or not os.listdir(venv_dir):
return False
for pkg_spec in packages:
parts = pkg_spec.split("==")
pkg_name = parts[0]
pkg_version = parts[1] if len(parts) > 1 else None
pkg_name_norm = pkg_name.replace("-", "_")
# Directory must exist.
if not any(
(Path(venv_dir) / d).is_dir() for d in (pkg_name_norm, pkg_name_norm.replace("_", "-"))
):
return False
# Unpinned packages: existence is enough.
if pkg_version is None:
continue
# Check version via .dist-info metadata.
dist_info_found = False
for di in Path(venv_dir).glob(f"{pkg_name_norm}-*.dist-info"):
metadata = di / "METADATA"
if not metadata.is_file():
continue
for line in metadata.read_text(errors = "replace").splitlines():
if line.startswith("Version:"):
installed_ver = line.split(":", 1)[1].strip()
if installed_ver != pkg_version:
logger.warning(
"%s has %s==%s but need %s -- venv will be wiped and reinstalled",
venv_dir,
pkg_name,
installed_ver,
pkg_version,
)
return False
dist_info_found = True
break
if dist_info_found:
break
if not dist_info_found:
return False
return True
def _venv_t5_is_valid() -> bool:
"""Backwards-compat: check the Gemma 4 sidecar venv."""
return _venv_dir_is_valid(_VENV_T5_550_DIR, _VENV_T5_550_PACKAGES)
def _install_to_dir(pkg: str, target_dir: str) -> bool:
"""Install a single package into *target_dir*, preferring uv then pip."""
# Try uv first (faster) if on PATH -- do NOT install uv at runtime.
if shutil.which("uv"):
result = subprocess.run(
[
"uv",
"pip",
"install",
"--python",
sys.executable,
"--target",
target_dir,
"--no-deps",
"--upgrade",
pkg,
],
stdout = subprocess.PIPE,
stderr = subprocess.STDOUT,
text = True,
env = child_env_without_native_path_secret(),
**_windows_hidden_subprocess_kwargs(),
)
if result.returncode == 0:
return True
logger.warning("uv install of %s failed, falling back to pip", pkg)
# Fallback to pip.
result = subprocess.run(
[
sys.executable,
"-m",
"pip",
"install",
"--target",
target_dir,
"--no-deps",
"--upgrade",
pkg,
],
stdout = subprocess.PIPE,
stderr = subprocess.STDOUT,
text = True,
env = child_env_without_native_path_secret(),
**_windows_hidden_subprocess_kwargs(),
)
if result.returncode != 0:
logger.error("install failed:\n%s", result.stdout)
return False
return True
def _ensure_venv_dir(venv_dir: str, packages: tuple[str, ...], label: str) -> bool:
"""Ensure *venv_dir* exists with all *packages*. Install if missing."""
if _venv_dir_is_valid(venv_dir, packages):
return True
logger.warning("%s not found or incomplete at %s -- installing at runtime", label, venv_dir)
shutil.rmtree(venv_dir, ignore_errors = True)
os.makedirs(venv_dir, exist_ok = True)
total = len(packages)
for idx, pkg in enumerate(packages, start = 1):
logger.info("Installing %s (%d/%d) into %s ...", pkg, idx, total, venv_dir)
if not _install_to_dir(pkg, venv_dir):
return False
logger.info("Installed %s to %s", label, venv_dir)
return True
def _ensure_venv_t5_530_exists() -> bool:
"""Ensure .venv_t5_530/ exists with transformers 5.3.0."""
return _ensure_venv_dir(_VENV_T5_530_DIR, _VENV_T5_530_PACKAGES, "transformers 5.3.0")
def _ensure_venv_t5_550_exists() -> bool:
"""Ensure .venv_t5_550/ exists with transformers 5.5.0."""
return _ensure_venv_dir(
_VENV_T5_550_DIR,
_VENV_T5_550_PACKAGES,
f"transformers {TRANSFORMERS_550_VERSION}",
)
def _ensure_venv_t5_510_exists() -> bool:
"""Ensure .venv_t5_510/ exists with transformers 5.10.x."""
return _ensure_venv_dir(
_VENV_T5_510_DIR,
_VENV_T5_510_PACKAGES,
f"transformers {TRANSFORMERS_510_VERSION}",
)
def _ensure_venv_t5_exists() -> bool:
"""Backwards-compat: ensure the Gemma 4 5.5 sidecar venv exists."""
return _ensure_venv_t5_550_exists()
# --- User-consented "latest transformers" sidecar (.venv_t5_latest) --------------------------
# Provisioned via ensure_latest_transformers_venv() after the user confirms the upgrade popup
# (utils/transformers_latest.py); pinned in a marker file so restarts revalidate and routing auto-picks it.
# PEP 440-ish release strings only (guards the pip install spec against injection).
_LATEST_VERSION_RE = r"[0-9]+(\.[0-9]+)*((a|b|rc)[0-9]+)?(\.post[0-9]+)?(\.dev[0-9]+)?"
def _is_valid_version_string(version: str) -> bool:
import re
return isinstance(version, str) and re.fullmatch(_LATEST_VERSION_RE, version) is not None
# Only the sidecar recipe's own packages, as plain (optionally ==pinned) specs, may
# come from the on-disk pin marker; anything else (URLs, extras, options) is rebuilt.
_PIN_SPEC_RE = re.compile(r"^[A-Za-z0-9_.-]+(==[A-Za-z0-9_.+-]+)?$")
_PIN_ALLOWED_NAMES = frozenset(
{
"transformers",
"huggingface_hub",
"huggingface-hub",
"hf_xet",
"hf-xet",
"tiktoken",
"tokenizers",
"safetensors",
}
)
def _is_safe_pin_spec(spec: str) -> bool:
if not _PIN_SPEC_RE.match(spec):
return False
name = spec.split("==", 1)[0].lower().replace("_", "-")
return name in {n.replace("_", "-") for n in _PIN_ALLOWED_NAMES}
def _recover_stranded_latest_sidecar() -> None:
"""Restore a sidecar stranded at ``.old`` by a swap whose activation rename AND its
rollback both failed (e.g. a lingering worker file handle on Windows blocked both).
That double failure leaves no live dir and the pin marker gone with it, so the
sidecar reads as unprovisioned and never self-heals. Recover only when no live dir
exists and no swap is in flight: the reservation is held throughout the swap, so the
transient live-absent window of a legitimate swap never triggers a restore."""
live = Path(_VENV_T5_LATEST_DIR)
retired = Path(_VENV_T5_LATEST_DIR + ".old")
try:
if live.exists() or not retired.is_dir() or sidecar_swap_in_progress():
return
os.rename(retired, live)
logger.info("Recovered .venv_t5_latest from a stranded .old after a failed swap")
except OSError:
pass
def _latest_pin_data() -> dict | None:
"""Parsed pin marker: {"version": str, "packages": [specs...]}, or None.
The marker is JSON; a plain version string (older/simpler writers) is tolerated and
expanded with the default package set.
"""
_recover_stranded_latest_sidecar()
marker = Path(_VENV_T5_LATEST_DIR) / _LATEST_PIN_MARKER
try:
if not marker.is_file():
return None
raw = marker.read_text(encoding = "utf-8").strip()
except Exception:
return None
try:
data = json.loads(raw)
except ValueError:
data = raw
if isinstance(data, str):
if not _is_valid_version_string(data):
return None
return {"version": data, "packages": list(_venv_t5_latest_packages(data))}
if not isinstance(data, dict):
return None
version = data.get("version")
if not _is_valid_version_string(version):
return None
packages = data.get("packages")
if not (
isinstance(packages, list)
and packages
and all(isinstance(p, str) and _is_safe_pin_spec(p) for p in packages)
):
# Malformed or unexpected specs (the pin is user-writable on disk) never
# reach pip: rebuild the canonical set for the pinned version instead.
packages = list(_venv_t5_latest_packages(version))
return {"version": version, "packages": packages}
def latest_venv_pinned_version() -> str | None:
"""Exact transformers version pinned in .venv_t5_latest's marker, or None if the
sidecar was never provisioned (or the marker is unreadable/invalid)."""
data = _latest_pin_data()
return data["version"] if data else None
def _venv_t5_latest_packages(version: str, extra_packages: tuple[str, ...] = ()) -> tuple[str, ...]:
"""Package set for the latest sidecar; mirrors the fixed .venv_t5_* sidecars.
*extra_packages* carries dep-compat shadows (e.g. a newer tokenizers) computed by
utils.transformers_latest before install."""
return (
f"transformers=={version}",
"huggingface_hub==1.8.0",
"hf_xet==1.4.2",
"tiktoken",
) + tuple(extra_packages)
# Single reservation for ANY .venv_t5_latest replacement (consented install or lazy repair),
# checked by training/export starts so no worker spawns mid-swap. Backed by a lock FILE (not just
# this flag) so a lazy repair running in a worker subprocess stays visible to the parent's route
# checks; the in-process flag marks ownership (only the owner unlinks the file).
_sidecar_swap_lock = threading.Lock()
_sidecar_swap_active = False
_sidecar_swap_token: str | None = None
_sidecar_swap_kind: str | None = None
# An install is minutes; a lock this old is a crashed owner, not a live swap.
_SWAP_LOCK_STALE_SECS = 2 * 60 * 60
def _swap_lock_path() -> Path:
return Path(_VENV_T5_LATEST_DIR + ".swaplock")
def _pid_alive(pid) -> bool:
if not isinstance(pid, int) or pid <= 0:
return False
try:
import psutil
return psutil.pid_exists(pid)
except Exception:
pass
if os.name == "nt":
# os.kill(pid, 0) is NOT a POSIX signal-0 liveness probe on Windows: signal 0
# is CTRL_C_EVENT, so CPython routes it through GenerateConsoleCtrlEvent (a real
# Ctrl+C to that console group) rather than a harmless check. Probe via OpenProcess.
try:
import ctypes
from ctypes import wintypes
kernel32 = ctypes.WinDLL("kernel32", use_last_error = True)
kernel32.OpenProcess.argtypes = [wintypes.DWORD, wintypes.BOOL, wintypes.DWORD]
kernel32.OpenProcess.restype = wintypes.HANDLE
# PROCESS_QUERY_LIMITED_INFORMATION: minimal right, granted across integrity levels.
handle = kernel32.OpenProcess(0x1000, False, pid)
if handle:
kernel32.CloseHandle(handle)
return True
# ERROR_ACCESS_DENIED means the process exists but we may not query it.
return ctypes.get_last_error() == 5
except Exception:
return False
try:
os.kill(pid, 0)
return True
except OSError:
return False
except Exception:
return False
def _swap_lock_is_stale(path: Path) -> bool:
"""Stale when the recorded owner is provably dead: a crashed installer is reclaimed
at once, not after the long cutoff, so `/load`, training, export, and repair are not
wedged for hours after a crash. A live but slow pip install keeps its lock (its PID
is alive), so breaking it and racing two swaps on the same staging dirs stays
impossible. Only a lock whose PID can't be read (mid-write or corrupt) falls back to
the age cutoff, so the create-before-metadata-write window is never mistaken for dead."""
try:
age = time.time() - path.stat().st_mtime
except OSError:
return False
data = _read_swap_lock(path) or {}
pid = data.get("pid")
if not isinstance(pid, int) or pid <= 0:
return age > _SWAP_LOCK_STALE_SECS
return not _pid_alive(pid)
class SidecarSwapInProgress(RuntimeError):
"""A worker start lost the race to a .venv_t5_latest install/repair; retryable."""
def _read_swap_lock(path: Path) -> dict | None:
try:
data = json.loads(path.read_text(encoding = "utf-8"))
return data if isinstance(data, dict) else {}
except FileNotFoundError:
return None
except OSError:
return {}
except Exception:
return {}
def try_begin_sidecar_swap(kind: str = "install") -> bool:
"""Reserve the sidecar swap window; False when one is already reserved
(in this process or, via the lock file, in any worker subprocess).
*kind* is "install" (consented route) or "repair" (lazy venv repair)."""
global _sidecar_swap_active, _sidecar_swap_token, _sidecar_swap_kind
with _sidecar_swap_lock:
if _sidecar_swap_active:
return False
token = f"{os.getpid()}-{time.time_ns()}"
path = _swap_lock_path()
try:
path.parent.mkdir(parents = True, exist_ok = True)
except OSError:
pass
for attempt in range(2):
try:
fd = os.open(str(path), os.O_CREAT | os.O_EXCL | os.O_WRONLY)
break
except FileExistsError:
if attempt or not _swap_lock_is_stale(path):
return False
try:
path.unlink()
except OSError:
return False
except OSError:
# Lock file not creatable (odd filesystem): fall back to the process-local reservation.
fd = None
break
if fd is not None:
try:
with os.fdopen(fd, "w") as f:
f.write(
json.dumps(
{"pid": os.getpid(), "at": time.time(), "token": token, "kind": kind}
)
)
except OSError:
pass
_sidecar_swap_active = True
_sidecar_swap_token = token
_sidecar_swap_kind = kind
return True
def end_sidecar_swap() -> None:
"""Release the reservation taken by :func:`try_begin_sidecar_swap`."""
global _sidecar_swap_active, _sidecar_swap_token, _sidecar_swap_kind
with _sidecar_swap_lock:
if _sidecar_swap_active:
# Only the file WE wrote is removed: if this reservation was declared
# stale and superseded, unlinking blindly would drop the new owner's
# live lock and unguard its in-flight swap.
path = _swap_lock_path()
data = _read_swap_lock(path)
if data is not None and data.get("token", _sidecar_swap_token) == _sidecar_swap_token:
try:
path.unlink()
except OSError:
pass
_sidecar_swap_active = False
_sidecar_swap_token = None
_sidecar_swap_kind = None
def sidecar_swap_in_progress() -> bool:
"""True while a .venv_t5_latest install or repair holds the reservation,
in this process or any other Studio process (lock file)."""
return sidecar_swap_kind() is not None
def sidecar_swap_kind() -> str | None:
"""The active reservation's kind ("install" / "repair"), or None when idle.
Lets guards that rely on the install route's own abort-on-active-worker
checks keep refusing for repairs, which have no such checks."""
with _sidecar_swap_lock:
if _sidecar_swap_active:
return _sidecar_swap_kind or "install"
path = _swap_lock_path()
try:
if not path.is_file() or _swap_lock_is_stale(path):
return None
except OSError:
return None
data = _read_swap_lock(path) or {}
kind = data.get("kind")
return kind if kind in ("install", "repair") else "install"
def _stage_and_swap_latest_venv(
version: str,
packages: tuple[str, ...],
before_swap = None,
) -> bool:
"""Stage-and-swap: build the new sidecar next to the live one and swap only
once complete, so a failed install or marker write never destroys a
previously working .venv_t5_latest or its pin. Shared by the consented
install and the lazy repair path. *before_swap* (optional callable) runs
after the staging build succeeds and immediately before the live dir is
replaced, so callers can tear down workers only when the swap is certain;
if it raises, the previous sidecar is left untouched."""
staging = _VENV_T5_LATEST_DIR + ".staging"
retired = _VENV_T5_LATEST_DIR + ".old"
shutil.rmtree(staging, ignore_errors = True)
try:
if not _ensure_venv_dir(staging, packages, f"transformers {version} (latest)"):
# No exception, so the except cleanup below never runs; drop the partial dir.
shutil.rmtree(staging, ignore_errors = True)
return False
(Path(staging) / _LATEST_PIN_MARKER).write_text(
json.dumps({"version": version, "packages": list(packages)}), encoding = "utf-8"
)
if before_swap is not None:
before_swap()
shutil.rmtree(retired, ignore_errors = True)
if os.path.isdir(_VENV_T5_LATEST_DIR):
os.rename(_VENV_T5_LATEST_DIR, retired)
try:
os.rename(staging, _VENV_T5_LATEST_DIR)
except OSError:
# Restore the previous sidecar if the final swap fails.
if not os.path.isdir(_VENV_T5_LATEST_DIR) and os.path.isdir(retired):
os.rename(retired, _VENV_T5_LATEST_DIR)
raise
except Exception as exc:
logger.error("Could not provision transformers %s into .venv_t5_latest: %s", version, exc)
shutil.rmtree(staging, ignore_errors = True)
return False
shutil.rmtree(retired, ignore_errors = True)
# CONFIG_MAPPING_NAMES may have changed: drop the cached key set.
_config_mapping_cache.pop("latest", None)
logger.info("Provisioned .venv_t5_latest with transformers %s", version)
return True
def _workers_active_for_repair() -> bool:
"""Best-effort: any parent-visible chat/training/export worker alive. Never
raises; unavailable backends (worker subprocess, early startup) count idle."""
try:
from core.training import get_training_backend
if get_training_backend().is_training_active():
return True
except Exception:
pass
try:
from core.export import get_export_backend
_export = get_export_backend()
if _export.is_export_active():
return True
_alive = getattr(_export, "is_worker_alive", None)
if callable(_alive) and _alive():
return True
except Exception:
pass
try:
from core.inference import get_inference_backend
backend = get_inference_backend()
if getattr(backend, "active_model_name", None):
return True
# An in-flight load counts too: its worker spawns moments later.
if getattr(backend, "loading_models", None):
return True
_alive = getattr(backend, "is_worker_alive", None)
if callable(_alive) and _alive():
return True
except Exception:
pass
return False
def _ensure_venv_t5_latest_exists() -> bool:
"""Ensure .venv_t5_latest/ holds its pinned transformers version.
Never installs without a pin: an unprovisioned sidecar (no marker) returns False so
routing and probing behave exactly as before the feature existed. With a pin present
it repairs a broken dir the same way the fixed sidecars do.
"""
pin = _latest_pin_data()
if pin is None:
return False
version = pin["version"]
packages = tuple(pin["packages"])
if _venv_dir_is_valid(_VENV_T5_LATEST_DIR, packages):
return True
if _env_offline():
logger.warning(
".venv_t5_latest (transformers %s) is incomplete and offline mode is set; "
"cannot repair it.",
version,
)
return False
# Repairs are a parent-process action: a worker child's backend singletons are
# empty, so it cannot see live siblings that may still lazy-import from the
# sidecar. Fail activation in the child instead; the parent's routing
# self-heal (guarded below) performs the actual repair.
try:
import multiprocessing as _mp
if _mp.parent_process() is not None:
logger.warning(
".venv_t5_latest is incomplete; repairs run in the parent process. "
"Retry after the parent repairs the sidecar."
)
return False
except Exception:
pass
# Same stage-and-swap as the install, under the same reservation so training/export starts
# (which check sidecar_swap_in_progress) wait out a lazy repair; a failed repair keeps the pin.
if not try_begin_sidecar_swap(kind = "repair"):
logger.warning(
"Cannot repair .venv_t5_latest: another sidecar install or repair is in progress."
)
return False
try:
# Worker check UNDER the reservation (the install route quiesces workers;
# a repair has none): worker starts set their active markers BEFORE
# rechecking the reservation, so either this check sees them and aborts,
# or their recheck sees this reservation and aborts -- no interleaving
# lets a worker spawn against a mid-swap sidecar.
if _workers_active_for_repair():
logger.warning(
"Cannot repair .venv_t5_latest: active chat/training/export workers "
"may be importing from it. Retry when they are idle."
)
return False
return _stage_and_swap_latest_venv(version, packages)
finally:
end_sidecar_swap()
def ensure_latest_transformers_venv(
version: str,
extra_packages: tuple[str, ...] = (),
before_swap = None,
) -> bool:
"""Provision .venv_t5_latest/ pinned to *version* (user-consented install path).
Reuses the same --target/--no-deps installer as the fixed sidecars, then writes the pin
marker (version + full package set) so the venv persists across restarts and
:func:`latest_venv_pinned_version` / routing pick it up automatically.
*extra_packages* carries dep-compat shadows (see utils.transformers_latest).
Returns True on success.
"""
if not _is_valid_version_string(version):
logger.error("Refusing to install invalid transformers version %r", version)
return False
if _env_offline():
logger.warning(
"Cannot install transformers %s: HF/transformers offline mode is set.", version
)
return False
packages = _venv_t5_latest_packages(version, extra_packages)
pin = _latest_pin_data()
if (
pin is not None
and pin["version"] == version
and tuple(pin["packages"]) == packages
and _venv_dir_is_valid(_VENV_T5_LATEST_DIR, packages)
):
return True
return _stage_and_swap_latest_venv(version, packages, before_swap = before_swap)
# --- llm-compressor-main shadow (FP8/FP4 export of newer-transformers models) ---------------------
# Exact, reproducible pins (bump deliberately in review). Full 40-char SHA validated to FP8-quantize
# Qwen3.5 / Gemma-4 / Llama.
_LLMC_MAIN_TRANSFORMERS = "5.10.2"
_LLMC_MAIN_SHA = "973c9c539a84dd9efaf74e115ede5ca419704c18"
_LLMC_MAIN_COMPRESSED_TENSORS = "0.17.2a20260702"
# Installed --no-deps (torch untouched); the full runtime set llm-compressor main needs, pinned.
_VENV_LLMCOMPRESSOR_SPECS = (
f"transformers=={_LLMC_MAIN_TRANSFORMERS}",
f"llmcompressor @ git+https://github.com/vllm-project/llm-compressor@{_LLMC_MAIN_SHA}",
f"compressed-tensors=={_LLMC_MAIN_COMPRESSED_TENSORS}",
"huggingface-hub==1.21.0",
"hf-xet==1.5.1",
"tokenizers==0.22.2",
"safetensors==0.8.0",
"accelerate==1.14.0",
"datasets==5.0.0",
"pydantic==2.13.4",
"pydantic-core==2.46.4",
"typing-inspection==0.4.2",
"loguru==0.7.3",
"pyyaml==6.0.3",
"nvidia-ml-py==13.610.43",
"pillow==12.3.0",
"auto-round==0.13.1",
"regex==2026.6.28",
)
# Fingerprint of the pin set; bump the trailing schema version to force a rebuild on layout changes.
_LLMC_SHADOW_FINGERPRINT = (
f"{_LLMC_MAIN_SHA}|{_LLMC_MAIN_TRANSFORMERS}|{_LLMC_MAIN_COMPRESSED_TENSORS}|schema=1"
)
_LLMC_SHADOW_MARKER = ".unsloth_llmc_fingerprint"
def _llmcompressor_main_disabled() -> bool:
"""True if the operator forbids the llm-compressor-main shadow (air-gapped / locked-down)."""
return os.environ.get("UNSLOTH_DISABLE_LLMCOMPRESSOR_MAIN", "").strip().lower() in {
"1",
"true",
"yes",
"on",
}
def _llmcompressor_shadow_is_valid() -> bool:
"""True if the shadow dir exists with a marker matching the current pin fingerprint."""
marker = Path(_VENV_LLMCOMPRESSOR_DIR) / _LLMC_SHADOW_MARKER
try:
return marker.is_file() and marker.read_text().strip() == _LLMC_SHADOW_FINGERPRINT
except Exception:
return False
def _ensure_venv_llmcompressor_exists() -> bool:
"""Ensure .venv_llmcompressor/ has the pinned llm-compressor-main stack. Install if missing.
All specs are installed with --no-deps into a --target dir (mirrors the transformers sidecars),
so the workspace torch is never touched. Returns True on success.
"""
if _llmcompressor_shadow_is_valid():
return True
if _llmcompressor_main_disabled():
logger.warning(
"llm-compressor-main shadow needed but UNSLOTH_DISABLE_LLMCOMPRESSOR_MAIN is set; "
"compressed export of newer-transformers models will fail fast."
)
return False
if _env_offline():
logger.warning(
"llm-compressor-main shadow missing and HF/offline mode is set; cannot provision it."
)
return False
logger.warning(
"Provisioning llm-compressor-main shadow at %s (one-time, ~a few hundred MB, no torch) ...",
_VENV_LLMCOMPRESSOR_DIR,
)
shutil.rmtree(_VENV_LLMCOMPRESSOR_DIR, ignore_errors = True)
os.makedirs(_VENV_LLMCOMPRESSOR_DIR, exist_ok = True)
# Prefer uv (faster) then pip; install every spec at once, --no-deps, prereleases allowed
# (compressed-tensors ships as a pre-release).
base = [
"--target",
_VENV_LLMCOMPRESSOR_DIR,
"--no-deps",
"--prerelease=allow",
*_VENV_LLMCOMPRESSOR_SPECS,
]
cmds = []
if shutil.which("uv"):
cmds.append(["uv", "pip", "install", "--python", sys.executable, *base])
cmds.append(
[
sys.executable,
"-m",
"pip",
"install",
*[a for a in base if a != "--prerelease=allow"],
"--pre",
]
)
last_out = ""
for cmd in cmds:
result = subprocess.run(
cmd,
stdout = subprocess.PIPE,
stderr = subprocess.STDOUT,
text = True,
env = child_env_without_native_path_secret(),
**_windows_hidden_subprocess_kwargs(),
)
last_out = result.stdout or ""
if result.returncode == 0:
try:
(Path(_VENV_LLMCOMPRESSOR_DIR) / _LLMC_SHADOW_MARKER).write_text(
_LLMC_SHADOW_FINGERPRINT
)
except Exception:
pass
logger.info("Provisioned llm-compressor-main shadow at %s", _VENV_LLMCOMPRESSOR_DIR)
return True
logger.warning("llm-compressor-main shadow install failed with %s; trying next", cmd[0])
logger.error(
"Failed to provision llm-compressor-main shadow (spec: llmcompressor@%s). Output:\n%s",
_LLMC_MAIN_SHA,
last_out[-4000:],
)
return False
def llmcompressor_shadow_pythonpath() -> str | None:
"""Provision (lazily) the llm-compressor-main shadow and return its sys.path entry, or None.
Returns None when the shadow is disabled (UNSLOTH_DISABLE_LLMCOMPRESSOR_MAIN), offline, or
provisioning failed - callers then fall back to the fail-fast path.
"""
if _llmcompressor_main_disabled():
return None
if _ensure_venv_llmcompressor_exists():
return _VENV_LLMCOMPRESSOR_DIR
return None
def _activate_venv(venv_dir: str, label: str) -> None:
"""Prepend *venv_dir* to sys.path, purge stale modules, reimport."""
if venv_dir not in sys.path:
sys.path.insert(0, venv_dir)
logger.info("Prepended %s to sys.path", venv_dir)
count = _purge_modules()
logger.info("Purged %d cached modules", count)
import transformers
logger.info("Loaded transformers %s (%s)", transformers.__version__, label)
def _deactivate_5x() -> None:
"""Remove all .venv_t5_*/ dirs from sys.path, purge stale modules, reimport."""
for d in (_VENV_T5_530_DIR, _VENV_T5_550_DIR, _VENV_T5_510_DIR, _VENV_T5_LATEST_DIR):
while d in sys.path:
sys.path.remove(d)
logger.info("Removed venv_t5 dirs from sys.path")
count = _purge_modules()
logger.info("Purged %d cached modules", count)
import transformers
logger.info("Reverted to transformers %s", transformers.__version__)
def ensure_transformers_version(model_name: str) -> None:
"""Ensure the correct ``transformers`` version is active for *model_name*.
Uses sys.path with .venv_t5_510/, .venv_t5_550/, or .venv_t5_530/
(pre-installed by setup.sh):
• Need 5.10.x → prepend .venv_t5_510/ to sys.path, purge modules.
• Need 5.5.0 → prepend .venv_t5_550/ to sys.path, purge modules.
• Need 5.3.0 → prepend .venv_t5_530/ to sys.path, purge modules.
• Need 4.x → remove all .venv_t5_*/ from sys.path, purge modules.
For custom-named LoRA adapters, the base model is resolved before checking
(from ``adapter_config.json`` or, for adapter_model-only LoRAs, the directory
name).
NOTE: Training and inference use subprocess isolation instead. Used only by
the export path (routes/export.py).
"""
# Only pre-resolve for LoRA adapter dirs; see activate_transformers_for_subprocess.
if _is_lora_adapter_dir(Path(model_name)):
resolved = _resolve_base_model(model_name)
else:
# A remote adapter's tier is its BASE model's (see activation above).
resolved = _remote_lora_base(model_name) or model_name
tier = get_transformers_tier(resolved)
if model_name != resolved and _safe_is_file(Path(model_name) / "config.json"):
# Gate on a real local config.json: a checkpoint carries config the base may not
# surface, but path names alone must not upgrade a plain adapter.
tier = _higher_tier(tier, get_transformers_tier(model_name))
if tier == "latest":
pinned = latest_venv_pinned_version()
if pinned is None:
raise RuntimeError(
f"Cannot activate the latest-transformers sidecar: "
f"no pin marker at {_VENV_T5_LATEST_DIR}"
)
target_version = pinned
venv_dir = _VENV_T5_LATEST_DIR
ensure_fn = _ensure_venv_t5_latest_exists
elif tier == "510":
target_version = TRANSFORMERS_510_VERSION
venv_dir = _VENV_T5_510_DIR
ensure_fn = _ensure_venv_t5_510_exists
elif tier == "550":
target_version = TRANSFORMERS_550_VERSION
venv_dir = _VENV_T5_550_DIR
ensure_fn = _ensure_venv_t5_550_exists
elif tier == "530":
target_version = TRANSFORMERS_530_VERSION
venv_dir = _VENV_T5_530_DIR
ensure_fn = _ensure_venv_t5_530_exists
else:
target_version = TRANSFORMERS_DEFAULT_VERSION
venv_dir = None
ensure_fn = None
target_major = int(target_version.split(".")[0])
# Check what's actually loaded in memory
in_memory = _get_in_memory_version()
logger.info(
"Version check for '%s' (resolved: '%s'): need=%s, in_memory=%s",
model_name,
resolved,
target_version,
in_memory,
)
# --- Already correct? ---------------------------------------------------
if in_memory is not None:
if in_memory == target_version:
logger.info(
"transformers %s already loaded — correct for '%s'",
in_memory,
model_name,
)
return
# Different 5.x -> need to switch (e.g. 5.3.0 loaded but need 5.10.x).
in_memory_major = int(in_memory.split(".")[0])
if in_memory_major == target_major and venv_dir is None:
# Both are default (4.x) — close enough.
logger.info(
"transformers %s already loaded — correct for '%s'",
in_memory,
model_name,
)
return
# --- Switch version -----------------------------------------------------
if venv_dir is not None:
# First remove any other 5.x venv from sys.path.
_deactivate_5x()
if not ensure_fn():
raise RuntimeError(
f"Cannot activate transformers {target_version}: " f"venv missing at {venv_dir}"
)
logger.info("Activating transformers %s", target_version)
_activate_venv(venv_dir, f"transformers {target_version}")
else:
logger.info("Reverting to default transformers %s", TRANSFORMERS_DEFAULT_VERSION)
_deactivate_5x()
final = _get_in_memory_version()
logger.info("✓ transformers version is now %s", final)