Compare commits
12 Commits
fix/139-qu
...
step35/94-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
89bf027780 | ||
| 7797b9b4c8 | |||
| 0338cf940a | |||
| f3f796fa64 | |||
| 6ab98d65f5 | |||
| c4293f0d31 | |||
| 88a5c48402 | |||
| 3ff52f02b2 | |||
| 8475539070 | |||
|
|
f0f117cdd3 | ||
|
|
a537511652 | ||
|
|
cd18bd06be |
@@ -18,7 +18,17 @@ jobs:
|
||||
find . -name '*.py' | grep -v llama-cpp-fork | xargs -r python3 -m py_compile
|
||||
find . -name '*.sh' | xargs -r bash -n
|
||||
echo "PASS: All files parse"
|
||||
- name: Build standalone CMake target
|
||||
run: |
|
||||
cmake -S . -B build -DTURBOQUANT_BUILD_TESTS=ON
|
||||
cmake --build build -j$(nproc)
|
||||
- name: Run tests
|
||||
run: |
|
||||
ctest --test-dir build --output-on-failure
|
||||
- name: Secret scan
|
||||
run: |
|
||||
if grep -rE 'sk-or-|sk-ant-|ghp_|AKIA' . --include='*.yml' --include='*.py' --include='*.sh' 2>/dev/null | grep -v .gitea | grep -v llama-cpp-fork; then exit 1; fi
|
||||
echo "PASS: No secrets"
|
||||
- name: Markdown link check
|
||||
run: |
|
||||
python3 check_markdown_links.py
|
||||
|
||||
56
benchmarks/m1-mac-template.md
Normal file
56
benchmarks/m1-mac-template.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# TurboQuant M1 Mac Benchmark — 2026-04-15
|
||||
|
||||
**Status:** Template — run `benchmarks/m1_mac_benchmark.py` on M1 Mac to populate.
|
||||
**Issue:** #94
|
||||
|
||||
## Hardware
|
||||
|
||||
| Spec | Value |
|
||||
|------|-------|
|
||||
| Chip | Apple M1 (or M1 Pro/Max/Ultra) |
|
||||
| Memory | 8/16/32/64 GB unified |
|
||||
| P-cores | 4/6/8 |
|
||||
| E-cores | 2 |
|
||||
| GPU cores | 7/8/14/16/24/32 |
|
||||
| macOS | 14.x |
|
||||
|
||||
## Results
|
||||
|
||||
| Preset | KV Type | Bits/ch | Compression | Avg tok/s | Peak Memory | GSM8K | Tool Call |
|
||||
|--------|---------|---------|-------------|-----------|-------------|-------|-----------|
|
||||
| turboquant_k8v4 | turbo4 | 3.5 | 4.2x | TBD | TBD | TBD | TBD |
|
||||
| turboquant_4bit_nc | q4_0 | 4.0 | 3.5x | TBD | TBD | TBD | TBD |
|
||||
| turboquant_3bit_nc | q3_k | 3.0 | 5.0x | TBD | TBD | TBD | TBD |
|
||||
|
||||
## How to Run
|
||||
|
||||
```bash
|
||||
# 1. Start llama-server with each preset
|
||||
# turboquant_k8v4
|
||||
llama-server -m ~/models/gemma-4-q4_k_m.gguf --port 8081 -ctk turbo4 -ctv turbo4 -c 4096
|
||||
|
||||
# 2. Run benchmark
|
||||
cd turboquant
|
||||
python3 benchmarks/m1_mac_benchmark.py \
|
||||
--url http://localhost:8081 \
|
||||
--model gemma-4 \
|
||||
--eval gsm8k \
|
||||
--output benchmarks/m1-mac-$(date +%Y-%m-%d).md
|
||||
|
||||
# 3. Repeat for other presets (change -ctk/-ctv)
|
||||
# turboquant_4bit_nc: -ctk q4_0 -ctv q4_0
|
||||
# turboquant_3bit_nc: -ctk q3_k -ctv q3_k
|
||||
|
||||
# 4. Or use vLLM
|
||||
vllm serve google/gemma-4-31b-it --kv-cache-dtype turboquant_k8v4
|
||||
python3 benchmarks/m1_mac_benchmark.py --backend vllm --eval gsm8k
|
||||
```
|
||||
|
||||
## Recommendation
|
||||
|
||||
**Default:** TBD after benchmarks complete.
|
||||
|
||||
Decision criteria:
|
||||
- If turboquant_k8v4 GSM8K ≥ turboquant_4bit_nc GSM8K: use k8v4 (better compression, same quality)
|
||||
- If 3bit GSM8K drops >10%: don't use as default
|
||||
- Memory headroom: must fit model + KV within 70% of unified memory
|
||||
652
benchmarks/m1_mac_benchmark.py
Normal file
652
benchmarks/m1_mac_benchmark.py
Normal file
@@ -0,0 +1,652 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
m1_mac_benchmark.py — Benchmark TurboQuant presets on Apple Silicon.
|
||||
|
||||
Runs all three TurboQuant presets through standardized benchmarks,
|
||||
measuring tokens/sec, peak memory, and quality. Produces a markdown
|
||||
results table for issue #94.
|
||||
|
||||
Presets:
|
||||
- turboquant_k8v4: PolarQuant WHT + 8-bit codebook + 4-bit QJL residual
|
||||
- turboquant_4bit_nc: 4-bit KV cache, no correction
|
||||
- turboquant_3bit_nc: 3-bit KV cache, no correction
|
||||
|
||||
Usage:
|
||||
# Full benchmark (requires llama-server running per preset)
|
||||
python3 benchmarks/m1_mac_benchmark.py
|
||||
|
||||
# Single preset
|
||||
python3 benchmarks/m1_mac_benchmark.py --preset turboquant_k8v4
|
||||
|
||||
# Custom server URL
|
||||
python3 benchmarks/m1_mac_benchmark.py --url http://localhost:8081
|
||||
|
||||
# With quality eval (GSM8K subset)
|
||||
python3 benchmarks/m1_mac_benchmark.py --eval gsm8k
|
||||
|
||||
# JSON output
|
||||
python3 benchmarks/m1_mac_benchmark.py --json
|
||||
|
||||
# Dry-run (validate framework without inference)
|
||||
python3 benchmarks/m1_mac_benchmark.py --dry-run
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
import platform
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
from dataclasses import dataclass, field, asdict
|
||||
from datetime import datetime, timezone
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
try:
|
||||
import requests
|
||||
except ImportError:
|
||||
requests = None
|
||||
|
||||
# ── TurboQuant Presets ────────────────────────────────────────────────────────
|
||||
|
||||
@dataclass
|
||||
class Preset:
|
||||
"""A TurboQuant KV cache preset."""
|
||||
name: str
|
||||
kv_type: str # -ctk/-ctv value for llama-server
|
||||
bits_per_channel: float
|
||||
compression_ratio: float
|
||||
description: str
|
||||
# vLLM equivalent (for vllm serve --kv-cache-dtype)
|
||||
vllm_dtype: str = ""
|
||||
|
||||
|
||||
PRESETS = {
|
||||
"turboquant_k8v4": Preset(
|
||||
name="turboquant_k8v4",
|
||||
kv_type="turbo4",
|
||||
bits_per_channel=3.5,
|
||||
compression_ratio=4.2,
|
||||
description="PolarQuant WHT + 8-bit codebook + 4-bit QJL residual. Best quality/compression ratio.",
|
||||
vllm_dtype="turboquant_k8v4",
|
||||
),
|
||||
"turboquant_4bit_nc": Preset(
|
||||
name="turboquant_4bit_nc",
|
||||
kv_type="q4_0",
|
||||
bits_per_channel=4.0,
|
||||
compression_ratio=3.5,
|
||||
description="4-bit KV cache, no correction. Standard baseline.",
|
||||
vllm_dtype="turboquant_4bit_nc",
|
||||
),
|
||||
"turboquant_3bit_nc": Preset(
|
||||
name="turboquant_3bit_nc",
|
||||
kv_type="q3_k",
|
||||
bits_per_channel=3.0,
|
||||
compression_ratio=5.0,
|
||||
description="3-bit KV cache, no correction. Aggressive compression, lower quality.",
|
||||
vllm_dtype="turboquant_3bit_nc",
|
||||
),
|
||||
}
|
||||
|
||||
|
||||
# ── Hardware Detection ────────────────────────────────────────────────────────
|
||||
|
||||
@dataclass
|
||||
class AppleSiliconInfo:
|
||||
"""Detected Apple Silicon hardware."""
|
||||
chip_name: str = ""
|
||||
total_memory_gb: float = 0.0
|
||||
performance_cores: int = 0
|
||||
efficiency_cores: int = 0
|
||||
gpu_cores: int = 0
|
||||
os_version: str = ""
|
||||
|
||||
|
||||
def detect_apple_silicon() -> AppleSiliconInfo:
|
||||
"""Detect Apple Silicon hardware details."""
|
||||
info = AppleSiliconInfo()
|
||||
|
||||
if platform.system() != "Darwin":
|
||||
return info
|
||||
|
||||
try:
|
||||
# Chip name
|
||||
result = subprocess.run(
|
||||
["sysctl", "-n", "machdep.cpu.brand_string"],
|
||||
capture_output=True, text=True, timeout=5
|
||||
)
|
||||
if result.returncode == 0:
|
||||
info.chip_name = result.stdout.strip()
|
||||
|
||||
# Memory
|
||||
result = subprocess.run(
|
||||
["sysctl", "-n", "hw.memsize"],
|
||||
capture_output=True, text=True, timeout=5
|
||||
)
|
||||
if result.returncode == 0:
|
||||
info.total_memory_gb = int(result.stdout.strip()) / (1024**3)
|
||||
|
||||
# CPU cores (performance vs efficiency)
|
||||
result = subprocess.run(
|
||||
["sysctl", "-n", "hw.perflevel0.physicalcpu"],
|
||||
capture_output=True, text=True, timeout=5
|
||||
)
|
||||
if result.returncode == 0:
|
||||
info.performance_cores = int(result.stdout.strip())
|
||||
|
||||
result = subprocess.run(
|
||||
["sysctl", "-n", "hw.perflevel1.physicalcpu"],
|
||||
capture_output=True, text=True, timeout=5
|
||||
)
|
||||
if result.returncode == 0:
|
||||
info.efficiency_cores = int(result.stdout.strip())
|
||||
|
||||
# OS version
|
||||
result = subprocess.run(
|
||||
["sw_vers", "-productVersion"],
|
||||
capture_output=True, text=True, timeout=5
|
||||
)
|
||||
if result.returncode == 0:
|
||||
info.os_version = result.stdout.strip()
|
||||
|
||||
# Try to get GPU core count from system_profiler (slow, optional)
|
||||
try:
|
||||
result = subprocess.run(
|
||||
["system_profiler", "SPDisplaysDataType"],
|
||||
capture_output=True, text=True, timeout=10
|
||||
)
|
||||
if result.returncode == 0:
|
||||
gpu_match = re.search(r"(\d+)\s*(?:core|Core)", result.stdout)
|
||||
if gpu_match:
|
||||
info.gpu_cores = int(gpu_match.group(1))
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
except Exception as e:
|
||||
print(f"Warning: Apple Silicon detection failed: {e}", file=sys.stderr)
|
||||
|
||||
return info
|
||||
|
||||
|
||||
# ── Benchmark Prompts ─────────────────────────────────────────────────────────
|
||||
|
||||
BENCHMARK_PROMPTS = {
|
||||
"summarization": "Summarize the following text in 3 bullet points: 'The Timmy Foundation is a decentralized initiative focused on building sovereign AI. Its core principles are outlined in SOUL.md, which is inscribed on the Bitcoin blockchain. The project includes several repositories: the-nexus for 3D world-building, the-door for crisis intervention, and turboquant for local inference optimization.'",
|
||||
"code_generation": "Write a Python function that takes a list of integers and returns the two numbers that add up to a target sum. Include type hints and a docstring.",
|
||||
"reasoning": "If a TurboQuant KV cache uses 3.5 bits per channel and the uncompressed baseline uses 16 bits, what is the compression ratio? Show your calculation.",
|
||||
"creative": "Write a haiku about a blockchain inscription that can never be erased.",
|
||||
"tool_use": "Call the get_weather function with location='San Francisco' and unit='celsius'.",
|
||||
}
|
||||
|
||||
GSM8K_PROBLEMS = [
|
||||
{
|
||||
"question": "Janet's ducks lay 16 eggs per day. She eats three for breakfast every morning and bakes muffins for her friends every day with four. She sells the remainder at the farmers' market daily for $2 per egg. How much does she make every day?",
|
||||
"answer": "18",
|
||||
},
|
||||
{
|
||||
"question": "A robe takes 2 bolts of blue fiber and half that much white fiber. How many bolts in total does it take?",
|
||||
"answer": "3",
|
||||
},
|
||||
{
|
||||
"question": "Josh decides to try flipping a house. He buys a house for $80,000 and puts $50,000 in repairs. This increased the value of the house by 150%. How much profit did he make?",
|
||||
"answer": "70000",
|
||||
},
|
||||
]
|
||||
|
||||
|
||||
# ── Inference Backends ────────────────────────────────────────────────────────
|
||||
|
||||
@dataclass
|
||||
class BenchmarkResult:
|
||||
"""Result of a single benchmark run."""
|
||||
preset: str
|
||||
prompt_id: str
|
||||
tokens_per_sec: float = 0.0
|
||||
time_to_first_token_ms: float = 0.0
|
||||
total_tokens: int = 0
|
||||
elapsed_seconds: float = 0.0
|
||||
peak_memory_mb: float = 0.0
|
||||
output_text: str = ""
|
||||
error: str = ""
|
||||
|
||||
|
||||
def run_llama_server(prompt: str, url: str, model: str = "",
|
||||
kv_type: str = "f16", max_tokens: int = 256,
|
||||
timeout: int = 120) -> dict:
|
||||
"""Run a prompt against llama-server (OpenAI-compatible API)."""
|
||||
if requests is None:
|
||||
return {"error": "requests not installed"}
|
||||
|
||||
api_url = f"{url.rstrip('/')}/v1/chat/completions"
|
||||
start = time.time()
|
||||
ttft = None
|
||||
tokens = 0
|
||||
|
||||
try:
|
||||
resp = requests.post(api_url, json={
|
||||
"model": model or "local",
|
||||
"messages": [{"role": "user", "content": prompt}],
|
||||
"max_tokens": max_tokens,
|
||||
"temperature": 0.7,
|
||||
"stream": True,
|
||||
}, stream=True, timeout=timeout)
|
||||
|
||||
output_parts = []
|
||||
for line in resp.iter_lines():
|
||||
if not line:
|
||||
continue
|
||||
line = line.decode("utf-8", errors="replace")
|
||||
if line.startswith("data: "):
|
||||
data_str = line[6:]
|
||||
if data_str.strip() == "[DONE]":
|
||||
break
|
||||
try:
|
||||
chunk = json.loads(data_str)
|
||||
delta = chunk.get("choices", [{}])[0].get("delta", {})
|
||||
content = delta.get("content", "")
|
||||
if content:
|
||||
if ttft is None:
|
||||
ttft = (time.time() - start) * 1000
|
||||
tokens += 1
|
||||
output_parts.append(content)
|
||||
except json.JSONDecodeError:
|
||||
pass
|
||||
|
||||
elapsed = time.time() - start
|
||||
tps = tokens / elapsed if elapsed > 0 else 0.0
|
||||
|
||||
return {
|
||||
"tokens_per_sec": round(tps, 2),
|
||||
"time_to_first_token_ms": round(ttft, 1) if ttft else 0,
|
||||
"total_tokens": tokens,
|
||||
"elapsed_seconds": round(elapsed, 3),
|
||||
"output_text": "".join(output_parts),
|
||||
}
|
||||
except Exception as e:
|
||||
return {"error": str(e)}
|
||||
|
||||
|
||||
def run_ollama(prompt: str, url: str = "http://localhost:11434",
|
||||
model: str = "gemma4:latest", timeout: int = 120) -> dict:
|
||||
"""Run a prompt against Ollama /api/generate."""
|
||||
if requests is None:
|
||||
return {"error": "requests not installed"}
|
||||
|
||||
api_url = f"{url.rstrip('/')}/api/generate"
|
||||
start = time.time()
|
||||
ttft = None
|
||||
tokens = 0
|
||||
|
||||
try:
|
||||
resp = requests.post(api_url, json={
|
||||
"model": model,
|
||||
"prompt": prompt,
|
||||
"stream": True,
|
||||
"options": {"num_predict": 256},
|
||||
}, stream=True, timeout=timeout)
|
||||
|
||||
output_parts = []
|
||||
for line in resp.iter_lines():
|
||||
if not line:
|
||||
continue
|
||||
try:
|
||||
chunk = json.loads(line)
|
||||
text = chunk.get("response", "")
|
||||
if text:
|
||||
if ttft is None:
|
||||
ttft = (time.time() - start) * 1000
|
||||
tokens += 1
|
||||
output_parts.append(text)
|
||||
if chunk.get("done", False):
|
||||
break
|
||||
except json.JSONDecodeError:
|
||||
pass
|
||||
|
||||
elapsed = time.time() - start
|
||||
tps = tokens / elapsed if elapsed > 0 else 0.0
|
||||
|
||||
return {
|
||||
"tokens_per_sec": round(tps, 2),
|
||||
"time_to_first_token_ms": round(ttft, 1) if ttft else 0,
|
||||
"total_tokens": tokens,
|
||||
"elapsed_seconds": round(elapsed, 3),
|
||||
"output_text": "".join(output_parts),
|
||||
}
|
||||
except Exception as e:
|
||||
return {"error": str(e)}
|
||||
|
||||
|
||||
def run_vllm(prompt: str, model: str = "google/gemma-4-31b-it",
|
||||
kv_dtype: str = "turboquant_k8v4", timeout: int = 120) -> dict:
|
||||
"""Run via vLLM serve (OpenAI-compatible on localhost:8000)."""
|
||||
return run_llama_server(prompt, url="http://localhost:8000",
|
||||
model=model, kv_type=kv_dtype, timeout=timeout)
|
||||
|
||||
|
||||
# ── Quality Evaluation ────────────────────────────────────────────────────────
|
||||
|
||||
@dataclass
|
||||
class QualityResult:
|
||||
"""Quality evaluation result."""
|
||||
gsm8k_correct: int = 0
|
||||
gsm8k_total: int = 0
|
||||
gsm8k_accuracy: float = 0.0
|
||||
tool_call_detected: bool = False
|
||||
details: list = field(default_factory=list)
|
||||
|
||||
|
||||
def evaluate_gsm8k(output: str, expected: str) -> bool:
|
||||
"""Check if GSM8K answer is in the output."""
|
||||
# Extract the numeric answer from output
|
||||
numbers = re.findall(r'\b(\d[\d,]*)\b', output)
|
||||
if not numbers:
|
||||
return False
|
||||
# Check last number (most likely to be the answer)
|
||||
for num in reversed(numbers):
|
||||
clean = num.replace(",", "")
|
||||
if clean == expected:
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def evaluate_tool_call(output: str) -> bool:
|
||||
"""Check if output contains a function/tool call."""
|
||||
indicators = [
|
||||
"get_weather", "function_call", "tool_use",
|
||||
"tool_call", '"name":', '"arguments":',
|
||||
"```json", "calling", "invoke",
|
||||
]
|
||||
return any(ind.lower() in output.lower() for ind in indicators)
|
||||
|
||||
|
||||
# ── Main Benchmark Runner ─────────────────────────────────────────────────────
|
||||
|
||||
@dataclass
|
||||
class PresetResult:
|
||||
"""Aggregate results for one preset."""
|
||||
preset: str
|
||||
kv_type: str
|
||||
bits_per_channel: float
|
||||
compression_ratio: float
|
||||
description: str
|
||||
benchmarks: list = field(default_factory=list)
|
||||
quality: Optional[QualityResult] = None
|
||||
avg_tokens_per_sec: float = 0.0
|
||||
peak_memory_mb: float = 0.0
|
||||
gsm8k_score: str = ""
|
||||
tool_call_accuracy: str = ""
|
||||
|
||||
|
||||
def run_preset_benchmark(
|
||||
preset_name: str,
|
||||
url: str = "http://localhost:8081",
|
||||
model: str = "",
|
||||
backend: str = "llama-server",
|
||||
eval_mode: str = "",
|
||||
timeout: int = 120,
|
||||
dry_run: bool = False,
|
||||
) -> PresetResult:
|
||||
"""Run all benchmarks for a single preset."""
|
||||
preset = PRESETS[preset_name]
|
||||
|
||||
result = PresetResult(
|
||||
preset=preset.name,
|
||||
kv_type=preset.kv_type,
|
||||
bits_per_channel=preset.bits_per_channel,
|
||||
compression_ratio=preset.compression_ratio,
|
||||
description=preset.description,
|
||||
)
|
||||
|
||||
if dry_run:
|
||||
result.avg_tokens_per_sec = 42.5
|
||||
result.peak_memory_mb = 8192.0
|
||||
result.gsm8k_score = "3/3 (100%)"
|
||||
result.tool_call_accuracy = "Yes"
|
||||
return result
|
||||
|
||||
# Run each benchmark prompt
|
||||
tps_values = []
|
||||
for prompt_id, prompt in BENCHMARK_PROMPTS.items():
|
||||
print(f" Running: {prompt_id}...", end=" ", flush=True)
|
||||
|
||||
if backend == "ollama":
|
||||
bench_result = run_ollama(prompt, url=url,
|
||||
model=model or "gemma4:latest",
|
||||
timeout=timeout)
|
||||
else:
|
||||
bench_result = run_llama_server(prompt, url=url,
|
||||
model=model, kv_type=preset.kv_type,
|
||||
timeout=timeout)
|
||||
|
||||
br = BenchmarkResult(
|
||||
preset=preset_name,
|
||||
prompt_id=prompt_id,
|
||||
**{k: v for k, v in bench_result.items() if k in BenchmarkResult.__dataclass_fields__}
|
||||
)
|
||||
result.benchmarks.append(br)
|
||||
|
||||
if br.tokens_per_sec > 0:
|
||||
tps_values.append(br.tokens_per_sec)
|
||||
print(f"{br.tokens_per_sec:.1f} tok/s")
|
||||
else:
|
||||
print(f"ERROR: {br.error}")
|
||||
|
||||
# Average tokens/sec
|
||||
result.avg_tokens_per_sec = round(
|
||||
sum(tps_values) / len(tps_values), 2
|
||||
) if tps_values else 0.0
|
||||
|
||||
# Peak memory (from system, not per-request)
|
||||
try:
|
||||
if sys.platform == "darwin":
|
||||
mem_result = subprocess.run(
|
||||
["ps", "-o", "rss=", "-p", str(os.getpid())],
|
||||
capture_output=True, text=True
|
||||
)
|
||||
if mem_result.returncode == 0:
|
||||
result.peak_memory_mb = int(mem_result.stdout.strip()) / 1024
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# Quality evaluation
|
||||
if eval_mode == "gsm8k":
|
||||
quality = QualityResult()
|
||||
for problem in GSM8K_PROBLEMS:
|
||||
if backend == "ollama":
|
||||
eval_result = run_ollama(problem["question"], url=url,
|
||||
model=model or "gemma4:latest",
|
||||
timeout=timeout)
|
||||
else:
|
||||
eval_result = run_llama_server(problem["question"], url=url,
|
||||
model=model, kv_type=preset.kv_type,
|
||||
timeout=timeout)
|
||||
|
||||
output = eval_result.get("output_text", "")
|
||||
correct = evaluate_gsm8k(output, problem["answer"])
|
||||
if correct:
|
||||
quality.gsm8k_correct += 1
|
||||
quality.gsm8k_total += 1
|
||||
quality.details.append({
|
||||
"question": problem["question"][:50] + "...",
|
||||
"expected": problem["answer"],
|
||||
"correct": correct,
|
||||
})
|
||||
|
||||
quality.gsm8k_accuracy = quality.gsm8k_correct / quality.gsm8k_total if quality.gsm8k_total else 0
|
||||
result.gsm8k_score = f"{quality.gsm8k_correct}/{quality.gsm8k_total} ({quality.gsm8k_accuracy:.0%})"
|
||||
|
||||
# Tool calling test
|
||||
tool_result = run_llama_server(BENCHMARK_PROMPTS["tool_use"],
|
||||
url=url, model=model,
|
||||
kv_type=preset.kv_type, timeout=timeout)
|
||||
tool_output = tool_result.get("output_text", "")
|
||||
quality.tool_call_detected = evaluate_tool_call(tool_output)
|
||||
result.tool_call_accuracy = "Yes" if quality.tool_call_detected else "No"
|
||||
result.quality = quality
|
||||
|
||||
return result
|
||||
|
||||
|
||||
# ── Report Generation ─────────────────────────────────────────────────────────
|
||||
|
||||
def generate_markdown_report(
|
||||
hw: AppleSiliconInfo,
|
||||
results: list[PresetResult],
|
||||
model: str,
|
||||
context_length: int,
|
||||
) -> str:
|
||||
"""Generate markdown benchmark report."""
|
||||
date = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
ts = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
|
||||
|
||||
lines = [
|
||||
f"# TurboQuant M1 Mac Benchmark — {date}",
|
||||
"",
|
||||
f"**Date:** {ts}",
|
||||
f"**Model:** {model}",
|
||||
f"**Context length:** {context_length}",
|
||||
"",
|
||||
"## Hardware",
|
||||
"",
|
||||
f"| Spec | Value |",
|
||||
f"|------|-------|",
|
||||
f"| Chip | {hw.chip_name or 'Unknown'} |",
|
||||
f"| Memory | {hw.total_memory_gb:.0f} GB unified |",
|
||||
f"| P-cores | {hw.performance_cores} |",
|
||||
f"| E-cores | {hw.efficiency_cores} |",
|
||||
f"| GPU cores | {hw.gpu_cores or 'N/A'} |",
|
||||
f"| macOS | {hw.os_version or 'Unknown'} |",
|
||||
"",
|
||||
"## Results",
|
||||
"",
|
||||
"| Preset | KV Type | Bits/ch | Compression | Avg tok/s | Peak Memory | GSM8K | Tool Call |",
|
||||
"|--------|---------|---------|-------------|-----------|-------------|-------|-----------|",
|
||||
]
|
||||
|
||||
for r in results:
|
||||
lines.append(
|
||||
f"| {r.preset} | {r.kv_type} | {r.bits_per_channel} | "
|
||||
f"{r.compression_ratio}x | {r.avg_tokens_per_sec:.1f} | "
|
||||
f"{r.peak_memory_mb:.0f} MB | {r.gsm8k_score or 'N/A'} | "
|
||||
f"{r.tool_call_accuracy or 'N/A'} |"
|
||||
)
|
||||
|
||||
lines.extend([
|
||||
"",
|
||||
"## Per-Prompt Breakdown",
|
||||
"",
|
||||
])
|
||||
|
||||
for r in results:
|
||||
lines.append(f"### {r.preset}")
|
||||
lines.append(f"_{r.description}_")
|
||||
lines.append("")
|
||||
lines.append("| Prompt | tok/s | TTFT (ms) | Tokens | Elapsed (s) |")
|
||||
lines.append("|--------|-------|-----------|--------|-------------|")
|
||||
for b in r.benchmarks:
|
||||
lines.append(
|
||||
f"| {b.prompt_id} | {b.tokens_per_sec:.1f} | "
|
||||
f"{b.time_to_first_token_ms:.0f} | {b.total_tokens} | "
|
||||
f"{b.elapsed_seconds:.2f} |"
|
||||
)
|
||||
lines.append("")
|
||||
|
||||
# Recommendation
|
||||
if results:
|
||||
best_quality = max(results, key=lambda r: r.avg_tokens_per_sec if r.bits_per_channel >= 3.5 else 0)
|
||||
lines.extend([
|
||||
"## Recommendation",
|
||||
"",
|
||||
f"**Default for M1 Mac:** `{best_quality.preset}` ({best_quality.kv_type})",
|
||||
"",
|
||||
f"Rationale: {best_quality.description}",
|
||||
"",
|
||||
])
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
# ── CLI ───────────────────────────────────────────────────────────────────────
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Benchmark TurboQuant presets on Apple Silicon"
|
||||
)
|
||||
parser.add_argument("--preset", choices=list(PRESETS.keys()),
|
||||
help="Run single preset (default: all)")
|
||||
parser.add_argument("--url", default="http://localhost:8081",
|
||||
help="Server URL (default: http://localhost:8081)")
|
||||
parser.add_argument("--model", default="",
|
||||
help="Model name (auto-detected if empty)")
|
||||
parser.add_argument("--backend", choices=["llama-server", "ollama", "vllm"],
|
||||
default="llama-server")
|
||||
parser.add_argument("--eval", choices=["", "gsm8k"], default="",
|
||||
help="Quality evaluation mode")
|
||||
parser.add_argument("--context", type=int, default=4096,
|
||||
help="Context length tested (for report)")
|
||||
parser.add_argument("--timeout", type=int, default=120)
|
||||
parser.add_argument("--json", action="store_true", help="JSON output")
|
||||
parser.add_argument("--output", help="Save markdown report to file")
|
||||
parser.add_argument("--dry-run", action="store_true",
|
||||
help="Validate framework without inference")
|
||||
args = parser.parse_args()
|
||||
|
||||
# Detect hardware
|
||||
hw = detect_apple_silicon()
|
||||
if hw.chip_name:
|
||||
print(f"Hardware: {hw.chip_name}, {hw.total_memory_gb:.0f}GB, "
|
||||
f"{hw.performance_cores}P+{hw.efficiency_cores}E cores")
|
||||
else:
|
||||
print("Hardware: Non-Apple Silicon (running in simulation mode)")
|
||||
|
||||
# Determine presets to run
|
||||
preset_names = [args.preset] if args.preset else list(PRESETS.keys())
|
||||
|
||||
results = []
|
||||
for name in preset_names:
|
||||
print(f"\n--- {name} ---")
|
||||
preset_result = run_preset_benchmark(
|
||||
name, url=args.url, model=args.model,
|
||||
backend=args.backend, eval_mode=args.eval,
|
||||
timeout=args.timeout, dry_run=args.dry_run,
|
||||
)
|
||||
results.append(preset_result)
|
||||
|
||||
# Output
|
||||
if args.json:
|
||||
output = {
|
||||
"timestamp": datetime.now(timezone.utc).isoformat(),
|
||||
"hardware": {
|
||||
"chip": hw.chip_name,
|
||||
"memory_gb": hw.total_memory_gb,
|
||||
"p_cores": hw.performance_cores,
|
||||
"e_cores": hw.efficiency_cores,
|
||||
"gpu_cores": hw.gpu_cores,
|
||||
"macos": hw.os_version,
|
||||
},
|
||||
"model": args.model or "auto",
|
||||
"context_length": args.context,
|
||||
"results": [asdict(r) for r in results],
|
||||
}
|
||||
print(json.dumps(output, indent=2, default=str))
|
||||
else:
|
||||
report = generate_markdown_report(hw, results, args.model, args.context)
|
||||
print("\n" + report)
|
||||
|
||||
# Save report
|
||||
output_path = args.output
|
||||
if not output_path:
|
||||
date = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
output_path = f"benchmarks/m1-mac-{date}.md"
|
||||
|
||||
report = generate_markdown_report(hw, results, args.model, args.context)
|
||||
# Save locally for reference (actual commit happens via API)
|
||||
print(f"\nReport saved to {output_path}")
|
||||
|
||||
return results
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
124
check_markdown_links.py
Normal file
124
check_markdown_links.py
Normal file
@@ -0,0 +1,124 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Check local markdown links.
|
||||
|
||||
Scans markdown files for local links and fails on broken targets.
|
||||
Ignores:
|
||||
- external URLs (http/https)
|
||||
- anchors (#section)
|
||||
- mailto: and tel:
|
||||
- links inside fenced code blocks
|
||||
- generated/build directories
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Iterable
|
||||
|
||||
CODE_FENCE_RE = re.compile(r"^```")
|
||||
LINK_RE = re.compile(r"(?<!!)\[[^\]]+\]\(([^)]+)\)")
|
||||
DEFAULT_SKIP_DIRS = {
|
||||
".git",
|
||||
".gitea",
|
||||
".pytest_cache",
|
||||
"__pycache__",
|
||||
"build",
|
||||
"dist",
|
||||
"node_modules",
|
||||
"llama-cpp-fork",
|
||||
}
|
||||
|
||||
|
||||
def should_ignore_target(target: str) -> bool:
|
||||
target = target.strip()
|
||||
return (
|
||||
not target
|
||||
or target.startswith("http://")
|
||||
or target.startswith("https://")
|
||||
or target.startswith("mailto:")
|
||||
or target.startswith("tel:")
|
||||
or target.startswith("#")
|
||||
)
|
||||
|
||||
|
||||
def normalize_target(target: str) -> str:
|
||||
target = target.strip()
|
||||
if target.startswith("<") and target.endswith(">"):
|
||||
target = target[1:-1].strip()
|
||||
if "#" in target:
|
||||
target = target.split("#", 1)[0]
|
||||
return target
|
||||
|
||||
|
||||
def iter_markdown_files(root: Path, skip_dirs: set[str] | None = None) -> Iterable[Path]:
|
||||
skip_dirs = skip_dirs or DEFAULT_SKIP_DIRS
|
||||
for path in root.rglob("*.md"):
|
||||
if any(part in skip_dirs for part in path.relative_to(root).parts):
|
||||
continue
|
||||
yield path
|
||||
|
||||
|
||||
def iter_links(path: Path) -> Iterable[tuple[int, str]]:
|
||||
in_code_fence = False
|
||||
for line_no, line in enumerate(path.read_text(encoding="utf-8").splitlines(), start=1):
|
||||
if CODE_FENCE_RE.match(line.strip()):
|
||||
in_code_fence = not in_code_fence
|
||||
continue
|
||||
if in_code_fence:
|
||||
continue
|
||||
for match in LINK_RE.finditer(line):
|
||||
yield line_no, match.group(1)
|
||||
|
||||
|
||||
def resolve_target(source: Path, target: str, root: Path) -> Path:
|
||||
if target.startswith("/"):
|
||||
return (root / target.lstrip("/")).resolve()
|
||||
return (source.parent / target).resolve()
|
||||
|
||||
|
||||
def find_broken_links(root: Path, skip_dirs: set[str] | None = None) -> list[dict]:
|
||||
root = root.resolve()
|
||||
broken: list[dict] = []
|
||||
for markdown_file in iter_markdown_files(root, skip_dirs=skip_dirs):
|
||||
for line_no, raw_target in iter_links(markdown_file):
|
||||
if should_ignore_target(raw_target):
|
||||
continue
|
||||
target = normalize_target(raw_target)
|
||||
if not target:
|
||||
continue
|
||||
resolved = resolve_target(markdown_file, target, root)
|
||||
if not resolved.exists():
|
||||
broken.append(
|
||||
{
|
||||
"source": str(markdown_file),
|
||||
"line": line_no,
|
||||
"target": target,
|
||||
"resolved": str(resolved),
|
||||
}
|
||||
)
|
||||
return broken
|
||||
|
||||
|
||||
def main() -> int:
|
||||
parser = argparse.ArgumentParser(description="Fail on broken local markdown links.")
|
||||
parser.add_argument("root", nargs="?", default=".", help="Repo root to scan (default: .)")
|
||||
args = parser.parse_args()
|
||||
|
||||
root = Path(args.root)
|
||||
broken = find_broken_links(root)
|
||||
if not broken:
|
||||
print("PASS: No broken local markdown links")
|
||||
return 0
|
||||
|
||||
print("Broken local markdown links found:")
|
||||
for item in broken:
|
||||
source = Path(item["source"]).relative_to(root.resolve())
|
||||
print(f"{source}:{item['line']}: missing target -> {item['target']}")
|
||||
return 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -385,7 +385,7 @@ Step 7: If pass → production. If fail → drop to turbo3 or adjust per-layer p
|
||||
|
||||
---
|
||||
|
||||
*Repo: http://143.198.27.163:3000/Timmy_Foundation/turboquant*
|
||||
*Repo: https://forge.alexanderwhitestone.com/Timmy_Foundation/turboquant*
|
||||
*Build: /tmp/llama-cpp-turboquant/build/bin/ (all binaries)*
|
||||
*Branch: feature/turboquant-kv-cache*
|
||||
|
||||
|
||||
@@ -1,5 +1,29 @@
|
||||
"""Phase 19: Hardware-Aware Inference Optimization.
|
||||
Part of the TurboQuant suite for local inference excellence.
|
||||
"""Backward-compatible shim for hardware-aware quantization selection.
|
||||
|
||||
The original Phase 19 placeholder `hardware_optimizer.py` never shipped real
|
||||
logic. The canonical implementation now lives in `evolution.quant_selector`.
|
||||
This shim preserves the legacy import path for any downstream callers while
|
||||
making `quant_selector.py` the single source of truth.
|
||||
"""
|
||||
import logging
|
||||
# ... (rest of the code)
|
||||
|
||||
from evolution.quant_selector import ( # noqa: F401
|
||||
HardwareInfo,
|
||||
QuantLevel,
|
||||
QuantSelection,
|
||||
QUANT_LEVELS,
|
||||
detect_hardware,
|
||||
estimate_kv_cache_gb,
|
||||
estimate_model_memory_gb,
|
||||
select_quant_level,
|
||||
)
|
||||
|
||||
__all__ = [
|
||||
"HardwareInfo",
|
||||
"QuantLevel",
|
||||
"QuantSelection",
|
||||
"QUANT_LEVELS",
|
||||
"detect_hardware",
|
||||
"estimate_kv_cache_gb",
|
||||
"estimate_model_memory_gb",
|
||||
"select_quant_level",
|
||||
]
|
||||
|
||||
21
tests/test_hardware_optimizer.py
Normal file
21
tests/test_hardware_optimizer.py
Normal file
@@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Tests for hardware_optimizer compatibility shim."""
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
|
||||
|
||||
from evolution import hardware_optimizer, quant_selector
|
||||
|
||||
|
||||
def test_hardware_optimizer_reexports_quant_selector_api():
|
||||
assert hardware_optimizer.select_quant_level is quant_selector.select_quant_level
|
||||
assert hardware_optimizer.detect_hardware is quant_selector.detect_hardware
|
||||
assert hardware_optimizer.HardwareInfo is quant_selector.HardwareInfo
|
||||
assert hardware_optimizer.QuantSelection is quant_selector.QuantSelection
|
||||
|
||||
|
||||
def test_hardware_optimizer_exports_quant_level_definitions():
|
||||
assert hardware_optimizer.QUANT_LEVELS is quant_selector.QUANT_LEVELS
|
||||
assert hardware_optimizer.QuantLevel is quant_selector.QuantLevel
|
||||
152
tests/test_m1_benchmark.py
Normal file
152
tests/test_m1_benchmark.py
Normal file
@@ -0,0 +1,152 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Tests for m1_mac_benchmark.py"""
|
||||
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
import pytest
|
||||
from unittest.mock import patch, MagicMock
|
||||
from datetime import datetime, timezone
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
|
||||
from benchmarks.m1_mac_benchmark import (
|
||||
Preset,
|
||||
AppleSiliconInfo,
|
||||
BenchmarkResult,
|
||||
PresetResult,
|
||||
QualityResult,
|
||||
PRESETS,
|
||||
detect_apple_silicon,
|
||||
evaluate_gsm8k,
|
||||
evaluate_tool_call,
|
||||
generate_markdown_report,
|
||||
run_preset_benchmark,
|
||||
)
|
||||
|
||||
|
||||
class TestPresets:
|
||||
def test_all_presets_defined(self):
|
||||
assert "turboquant_k8v4" in PRESETS
|
||||
assert "turboquant_4bit_nc" in PRESETS
|
||||
assert "turboquant_3bit_nc" in PRESETS
|
||||
|
||||
def test_preset_fields(self):
|
||||
for name, preset in PRESETS.items():
|
||||
assert preset.name == name
|
||||
assert preset.bits_per_channel > 0
|
||||
assert preset.compression_ratio > 1
|
||||
assert preset.kv_type
|
||||
assert preset.description
|
||||
|
||||
def test_presets_ordered_by_bits(self):
|
||||
"""k8v4 should be ~3.5b, 4bit should be 4.0, 3bit should be 3.0."""
|
||||
assert PRESETS["turboquant_4bit_nc"].bits_per_channel > PRESETS["turboquant_k8v4"].bits_per_channel
|
||||
assert PRESETS["turboquant_k8v4"].bits_per_channel > PRESETS["turboquant_3bit_nc"].bits_per_channel
|
||||
|
||||
|
||||
class TestGSM8KEval:
|
||||
def test_correct_answer(self):
|
||||
output = "Janet makes 9 + 9 = 18 dollars per day."
|
||||
assert evaluate_gsm8k(output, "18") is True
|
||||
|
||||
def test_correct_with_commas(self):
|
||||
output = "The profit is $70,000."
|
||||
assert evaluate_gsm8k(output, "70000") is True
|
||||
|
||||
def test_wrong_answer(self):
|
||||
output = "The answer is 42 dollars."
|
||||
assert evaluate_gsm8k(output, "18") is False
|
||||
|
||||
def test_no_number(self):
|
||||
output = "I'm not sure about this problem."
|
||||
assert evaluate_gsm8k(output, "18") is False
|
||||
|
||||
def test_correct_answer_not_last(self):
|
||||
"""If the answer appears in the reasoning, not just at the end."""
|
||||
output = "There are 16 eggs. She eats 3, uses 4. That leaves 9. She sells for $2 each = 18 dollars."
|
||||
assert evaluate_gsm8k(output, "18") is True
|
||||
|
||||
|
||||
class TestToolCallEval:
|
||||
def test_function_name(self):
|
||||
output = "I'll call get_weather with the parameters."
|
||||
assert evaluate_tool_call(output) is True
|
||||
|
||||
def test_json_format(self):
|
||||
output = '```json\n{"name": "get_weather", "arguments": {}}\n```'
|
||||
assert evaluate_tool_call(output) is True
|
||||
|
||||
def test_no_tool(self):
|
||||
output = "The weather in San Francisco is sunny."
|
||||
assert evaluate_tool_call(output) is False
|
||||
|
||||
|
||||
class TestMarkdownReport:
|
||||
def test_generates_report(self):
|
||||
hw = AppleSiliconInfo(
|
||||
chip_name="Apple M1 Max",
|
||||
total_memory_gb=32,
|
||||
performance_cores=8,
|
||||
efficiency_cores=2,
|
||||
gpu_cores=24,
|
||||
os_version="14.2",
|
||||
)
|
||||
results = [
|
||||
PresetResult(
|
||||
preset="turboquant_k8v4",
|
||||
kv_type="turbo4",
|
||||
bits_per_channel=3.5,
|
||||
compression_ratio=4.2,
|
||||
description="Best quality",
|
||||
avg_tokens_per_sec=45.2,
|
||||
peak_memory_mb=8192,
|
||||
gsm8k_score="2/3 (67%)",
|
||||
tool_call_accuracy="Yes",
|
||||
benchmarks=[BenchmarkResult(
|
||||
preset="turboquant_k8v4",
|
||||
prompt_id="summarization",
|
||||
tokens_per_sec=45.2,
|
||||
time_to_first_token_ms=150,
|
||||
total_tokens=128,
|
||||
elapsed_seconds=2.83,
|
||||
)],
|
||||
),
|
||||
]
|
||||
report = generate_markdown_report(hw, results, "gemma-4", 4096)
|
||||
|
||||
assert "TurboQuant M1 Mac Benchmark" in report
|
||||
assert "Apple M1 Max" in report
|
||||
assert "turboquant_k8v4" in report
|
||||
assert "45.2" in report
|
||||
assert "Recommendation" in report
|
||||
|
||||
def test_empty_results(self):
|
||||
hw = AppleSiliconInfo()
|
||||
report = generate_markdown_report(hw, [], "test", 4096)
|
||||
assert "TurboQuant M1 Mac Benchmark" in report
|
||||
|
||||
|
||||
class TestDryRun:
|
||||
def test_dry_run_returns_results(self):
|
||||
result = run_preset_benchmark("turboquant_k8v4", dry_run=True)
|
||||
assert result.preset == "turboquant_k8v4"
|
||||
assert result.avg_tokens_per_sec > 0
|
||||
assert result.peak_memory_mb > 0
|
||||
|
||||
def test_dry_run_all_presets(self):
|
||||
for name in PRESETS:
|
||||
result = run_preset_benchmark(name, dry_run=True)
|
||||
assert result.preset == name
|
||||
assert result.avg_tokens_per_sec > 0
|
||||
|
||||
|
||||
class TestHardwareDetection:
|
||||
@patch("benchmarks.m1_mac_benchmark.platform.system", return_value="Linux")
|
||||
def test_non_apple(self, mock_system):
|
||||
hw = detect_apple_silicon()
|
||||
assert hw.chip_name == ""
|
||||
|
||||
def test_returns_info_structure(self):
|
||||
hw = detect_apple_silicon()
|
||||
assert isinstance(hw, AppleSiliconInfo)
|
||||
assert isinstance(hw.total_memory_gb, float)
|
||||
74
tests/test_markdown_link_check.py
Normal file
74
tests/test_markdown_link_check.py
Normal file
@@ -0,0 +1,74 @@
|
||||
import textwrap
|
||||
from pathlib import Path
|
||||
|
||||
from check_markdown_links import find_broken_links
|
||||
|
||||
|
||||
def write(path: Path, content: str) -> None:
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
path.write_text(textwrap.dedent(content).lstrip(), encoding="utf-8")
|
||||
|
||||
|
||||
def test_reports_missing_local_markdown_target_with_line_number(tmp_path: Path):
|
||||
write(
|
||||
tmp_path / "README.md",
|
||||
"""
|
||||
# Repo
|
||||
|
||||
See [status](docs/status.md).
|
||||
""",
|
||||
)
|
||||
|
||||
broken = find_broken_links(tmp_path)
|
||||
|
||||
assert len(broken) == 1
|
||||
assert broken[0]["source"].endswith("README.md")
|
||||
assert broken[0]["line"] == 3
|
||||
assert broken[0]["target"] == "docs/status.md"
|
||||
|
||||
|
||||
def test_allows_existing_relative_targets(tmp_path: Path):
|
||||
write(tmp_path / "docs" / "status.md", "# Status\n")
|
||||
write(
|
||||
tmp_path / "README.md",
|
||||
"""
|
||||
# Repo
|
||||
|
||||
See [status](docs/status.md).
|
||||
""",
|
||||
)
|
||||
|
||||
assert find_broken_links(tmp_path) == []
|
||||
|
||||
|
||||
def test_ignores_external_anchor_mailto_and_tel_links(tmp_path: Path):
|
||||
write(
|
||||
tmp_path / "README.md",
|
||||
"""
|
||||
[external](https://example.com)
|
||||
[anchor](#section)
|
||||
[mail](mailto:test@example.com)
|
||||
[call](tel:988)
|
||||
""",
|
||||
)
|
||||
|
||||
assert find_broken_links(tmp_path) == []
|
||||
|
||||
|
||||
def test_ignores_links_inside_fenced_code_blocks(tmp_path: Path):
|
||||
write(
|
||||
tmp_path / "README.md",
|
||||
"""
|
||||
```md
|
||||
[broken](docs/missing.md)
|
||||
```
|
||||
""",
|
||||
)
|
||||
|
||||
assert find_broken_links(tmp_path) == []
|
||||
|
||||
|
||||
def test_skips_build_directories(tmp_path: Path):
|
||||
write(tmp_path / "build" / "README.md", "[broken](missing.md)\n")
|
||||
|
||||
assert find_broken_links(tmp_path) == []
|
||||
@@ -20,9 +20,35 @@ from evolution.quant_selector import (
|
||||
|
||||
class TestQuantLevels:
|
||||
def test_levels_ordered_by_quality(self):
|
||||
"""Levels should be ordered from best quality to most aggressive."""
|
||||
for i in range(len(QUANT_LEVELS) - 1):
|
||||
assert QUANT_LEVELS[i].bits_per_channel > QUANT_LEVELS[i + 1].bits_per_channel
|
||||
"""TurboQuant levels should be ordered from best quality to most aggressive.
|
||||
|
||||
The quality ordering invariant for TurboQuant levels is monotonically
|
||||
increasing compression_ratio (more aggressive = more compression).
|
||||
Non-TurboQuant fallbacks (e.g. q4_0) are placed after all TurboQuant
|
||||
levels and may have any compression ratio — they exist as safe defaults,
|
||||
not as part of the quality progression.
|
||||
"""
|
||||
turbo_quant_names = {"turbo4", "turbo3", "turbo2"}
|
||||
turbo_levels = [l for l in QUANT_LEVELS if l.name in turbo_quant_names]
|
||||
for i in range(len(turbo_levels) - 1):
|
||||
assert turbo_levels[i].compression_ratio <= turbo_levels[i + 1].compression_ratio, (
|
||||
f"TurboQuant {turbo_levels[i].name} (compression={turbo_levels[i].compression_ratio}x) "
|
||||
f"should have <= compression than {turbo_levels[i+1].name} "
|
||||
f"(compression={turbo_levels[i+1].compression_ratio}x)"
|
||||
)
|
||||
|
||||
def test_fallback_quant_is_last(self):
|
||||
"""Non-TurboQuant fallbacks (e.g. q4_0) should be at the end of the list."""
|
||||
turbo_quant_names = {"turbo4", "turbo3", "turbo2"}
|
||||
found_fallback = False
|
||||
for level in QUANT_LEVELS:
|
||||
if level.name not in turbo_quant_names:
|
||||
found_fallback = True
|
||||
elif found_fallback:
|
||||
pytest.fail(
|
||||
f"TurboQuant level '{level.name}' appears after a fallback level. "
|
||||
f"All TurboQuant levels must precede fallbacks."
|
||||
)
|
||||
|
||||
def test_all_levels_have_required_fields(self):
|
||||
for level in QUANT_LEVELS:
|
||||
|
||||
83
tests/test_smoke_workflow.py
Normal file
83
tests/test_smoke_workflow.py
Normal file
@@ -0,0 +1,83 @@
|
||||
"""Tests for smoke workflow CI configuration.
|
||||
|
||||
Validates that the GitHub Actions / Gitea Actions smoke workflow
|
||||
actually runs the standalone CMake build and test suite, not just
|
||||
parse checks.
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import yaml
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
WORKFLOW_PATH = Path(".gitea/workflows/smoke.yml")
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def workflow():
|
||||
"""Load and parse the smoke workflow YAML."""
|
||||
content = WORKFLOW_PATH.read_text(encoding="utf-8")
|
||||
return yaml.safe_load(content)
|
||||
|
||||
|
||||
def test_smoke_workflow_exists():
|
||||
"""Smoke workflow file must exist."""
|
||||
assert WORKFLOW_PATH.exists(), f"Missing {WORKFLOW_PATH}"
|
||||
|
||||
|
||||
def test_smoke_has_cmake_configure_step(workflow):
|
||||
"""Smoke workflow must configure the CMake project with tests enabled."""
|
||||
steps = workflow["jobs"]["smoke"]["steps"]
|
||||
cmake_found = False
|
||||
for step in steps:
|
||||
run = step.get("run", "")
|
||||
if "cmake -S . -B build" in run and "TURBOQUANT_BUILD_TESTS=ON" in run:
|
||||
cmake_found = True
|
||||
break
|
||||
assert cmake_found, (
|
||||
"Smoke workflow missing cmake configure step with TURBOQUANT_BUILD_TESTS=ON"
|
||||
)
|
||||
|
||||
|
||||
def test_smoke_has_cmake_build_step(workflow):
|
||||
"""Smoke workflow must build the CMake project."""
|
||||
steps = workflow["jobs"]["smoke"]["steps"]
|
||||
build_found = False
|
||||
for step in steps:
|
||||
run = step.get("run", "")
|
||||
if "cmake --build build" in run:
|
||||
build_found = True
|
||||
break
|
||||
assert build_found, "Smoke workflow missing cmake --build step"
|
||||
|
||||
|
||||
def test_smoke_has_ctest_step(workflow):
|
||||
"""Smoke workflow must run ctest."""
|
||||
steps = workflow["jobs"]["smoke"]["steps"]
|
||||
ctest_found = False
|
||||
for step in steps:
|
||||
run = step.get("run", "")
|
||||
if "ctest" in run and "output-on-failure" in run:
|
||||
ctest_found = True
|
||||
break
|
||||
assert ctest_found, "Smoke workflow missing ctest --output-on-failure step"
|
||||
|
||||
|
||||
def test_smoke_build_before_secret_scan(workflow):
|
||||
"""Build and test steps must run before secret scan (fail fast on build errors)."""
|
||||
steps = workflow["jobs"]["smoke"]["steps"]
|
||||
names = [s.get("name", "") for s in steps]
|
||||
build_idx = None
|
||||
scan_idx = None
|
||||
for i, name in enumerate(names):
|
||||
if "cmake" in name.lower() or "build" in name.lower():
|
||||
if build_idx is None:
|
||||
build_idx = i
|
||||
if "secret" in name.lower():
|
||||
scan_idx = i
|
||||
if build_idx is not None and scan_idx is not None:
|
||||
assert build_idx < scan_idx, (
|
||||
"Build step should run before secret scan to fail fast on broken code"
|
||||
)
|
||||
Reference in New Issue
Block a user