unsloth/tests/studio/test_cli_repo_variant.py
Roland Tannous dbea77e347
Studio: forward llama-server args from unsloth studio run , activate unsloth run , and allow passing model:quant to load models (#5271)
* Studio: forward unknown CLI args directly to llama-server

`unsloth studio run --model X --top-k 20 --chat-template-file foo.jinja`
now passes the unknown flags through to the llama-server subprocess.
Adds a denylist for flags Studio manages (port, -m, -c, --api-key, -ngl,
--flash-attn, --no-context-shift, --jinja, GPU-fit, model-identity, ...)
that returns HTTP 400 on collision. HTTP callers can supply the same
list via LoadRequest.llama_extra_args.

* Studio: accept `--model org/repo:variant` shorthand in `unsloth studio run`

Mirrors llama.cpp's `-hf <repo>:<quant>` and ollama's pull syntax so
`unsloth studio run --model unsloth/gpt-oss-20b-GGUF:UD-Q4_K_XL` is
equivalent to `--model unsloth/... --gguf-variant UD-Q4_K_XL`. Local
paths and Windows drive letters are preserved verbatim. If both an
embedded variant and an explicit `--gguf-variant` are given and they
disagree, the command fails with a clear error.

* Studio: register `unsloth run` as alias for `unsloth studio run`

Top-level `unsloth run --model ...` is now equivalent to
`unsloth studio run --model ...`. Same context_settings, so unknown
flags continue to pass through to llama-server.

* Studio: let users override soft-managed llama-server flags from CLI

Trims the denylist to flags Studio fundamentally cannot share with
the user (model identity, --host/--port/--path/--api-prefix,
--api-key, --ssl-*, --webui, --models-*). Soft-managed flags --
-c/--ctx-size, --parallel, --flash-attn, --no-context-shift,
--jinja, -ngl, -t/--threads, --fit* -- now pass through and override
Studio's auto-set version via llama.cpp's last-wins CLI parsing.

Lets users tune their run on the spot:
  unsloth run --model X -c 131072 --parallel 1 --threads 32

* Studio: accept `-hf` / `-hfr` / `--hf-repo` as aliases for `--model`

Matches llama-server's `-hf <repo>:<quant>` spelling so users coming
from llama.cpp can use the same flag. Typer claims the aliases before
the pass-through validator runs, so the HTTP-API denylist on those
flags is unaffected.

  unsloth run -hf unsloth/gpt-oss-20b-GGUF:UD-Q4_K_XL
2026-05-04 17:08:04 +04:00

145 lines
4.2 KiB
Python

"""Tests for the ``repo:variant`` shorthand parser used by ``unsloth studio run``.
Loads ``unsloth_cli/commands/studio.py`` directly via ``importlib`` with a
minimal ``typer`` stub so the test doesn't drag in the rest of
``unsloth_cli`` (which transitively imports the unsloth training stack).
"""
from __future__ import annotations
import importlib.util
import sys
import types
from pathlib import Path
import pytest
def _load_split_repo_variant():
"""Load ``_split_repo_variant`` from studio.py with typer stubbed.
studio.py decorates Typer commands at import time, so a stub that
accepts (and discards) those calls is enough to let module
execution complete and expose the helper we want to test.
"""
if "typer" not in sys.modules:
typer_stub = types.ModuleType("typer")
class _Typer:
def __init__(self, **kwargs):
pass
def callback(self, *args, **kwargs):
return lambda fn: fn
def command(self, *args, **kwargs):
return lambda fn: fn
typer_stub.Typer = _Typer
typer_stub.Option = lambda *args, **kwargs: (args[0] if args else None)
typer_stub.Context = type("Context", (), {})
typer_stub.Exit = type("Exit", (Exception,), {})
typer_stub.echo = lambda *args, **kwargs: None
sys.modules["typer"] = typer_stub
studio_py = (
Path(__file__).resolve().parents[2] / "unsloth_cli" / "commands" / "studio.py"
)
spec = importlib.util.spec_from_file_location(
"_studio_for_repo_variant_test", studio_py
)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
return module._split_repo_variant
_split = _load_split_repo_variant()
# ── HF-style repo:variant inputs -------------------------------------
@pytest.mark.parametrize(
"model_arg, expected",
[
(
"unsloth/gpt-oss-20b-GGUF:UD-Q4_K_XL",
("unsloth/gpt-oss-20b-GGUF", "UD-Q4_K_XL"),
),
("unsloth/gpt-oss-120b-GGUF:Q4_K_XL", ("unsloth/gpt-oss-120b-GGUF", "Q4_K_XL")),
("unsloth/Qwen3-0.6B-GGUF:Q4_K_M", ("unsloth/Qwen3-0.6B-GGUF", "Q4_K_M")),
# Variants commonly contain dashes, dots, and underscores.
("org/repo:UD-Q5_K_M", ("org/repo", "UD-Q5_K_M")),
("org/repo:F16", ("org/repo", "F16")),
],
)
def test_repo_variant_split(model_arg, expected):
assert _split(model_arg) == expected
# ── No variant suffix ------------------------------------------------
@pytest.mark.parametrize(
"model_arg",
[
"unsloth/gpt-oss-20b-GGUF",
"unsloth/Qwen3-0.6B-GGUF",
"shorthand-no-org-no-colon",
],
)
def test_no_colon_returns_none_variant(model_arg):
repo, variant = _split(model_arg)
assert repo == model_arg
assert variant is None
# ── Local paths must NOT be split ------------------------------------
@pytest.mark.parametrize(
"local_path",
[
"/abs/path/to/model.gguf",
"/abs/path:with-colon-in-name",
"./relative/model",
"../parent/model",
"~/home/model",
".",
"C:\\Users\\me\\model.gguf",
"C:/Users/me/model.gguf",
"D:/data/model:Q4", # Windows drive + colon-suffixed filename: drive wins
],
)
def test_local_path_passthrough(local_path):
repo, variant = _split(local_path)
assert repo == local_path
assert variant is None
# ── Edge cases -------------------------------------------------------
def test_empty_string():
assert _split("") == ("", None)
def test_trailing_colon_no_variant():
# "org/repo:" -- no quant label after the colon. Pass through
# unchanged so the backend's existing validation surfaces a
# clearer error than "variant ''".
repo, variant = _split("org/repo:")
assert repo == "org/repo:"
assert variant is None
def test_slash_in_variant_disqualifies_split():
# "foo:bar/baz" -- the suffix has a slash, so this isn't a quant
# label; treat the whole thing as opaque.
repo, variant = _split("foo:bar/baz")
assert repo == "foo:bar/baz"
assert variant is None
def test_whitespace_stripped():
assert _split(" org/repo:Q4 ") == ("org/repo", "Q4")