a00fe86c13* Studio: read model text as utf-8 so umlauts survive on Windows Chat rejects or mangles non-ASCII on Windows: "ä ö ü" in a prompt, a chat template, or a model path comes back as mojibake, or the load dies with UnicodeDecodeError. open() and Path.read_text() fall back to locale.getencoding() when no encoding is passed. On Windows that is the ANSI codepage (cp1252, cp932, cp1251, ... by system locale), never UTF-8. Hugging Face writes these files as raw UTF-8, so every read of one decodes with the wrong codec: - tokenizer_config.json, which holds the chat template. Templates routinely carry -> arrows, smart quotes and CJK, so this is the common path into chat - config.json and adapter_config.json - modules.json, Ollama manifests, and the .py sources the remote-code scanner reads before a model is allowed to load The llama-server and embedding-server stdout readers have the same problem via subprocess(text = True); they now decode utf-8 with errors = "replace" so a stray byte cannot kill a log reader. Encoding arguments only, no logic changes. tests/test_chat_text_encoding.py covers a config.json and a chat template holding umlauts, arrows and CJK, plus the remote-code scanner reading a source file with umlauts. Those pass anywhere the locale is already UTF-8, so a fourth test re-runs the readers under -X warn_default_encoding and fails on any platform if an encoding argument goes missing again. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Studio: name utf-8 explicitly on the remaining text I/O, with an AST guard (#7465) * Studio: name utf-8 explicitly on the remaining text I/O Follow-up to the model-text reads in #7467, covering the rest of the backend: system probes (nvidia-smi, amd-smi, powershell, git, node), package installers, /proc and /sys readers, and internal marker files (pid, install id, bootstrap password, Colab credentials). Same reason as #7467. open(), Path.read_text()/write_text() and subprocess(text = True) fall back to locale.getencoding(), which on Windows is the ANSI codepage rather than UTF-8. These paths are mostly ASCII today, so this is hardening, not a live bug. Encoding arguments only, no logic changes. Adds tests/test_text_io_encoding.py: an AST guard walking every backend source and asserting text I/O names its encoding, so the class of bug cannot creep back in one call at a time. 275 files. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Catch aliased subprocess and positional Path.open, migrate legacy JSONL The guard only matched a receiver literally named subprocess, so worker.py's `import subprocess as _sp` hid three text = True installs that decode pip output with the ANSI codepage. It also skipped any .open() with more than one positional argument, though Path.open takes buffering/encoding/errors/newline positionally. Resuming a scrape written by an older release is the other half: those JSONL lines are in the locale codepage, so the UTF-8 preload raised, the dedup keys were silently forgotten and duplicates were appended to a now mixed-encoding file. Decode with the locale codepage as fallback and rewrite as UTF-8 before the append handle opens, since Windows cannot replace a file it holds open. * Stream the JSONL preload and keep a torn line from relabelling the shard Reading the whole shard to migrate it was wrong twice over. These files reach gigabytes on a large scrape, so the preload now streams line by line and the rewrite streams through a temp file. Worse, one interrupted append used to condemn the file: the whole-file UTF-8 decode failed, every byte was retried as cp1252, and the rewrite persisted mojibake over records that were fine. A line now counts as legacy only if the locale codepage both decodes it and yields valid JSON, which a torn UTF-8 line does not. Damaged lines are skipped and copied through byte for byte. When the rewrite cannot be written at all, the append handle opens with the legacy encoding rather than mixing UTF-8 into the file. install_wheel takes run = subprocess.run as a parameter, so the guard cannot see it. Both wheel installs there now name their encoding. * Decide the shard's encoding from the file, not one line at a time Some byte strings parse both ways. cp1251 `Р°` is D0 B0, which is also valid UTF-8 for `а`, so a UTF-8-first parse quietly showed the wrong text instead of migrating it. A line now yields both readings, and the file decides. Any line that parses under the codepage but not as UTF-8 is unambiguous evidence, and ambiguous lines then follow that verdict, which is enough for any real shard: ordinary Cyrillic or Japanese prose is invalid UTF-8 several times per line. Keys for ambiguous lines are re-derived from the legacy reading during the rewrite. A shard is undecidable only if every line is ambiguous, and nothing can tell those apart. latin-1 is also tried after the locale codepage, so a scrape carried from Windows to a UTF-8 machine still has a reading rather than none. Requiring valid JSON, not just a decode, keeps that from claiming torn lines. * Weigh the whole shard, and never lose a record on the fallback path One structurally valid JSON line carrying a stray 0x96 parses as cp1252, so a single-line verdict let it relabel a healthy shard and mojibake every good record in it. Each line with non-ASCII bytes now votes: parsing only under the codepage is evidence for legacy, parsing as UTF-8 is evidence against, since codepage text rarely forms valid multibyte UTF-8. Ties leave the file alone. When the migration cannot be written the append handle uses the legacy codepage, and errors = "replace" quietly turned characters it cannot hold into question marks while write() still reported success. That path now escapes to \uXXXX instead, which is ASCII, so every codepage holds it and json.loads returns the exact characters. Nothing needs replacing, so errors = "strict" is safe. stream_installer runs sys.executable, so its output is now decoded as UTF-8 by utf8_child_env rather than read as the ANSI codepage. * Only rewrite a shard we can attribute, and append ASCII when we cannot latin-1 was doing too much work. It reads any byte, so it gave a moved shard a reading, but it is the right text only for cp1252: cp1251 Привет came back as Ïðèâåò and the rewrite made that permanent. The codepage is now trusted only when it is the locale's, and an untrusted reading is never written back. That leaves three cases where the file holds bytes UTF-8 cannot read and we are not converting it: no codepage to attribute it to, ambiguous lines outvoting the unambiguous ones, and a preload that could not read the file at all. All three used to append UTF-8 into it. They now append pure ASCII, which every ASCII-compatible codepage stores identically, so the file keeps decoding exactly as it did and no record is lost. Keys from the two readings are also kept apart. A damaged line in a healthy shard was marked seen through its codepage reading, so the retry that would have replaced the unreadable record was refused as a duplicate. * Let the flash-attn install stub take the kwargs the installer now passes _run_kwargs gained encoding and errors, so the one stub in this file that spelled its signature out rejected the call. The other four here already take **kwargs; this one now matches. * Do not let a stuck temp file mask the migration failure unlink() on the failure path could raise in its own right, on a stale .utf8.tmp directory or a temp another process holds. That escaped the constructor instead of returning False, so the caller never reached the ASCII append fallback that keeps the shard single-encoding. The pip fallback in install_wheel also spawns a Python child, so it gets utf8_child_env like the probe above it already had. The uv and nvidia-smi children are native binaries, where PYTHONIOENCODING would do nothing. * Stop converting legacy shards; the encoding that wrote them is unknowable trusted only ever meant that the bytes parse under this machine's codepage, which for a single-byte codepage is nearly always true. A cp1251 shard opened on a cp1252 Windows box decodes cleanly and would have been rewritten with Привет as Ïðèâåò. That is the fourth way this rewrite could corrupt a shard, and the common cause is that a file's encoding cannot be recovered from its bytes. So the rewrite is gone. The shard is left exactly as found, and appends are pure ASCII whenever it holds bytes UTF-8 cannot read, which is what actually delivered the no-mixed-encoding guarantee the rewrite was added for. Dedup keys still come from whichever reading parses, since ids are ASCII either way. This also removes the temp file, so there is no longer any file mode or ACL to carry across. * Scan the sandbox shim; it is shipped code, not a build artifact sandbox_site is on the sandboxed child's PYTHONPATH for every Python run (tools.py:332, 2660), so excluding it let two unannotated text calls through in code we ship. Both read and write the remap sidecar, which holds file paths. The exclusion list is meant for build output only, so the directory comes off it and the two calls name their encoding. * Force the worker's pip children to UTF-8, and read DBCS keys with a DBCS codec The three installer calls run sys.executable -m pip with an inherited environment, so the parent decoded UTF-8 while the child emitted the ANSI codepage. They now go through utf8_child_env like the other Python children. Two tests asserted no env kwarg was passed as a stand-in for no HIP flag being injected. They now assert the flag itself, which is the guarantee they were written for and does not depend on how the env is delivered. Separately, latin-1 cannot stand in for a double-byte codepage while recovering dedup keys: cp932 表 is 95 5C, and the trail byte reads as a JSON backslash, so the record failed to parse and its id was forgotten, appending a duplicate on resume. cp932, cp936, cp949 and cp950 are tried too. The reading is still only ever used for keys, which are ASCII and identical whichever codec parses. * Require more than one legacy line before trusting its dedup keys A shard whose valid records are all ASCII casts no UTF-8 votes, so a single damaged line won the vote by itself, its key was remembered, and the retry that would have replaced the unreadable record was refused. One such line is genuinely undecidable: a legacy record with one accented character and an ASCII record with one stray byte are the same shape. Reading it as damage costs a duplicate; reading it as legacy loses the record for good. Only one of those is recoverable, so it is now read as damage. A real legacy shard has a legacy line for every record carrying an umlaut, so its dedup is unaffected. * Append ASCII whenever the shard already holds non-ASCII bytes The gate asked whether any line was undecodable as UTF-8, which misses a shard where every legacy line happens to be valid UTF-8 too. A cp1251 shard of Р° records is bytes D0 B0 throughout, so appending 世界 as UTF-8 left a file where cp1251 reads the old records correctly and the new one as mojibake, and UTF-8 does the reverse. No single decoding recovered the whole scrape. The gate is now simply whether the shard holds any non-ASCII byte at all, which covers both cases and is easier to reason about: if what is already there reads differently under different encodings, do not add more bytes that do. Appending ASCII costs only \uXXXX escapes, which json.loads turns back into the exact characters, and it leaves the new record correct under either reading. * Skip the two Linux-gated flash-attn tests off Linux _should_try_runtime_flash_attn_install ends in sys.platform.startswith( "linux"), and the threshold test one line above already asserts exactly that, so the two tests that drive _ensure_flash_attn_for_long_context past the gate cannot pass anywhere else: the call returns before it reports a status. They were written on Linux and only surface once the suite actually runs on Windows or macOS, where both fail on an empty status list. This PR is about making the backend behave on Windows, so its own suite should be runnable there. * Fail closed when a KFD topology node does not decode This PR pins that read to utf-8, which turns an undecodable byte into UnicodeDecodeError. That is a ValueError, not an OSError, so it slips past the handler one line below and escapes a helper whose docstring promises to fail closed on any unreadable node. The caller would then lose the whole HIP-order map on a machine that has AMD GPUs, and the reason the helper fails closed is that dropping a node shifts every later ordinal and lets a similar-capacity GPU pass the total-size guard while showing another card's usage. Widening the handler is the same one-line change main already made in #7487, so the two agree and the eventual merge is clean. * Tighten the comments added in this branch * Treat an undecodable marker and undecodable metadata as malformed, not fatal Two more places where pinning the decode changed the failure mode. A UnicodeDecodeError is a ValueError, so neither `except OSError` nor `except (JSONDecodeError, OSError)` catches it, and both sites had a documented fallback that stopped being reached. An undecodable .transport marker used to read as an unknown value, and the caller then safely purged and restarted the partial download. It now aborts prepare_cache_for_transport instead, so the transfer fails rather than retrying. Undecodable .meta.json used to fall back to the file's own name, the same way invalid JSON does. It now aborts URI construction for the entire unstructured seed, so one corrupt byte in original_filename takes out the whole dataset. Both handlers are widened, matching the KFD fix earlier on this branch. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Widen two more decode guards, and pin the kernel installer's pipe Same shape as the ones already fixed here: the read was pinned to UTF-8 while the handler around it still only catches OSError, and UnicodeDecodeError is a ValueError. hf_cache_snapshot_dir answers whether a model is already on disk, and the offline embedding checks turn a raise into a 500. A torn refs/main used to decode into a nonsense commit and miss the snapshot dir; it now skips that cache root and keeps looking. _remove_pid_file runs first in _graceful_shutdown, so a corrupt studio.pid raising there abandoned the inference, export, training and tunnel children the rest of that function exists to kill. ssm_runtime's source-build path builds its subprocess kwargs in a dict and splats them through _run_with_heartbeat, so neither the encoding guard nor the earlier sweep saw the text = True in it: pip's output was still decoded with the Windows ANSI codepage, where a non-ASCII path or a compiler diagnostic mojibakes or raises over an install that was going fine. It now pins the same utf-8/replace pair install_wheel uses, and the HIP branch extends that env rather than replacing it. The guard learned the dict-literal shape and reddens on the old code (ssm_runtime.py:253). * Tighten the comments around the UTF-8 text I/O pins Collapse the multi-line rationales added with the encoding pins down to a line or two each, drop what the code already says, and use one wording for the repeated child-env note. * Do not let an unreadable bootstrap password stop startup, and narrow the kwargs guard ensure_default_admin calls _load_bootstrap_password for every existing admin and the lifespan calls that with no handler, so pinning the decode turned a damaged or pre-pin .bootstrap_password file into a backend that will not start. We write that file ourselves in UTF-8, so a byte that will not decode belongs to a file whose plaintext is worthless anyway; it now reads as no bootstrap password, the same answer as an absent file. A readable one still loads. The new kwargs check also judged every dict literal in the tree, so an unrelated payload carrying "text": True would have been reported as subprocess configuration with a misleading message, and a dict that fills in its encoding on a later line would have been reported too. It now only judges a dict that actually reaches a call, either splatted through a name or written at the call site, and treats a later kw["encoding"] assignment as satisfying it. The ssm_runtime shape it was written for is still caught, and a test pins both directions. * Stop reading a UTF-8 record a second time _read_line always parsed the line under the codepage as well, even when it had already read as UTF-8. Both callers take the UTF-8 reading when there is one and never look at the other, so on a healthy shard the second parse is pure waste, and this file reads all of one on every resume of a scrape it expects to reach gigabytes. Measured on 200,000 records, 76 MB: 1.96s before, 0.81s after, so the double reading was costing 2.8x. The early return is limited to a record, since the key lookup deliberately falls through to the codepage reading when UTF-8 yields something that is not one. A line UTF-8 cannot read still tries the codepage, latin-1 and the double-byte encodings as before, which is what the second reading is for. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Pin the scanned source fixture's line endings test_remote_code_scan_reads_non_ascii_sources compared a file's contents against the string it wrote, but wrote it in text mode, so Windows translated the line ends on the way out and the read back differed by a carriage return. That is the writer's doing, not the encoding the test is about, and it was the one failure on the Windows runner that belonged to this branch. The fixture now writes with newline = "" so the bytes on disk are the string on every platform. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Trim the newer comments to their point Shorten the widened-guard and state store notes added since the last pass, and collapse the line-ending note on the scanned source fixture. * Read the scraper checkpoint as UTF-8 only, never as a codepage A checkpoint holds nothing but base64 cursors and booleans, so one written by an older locale-encoded release is byte-identical to a UTF-8 one and already reads back. The codepage fallback can therefore only ever contribute non-ASCII: if a single-byte reading of the file were all ASCII, the UTF-8 read would have succeeded first. So the only file it changes the answer for is a damaged one, and there it turns a safe reset into a resume on a mojibaked cursor. GitHub answers that with INVALID_CURSOR_ARGUMENTS at HTTP 200, gh_client returns the partial document, and the scraper reads zero nodes and an empty pageInfo, which marks the stream done. Every later resume then skips it entirely. Reading UTF-8 only restores the earlier behaviour of dropping a checkpoint that will not decode, which re-scrapes from the first page while the writers dedup the replay. The shard scan below keeps its codepage reading; those records do carry non-ASCII. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Gate the remaining tilelang install tests to Linux _tilelang_platform_supported() returns False off Linux, so _ensure_tilelang_backend returns before the install and the subprocess mock these six assert on is never called. They fail on macOS runners for that reason alone. The rest of the file already carries this marker; these were missed. * Gate the Windows-incompatible worker and ROCm tests Two different gates, because the production code has two. The causal-conv1d and flash-linear-attention installers bail out on sys.platform == 'win32' alone and run everywhere else including macOS, so those cases get not_on_windows; marking them linux_only would skip tests that legitimately pass off Linux. The DRM and KFD readers return early unless platform.system() is Linux, and their fixtures build a fake sysfs tree needing PCI addresses like 0000:00:02.0 as directory names, which Windows cannot represent, so those get linux_only. The two visible-utilization cases failed for a different reason: on Windows get_visible_gpu_utilization takes the AMD adapter branch ahead of the torch fallback under test, and probing it imports torch, which the runner lacks. Stubbing that branch empty leaves every other platform unchanged. * Treat unparseable JSON nesting as a parse failure, and guard os.fdopen json.loads answers nesting it cannot descend with RecursionError, a RuntimeError, so _parse let it escape where the catch-all it replaced discarded the record. Both callers run _parse outside any further handler, so one damaged checkpoint or shard line aborted the scraper at startup. The encoding guard also missed os.fdopen, which is open() on a descriptor and takes the same locale default in text mode. It flags exactly the two text-mode calls that were left unencoded; the swap lock file's reader was already pinned to UTF-8 while its writer still used the codepage. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Write the non-ASCII source fixture without a 3.10-only argument Path.write_text() only grew newline in 3.10, and pyproject declares requires-python >=3.9, so this raised TypeError there. open() takes the same argument on every supported version and pins the bytes on disk the same way. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Tighten encoding comments * Follow subprocess calls through callable aliases in the encoding guard --------- Co-authored-by: Unsloth <michaelhan@Michaels-MacBook-Pro.local> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: danielhanchen <unslothshared@gmail.com> --------- Co-authored-by: Unsloth <michaelhan@Michaels-MacBook-Pro.local> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: danielhanchen <unslothshared@gmail.com>
497 lines
20 KiB
Python
497 lines
20 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
|
|
|
|
"""In-app whisper.cpp prebuilt update.
|
|
|
|
Builds on utils.whisper_cpp_freshness (which detects whether a newer prebuilt
|
|
release exists) and adds the *apply* half: run install_whisper_prebuilt.py to
|
|
download the newest bundle for this host and atomically swap it in, so the next
|
|
model load uses it. Applies only run as the whisper phase of the combined
|
|
llama+whisper update (utils.llama_cpp_update.start_update chains
|
|
run_chained_phase); there is no standalone whisper update trigger.
|
|
|
|
Design notes:
|
|
- Detection is delegated to check_prebuilt_freshness(). We surface an
|
|
``update_available`` flag (installed_tag != latest_tag), laxer than freshness'
|
|
``stale`` (which also requires the install to be >= 3 days old). The UI shows
|
|
the single main update item on update_available.
|
|
- Everything fails open: a missing marker / offline GitHub / source build just
|
|
reports update_available=False and never blocks the app.
|
|
- The mechanics (managed-root resolution, local-link detection, the resolve
|
|
probe, the streamed installer run) live in utils.prebuilt.update_flow; this
|
|
module keeps the whisper policy. The ``job`` dict in the status payload stays
|
|
idle (kept for response-shape stability): chained applies report progress
|
|
through the llama job.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
import threading
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
|
|
import structlog
|
|
|
|
from utils.prebuilt import update_flow as _flow
|
|
from utils.prebuilt.whisper_layout import canonical_install_root
|
|
from utils.whisper_cpp_freshness import (
|
|
_INSTALL_MARKER_NAME,
|
|
check_prebuilt_freshness,
|
|
is_behind,
|
|
latest_published_release,
|
|
latest_release_assets,
|
|
parse_release_version,
|
|
read_install_marker,
|
|
reset_caches,
|
|
update_download_size_bytes,
|
|
)
|
|
|
|
logger = structlog.get_logger(__name__)
|
|
|
|
DEFAULT_PUBLISHED_REPO = "unslothai/whisper.cpp"
|
|
_INSTALL_TIMEOUT_SECONDS = 1800 # 30 min ceiling for download + extract/validate
|
|
|
|
# Always-idle job payload: whisper applies run inside the chained llama job, so
|
|
# nothing flips this to running. Kept so status payload shapes stay stable.
|
|
_job_lock = threading.Lock()
|
|
_job: dict = _flow.new_job()
|
|
|
|
_rocm_install_args = _flow.rocm_install_args
|
|
|
|
|
|
def _find_binary() -> Optional[str]:
|
|
"""Locate the active whisper-server binary via the STT sidecar's own resolver
|
|
so update targets exactly what Unsloth runs. Lazy import keeps the heavy
|
|
inference module off this module's import path."""
|
|
try:
|
|
from core.inference.stt_ggml_sidecar import find_whisper_server_binary
|
|
return find_whisper_server_binary()
|
|
except Exception as exc: # pragma: no cover - defensive
|
|
logger.debug("whisper update: binary discovery failed", error = str(exc))
|
|
return None
|
|
|
|
|
|
def _install_dir_for(binary_path: Optional[str]) -> Optional[Path]:
|
|
"""The directory holding UNSLOTH_WHISPER_PREBUILT_INFO.json: the install root
|
|
install_whisper_prebuilt.py wrote (``<install-dir>`` whose canonical server is
|
|
``build/bin/whisper-server``) and the one we re-install into."""
|
|
root = canonical_install_root(binary_path)
|
|
if root is not None and (root / _INSTALL_MARKER_NAME).is_file():
|
|
return root
|
|
return _flow.install_dir_for(binary_path, marker_name = _INSTALL_MARKER_NAME)
|
|
|
|
|
|
def _installer_script() -> Optional[Path]:
|
|
"""Locate install_whisper_prebuilt.py (UNSLOTH_WHISPER_INSTALLER wins)."""
|
|
return _flow.find_installer_script(
|
|
env_var = "UNSLOTH_WHISPER_INSTALLER", script_name = "install_whisper_prebuilt.py"
|
|
)
|
|
|
|
|
|
# Markerless (source-build) installs have no UNSLOTH_WHISPER_PREBUILT_INFO.json,
|
|
# so we ask the installer whether an official prebuilt now exists for this host.
|
|
_resolve_memo: dict = {}
|
|
|
|
|
|
def _resolve_prebuilt_for_host(
|
|
*, force_refresh: bool = False, backend: Optional[str] = None
|
|
) -> Optional[dict]:
|
|
"""Run install_whisper_prebuilt.py --resolve-prebuilt (no download); return
|
|
{prebuilt_available, repo, release_tag, upstream_tag, backend, asset, os,
|
|
arch, ...} or None. Fail-open: any error -> None so a source build never
|
|
blocks the app."""
|
|
extra_args = ("--backend", backend) if backend else ()
|
|
return _flow.resolve_prebuilt_for_host(
|
|
force_refresh = force_refresh,
|
|
memo = _resolve_memo,
|
|
installer_script = lambda: _installer_script(),
|
|
log_message = "whisper update: resolve-prebuilt failed",
|
|
extra_args = extra_args,
|
|
)
|
|
|
|
|
|
def _installed_whisper_version(binary: Optional[str]) -> Optional[str]:
|
|
"""Best-effort ``v<A.B.C>`` from ``whisper-server --version``. None when the
|
|
binary is missing, reports no version, or cannot run. Used only for the
|
|
markerless source-build downgrade guard, so it fails open to None."""
|
|
if not binary:
|
|
return None
|
|
try:
|
|
proc = subprocess.run(
|
|
[binary, "--version"],
|
|
capture_output = True,
|
|
text = True,
|
|
encoding = "utf-8",
|
|
errors = "replace",
|
|
timeout = 20,
|
|
)
|
|
except Exception: # pragma: no cover - defensive
|
|
return None
|
|
m = re.search(r"v?(\d+\.\d+\.\d+)", (proc.stderr or "") + (proc.stdout or ""))
|
|
if not m:
|
|
return None
|
|
return f"v{m.group(1)}"
|
|
|
|
|
|
def _whisper_install_root(binary: Optional[str]) -> Optional[Path]:
|
|
"""The Unsloth-managed whisper.cpp root the active binary lives under, or None
|
|
when the binary is unmanaged (see update_flow.managed_install_root)."""
|
|
return _flow.managed_install_root(
|
|
binary,
|
|
marker_root = _install_dir_for(binary),
|
|
server_path_var = "WHISPER_SERVER_PATH",
|
|
cpp_path_var = "UNSLOTH_WHISPER_CPP_PATH",
|
|
dir_name = "whisper.cpp",
|
|
)
|
|
|
|
|
|
def _source_build_status(binary: str, *, force_refresh: bool) -> Optional[dict]:
|
|
"""Update status for a markerless (source-build) install: offer the official
|
|
prebuilt when one exists for this host and is newer than the installed binary.
|
|
None -> caller falls through to the no-marker default (unsupported)."""
|
|
res = _resolve_prebuilt_for_host(force_refresh = force_refresh)
|
|
if not res or not res.get("prebuilt_available"):
|
|
return None
|
|
release_tag = res.get("release_tag")
|
|
if not release_tag:
|
|
return None
|
|
# No resolvable install root (e.g. a pinned WHISPER_SERVER_PATH we cannot
|
|
# manage) means an apply would not take effect, so do not offer it.
|
|
if _whisper_install_root(binary) is None:
|
|
return None
|
|
installed_tag = _installed_whisper_version(binary)
|
|
installed_key = parse_release_version(installed_tag) if installed_tag else None
|
|
latest_key = parse_release_version(release_tag)
|
|
if installed_key is None or latest_key is None:
|
|
# Unknown installed/latest version (involuntary source-build case): treat
|
|
# as behind so we still offer the prebuilt.
|
|
update_available = True
|
|
else:
|
|
# Same downgrade guard as is_behind: only a strictly newer key is behind.
|
|
update_available = latest_key > installed_key
|
|
latest = release_tag
|
|
# Size of the resolved prebuilt, so source builds show it like the marker
|
|
# path. Fails open to None (offline / asset absent from release).
|
|
update_size_bytes = None
|
|
if update_available:
|
|
asset_name = res.get("asset")
|
|
if isinstance(asset_name, str) and asset_name:
|
|
try:
|
|
assets = latest_release_assets(res.get("repo"), force_refresh = force_refresh)
|
|
if assets:
|
|
update_size_bytes = assets.get(asset_name)
|
|
except Exception as exc: # pragma: no cover - network defensive
|
|
logger.debug("whisper update: source-build size lookup failed", error = str(exc))
|
|
with _job_lock:
|
|
job = dict(_job)
|
|
return {
|
|
"supported": True,
|
|
"update_available": update_available,
|
|
"stale": False,
|
|
"installed_tag": installed_tag,
|
|
"latest_tag": latest,
|
|
"published_repo": res.get("repo"),
|
|
"installed_at_utc": None,
|
|
"age_days": None,
|
|
"source_build": True,
|
|
"update_size_bytes": update_size_bytes,
|
|
"job": job,
|
|
}
|
|
|
|
|
|
def _active_install_is_local_link(binary: Optional[str]) -> bool:
|
|
"""True when the active whisper-server resolves through a locally-linked
|
|
whisper.cpp directory (see update_flow.active_install_is_local_link)."""
|
|
return _flow.active_install_is_local_link(binary, dir_name = "whisper.cpp")
|
|
|
|
|
|
def _local_link_status() -> dict:
|
|
"""Status payload for a local-link install: unmanaged, no update offered."""
|
|
return _flow.local_link_status(_job, _job_lock)
|
|
|
|
|
|
def get_update_status(*, force_refresh: bool = False) -> dict:
|
|
"""Report whether a newer prebuilt exists plus the current job state.
|
|
|
|
force_refresh bypasses the 24h release cache for an explicit "check now".
|
|
"""
|
|
binary = _find_binary()
|
|
# A locally-linked whisper.cpp dir is the user's own tree; never offer to
|
|
# replace it. Bail before any network/freshness work.
|
|
if _active_install_is_local_link(binary):
|
|
return _local_link_status()
|
|
marker = read_install_marker(binary)
|
|
|
|
# No marker = source build / custom path. Offer the official prebuilt if one
|
|
# exists for this host.
|
|
if marker is None and binary is not None:
|
|
src = _source_build_status(binary, force_refresh = force_refresh)
|
|
if src is not None:
|
|
return src
|
|
|
|
repo = (marker or {}).get("published_repo") or DEFAULT_PUBLISHED_REPO
|
|
|
|
if force_refresh and repo:
|
|
# Prime the cache so the freshness read below sees the newest tag.
|
|
try:
|
|
latest_published_release(repo, force_refresh = True)
|
|
except Exception as exc: # pragma: no cover - network defensive
|
|
logger.debug("whisper update: force refresh failed", error = str(exc))
|
|
|
|
freshness = check_prebuilt_freshness(binary)
|
|
installed = freshness.get("installed_tag")
|
|
latest = freshness.get("latest_tag")
|
|
compatible_override = False
|
|
if sys.platform == "darwin" and marker is not None:
|
|
# The newest published release may require a newer macOS. Ask the same
|
|
# host-aware resolver the installer uses so the banner compares against
|
|
# the newest release this host can actually install, avoiding a repeated
|
|
# offer of an incompatible release after walkback.
|
|
resolved = _resolve_prebuilt_for_host(
|
|
force_refresh = force_refresh,
|
|
backend = marker.get("backend") if isinstance(marker.get("backend"), str) else None,
|
|
)
|
|
compatible_latest = (resolved or {}).get("release_tag")
|
|
if (resolved or {}).get("prebuilt_available") and isinstance(compatible_latest, str):
|
|
compatible_override = compatible_latest != latest
|
|
latest = compatible_latest
|
|
# `behind` compares the release version with a downgrade guard, so a lagging
|
|
# /releases/latest or lower published tag can't show a false update
|
|
# (whisper_cpp_freshness.is_behind).
|
|
update_available = bool(
|
|
freshness.get("has_marker")
|
|
and (
|
|
is_behind(installed, latest)
|
|
if sys.platform == "darwin" and marker is not None
|
|
else freshness.get("behind")
|
|
)
|
|
)
|
|
|
|
# Size of the prebuilt Update would download, for the banner. Only when an
|
|
# update is offered; fails open to None (offline / no matching asset).
|
|
update_size_bytes = None
|
|
if update_available and not compatible_override:
|
|
try:
|
|
update_size_bytes = update_download_size_bytes(
|
|
marker,
|
|
latest,
|
|
freshness.get("published_repo") or repo,
|
|
force_refresh = force_refresh,
|
|
)
|
|
except Exception as exc: # pragma: no cover - network defensive
|
|
logger.debug("whisper update: size lookup failed", error = str(exc))
|
|
|
|
with _job_lock:
|
|
job = dict(_job)
|
|
|
|
return {
|
|
"supported": bool(freshness.get("has_marker")),
|
|
"update_available": update_available,
|
|
"stale": bool(update_available and freshness.get("stale")),
|
|
"installed_tag": installed,
|
|
"latest_tag": latest,
|
|
"published_repo": freshness.get("published_repo") or repo,
|
|
"installed_at_utc": freshness.get("installed_at_utc"),
|
|
"age_days": freshness.get("age_days"),
|
|
"source_build": False,
|
|
"update_size_bytes": update_size_bytes,
|
|
"job": job,
|
|
}
|
|
|
|
|
|
def _install_latest(
|
|
install_dir: Path,
|
|
repo: str,
|
|
asset: Optional[str],
|
|
backend: Optional[str],
|
|
script: Path,
|
|
set_progress,
|
|
pin_release_tag: Optional[str] = None,
|
|
) -> dict:
|
|
"""Replace whisper.cpp while the sidecar blocks every new load."""
|
|
try:
|
|
from core.inference.stt_ggml_sidecar import get_ggml_stt_sidecar
|
|
sidecar = get_ggml_stt_sidecar()
|
|
except Exception as exc:
|
|
# Replacing the tree without the singleton's maintenance barrier would
|
|
# reopen the Windows executable-lock and stale-process races. Fail closed.
|
|
raise RuntimeError("could not coordinate the whisper.cpp sidecar update") from exc
|
|
|
|
# update_maintenance publishes its guard before waiting for an existing
|
|
# transcription, unloads the warm server, and holds the sidecar lock across
|
|
# the complete atomic install. No new process can relock or outlive the tree.
|
|
with sidecar.update_maintenance() as model_was_active:
|
|
return _install_latest_while_blocked(
|
|
install_dir,
|
|
repo,
|
|
asset,
|
|
backend,
|
|
script,
|
|
set_progress,
|
|
pin_release_tag = pin_release_tag,
|
|
model_was_active = model_was_active,
|
|
)
|
|
|
|
|
|
def _install_latest_while_blocked(
|
|
install_dir: Path,
|
|
repo: str,
|
|
asset: Optional[str],
|
|
backend: Optional[str],
|
|
script: Path,
|
|
set_progress,
|
|
*,
|
|
pin_release_tag: Optional[str],
|
|
model_was_active: bool,
|
|
) -> dict:
|
|
"""Run the installer with the sidecar already in update maintenance."""
|
|
|
|
cmd = [
|
|
sys.executable,
|
|
str(script),
|
|
"--install-dir",
|
|
str(install_dir),
|
|
"--whisper-tag",
|
|
"latest",
|
|
"--published-repo",
|
|
repo,
|
|
]
|
|
# Preserve the installed accelerator across updates. Left unpinned the
|
|
# installer re-detects the host, fine on unchanged hardware but able to
|
|
# reroute a deliberate choice (e.g. cpu on a GPU box); forwarding the marker's
|
|
# backend keeps the same slice.
|
|
if isinstance(backend, str) and backend:
|
|
cmd.extend(["--backend", backend])
|
|
if pin_release_tag:
|
|
cmd.extend(["--published-release-tag", pin_release_tag])
|
|
cmd.extend(_rocm_install_args(asset))
|
|
logger.info("whisper update: installing", cmd = " ".join(cmd))
|
|
env = dict(os.environ, UNSLOTH_PROGRESS_PERCENT_STEP = "5")
|
|
# Every nonzero exit is a failed phase. In particular, exit 2 means the
|
|
# requested release was incompatible and no install happened, so reporting
|
|
# success would hide the banner and toast an update that never landed.
|
|
_flow.stream_installer(
|
|
cmd,
|
|
env,
|
|
set_progress = set_progress,
|
|
timeout_seconds = _INSTALL_TIMEOUT_SECONDS,
|
|
)
|
|
|
|
# Drop stale caches so the banner re-checks the swapped marker. If GitHub is
|
|
# offline, latest stays unknown and the banner fails open.
|
|
reset_caches(drop_disk = True)
|
|
try:
|
|
latest_published_release(repo, force_refresh = True)
|
|
except Exception as exc: # pragma: no cover - network defensive
|
|
logger.debug("whisper update: post-install freshness refresh failed", error = str(exc))
|
|
new_marker = read_install_marker(_find_binary())
|
|
new_tag = (new_marker or {}).get("release_tag")
|
|
logger.info("whisper update: success", to_tag = new_tag)
|
|
return {
|
|
"to_tag": new_tag,
|
|
"reload_required": model_was_active,
|
|
"message": (
|
|
f"Updated whisper.cpp to {new_tag}."
|
|
+ (" Reload your model to use it." if model_was_active else "")
|
|
),
|
|
}
|
|
|
|
|
|
def chained_phase_plan(
|
|
*, force_refresh: bool = False, paired_llama_will_update: bool = False
|
|
) -> dict:
|
|
"""Whisper's side of the combined llama+whisper update item.
|
|
|
|
Returns {status, update_available, skip_reason, phase}: `status` is the
|
|
marker-path status dict (or a minimal one when whisper is skipped),
|
|
`update_available` says the chained apply would run a whisper phase, and
|
|
`phase` carries what run_chained_phase needs. Only marker-managed installs are
|
|
chained: local links, source builds and unmanaged/pinned paths are silently
|
|
skipped so whisper can never block a llama update. Never raises; failures
|
|
degrade to a skip."""
|
|
binary = _find_binary()
|
|
if _active_install_is_local_link(binary):
|
|
return {
|
|
"status": _local_link_status(),
|
|
"update_available": False,
|
|
"skip_reason": "local_link",
|
|
"phase": None,
|
|
}
|
|
marker = read_install_marker(binary)
|
|
if marker is None:
|
|
# No marker: whisper is absent or a source/custom build. The standalone
|
|
# utils API can update source builds; the chain does not.
|
|
return {
|
|
"status": None,
|
|
"update_available": False,
|
|
"skip_reason": "source_build" if binary else "not_installed",
|
|
"phase": None,
|
|
}
|
|
status = get_update_status(force_refresh = force_refresh)
|
|
plan: dict = {"status": status, "update_available": False, "skip_reason": None, "phase": None}
|
|
if not status.get("update_available"):
|
|
# Skew note: when llama just updated but whisper is already latest, a slim
|
|
# install keeps hardlinks to the OLD llama ggml inodes -- still the exact
|
|
# build whisper was installed against, so skipping is correct and needs no
|
|
# re-wiring. A whisper phase that does run re-wires via the installer
|
|
# (prepare_runtime_payload).
|
|
plan["skip_reason"] = "up_to_date"
|
|
return plan
|
|
if marker.get("install_kind") == "slim" and not paired_llama_will_update:
|
|
# A slim install can only be refreshed from a completed managed llama
|
|
# prebuilt. Ask the installer through its read-only resolver so local
|
|
# links, markerless/current source builds, and incomplete managed trees
|
|
# never produce an Update button that can only fail. When the llama
|
|
# phase will run first, it supplies the repaired pairing instead.
|
|
resolved = _resolve_prebuilt_for_host(
|
|
force_refresh = force_refresh,
|
|
backend = marker.get("backend") if isinstance(marker.get("backend"), str) else None,
|
|
)
|
|
if not (resolved or {}).get("prebuilt_available"):
|
|
plan["skip_reason"] = "paired_llama_unavailable"
|
|
return plan
|
|
script = _installer_script()
|
|
if script is None:
|
|
plan["skip_reason"] = "installer_missing"
|
|
return plan
|
|
install_dir = _install_dir_for(binary)
|
|
if install_dir is None:
|
|
plan["skip_reason"] = "no_install_dir"
|
|
return plan
|
|
plan["update_available"] = True
|
|
plan["phase"] = {
|
|
"install_dir": install_dir,
|
|
"repo": marker.get("published_repo") or DEFAULT_PUBLISHED_REPO,
|
|
"asset": marker.get("asset"),
|
|
"backend": marker.get("backend"),
|
|
"script": script,
|
|
# Install exactly the release the check offered: the installer's unpinned
|
|
# "latest" prefers the download-host /releases/latest pointer, which sorts
|
|
# by commit date and can lag the published_at pick the freshness check
|
|
# used, reinstalling an older build in a loop (the #6219 class the llama
|
|
# phase pins against). Not on macOS: the llama phase is unpinned there
|
|
# (walk-back to an os-compatible release), so pinning whisper to the
|
|
# newest tag could be an impossible pairing (min_os / requires_llama_tag)
|
|
# on every retry.
|
|
"pin_release_tag": None if sys.platform == "darwin" else status.get("latest_tag"),
|
|
}
|
|
return plan
|
|
|
|
|
|
def run_chained_phase(phase: dict, set_progress) -> dict:
|
|
"""Run the whisper phase of a combined update (spec from chained_phase_plan):
|
|
same unload/install/cache-refresh path as the standalone job, reporting
|
|
progress through the chained job's window rather than whisper's own."""
|
|
return _install_latest(
|
|
phase["install_dir"],
|
|
phase["repo"],
|
|
phase["asset"],
|
|
phase["backend"],
|
|
phase["script"],
|
|
set_progress,
|
|
pin_release_tag = phase.get("pin_release_tag"),
|
|
)
|