Skip to main content

TurboQuant model server manager — auto-configured llama-server with KV cache compression

Project description

tq — TurboQuant Model Server Manager

Auto-configured llama-server with KV cache compression.

Install

# macOS (Apple Silicon) — one-liner
curl -fsSL https://raw.githubusercontent.com/xt8086/tq/main/install.sh | bash

# Windows (x64, NVIDIA GPU) — PowerShell
pip install tq-serve
python -m tq install

# Or via pip on any platform, then run 'tq install' for the binary
pip install tq-serve
tq install

Note: tq-serve is a pure Python package — it does NOT include the llama-server binary. The binary comes from TheTom/llama-cpp-turboquant, a fork of llama.cpp with TurboQuant KV cache compression built in. tq install downloads the correct binary for your platform (macOS Metal, Windows CUDA).

Windows users: If tq is not found after pip install, use python -m tq instead (e.g. python -m tq install, python -m tq chat). This works because python is on PATH by default.

Quick Start

tq doctor                        # Verify setup
tq list                          # List local GGUF models
tq search "qwen2.5 coder 7b"    # Search HuggingFace (numbered, pick # to download)
tq serve 1                       # Launch with auto-configured TurboQuant
tq chat                          # Interactive coding agent

How It Works

tq serve automatically:

  1. Detects your hardware (GPU, RAM)
  2. Parses model metadata (quant type, layers, context length)
  3. Calculates optimal TurboQuant cache settings
  4. Launches llama-server with the right flags

Example: A Q4_K_M model on Apple M1 with 8GB RAM gets:

  • ctk=q8_0 (protect K cache)
  • ctv=turbo4 (compress V cache 3.8x)
  • Context capped to safe memory limit
  • Idle auto-stop after 5 min

Commands

Command Description
tq list List local GGUF models
tq search <query> Search HuggingFace for GGUF models (numbered, with download prompt)
tq download <model> Download a model from HuggingFace
tq remove <model> Remove a downloaded model
tq serve <model> Launch with auto TurboQuant config
tq serve 1 Serve by list number
tq serve 1 --dry-run Show command without running
tq status Check if server is running
tq stop Stop the server
tq logs View server logs
tq validate <model> Pre-flight check
tq install Download TurboQuant+ binary (from TheTom/llama-cpp-turboquant)
tq doctor Verify setup
tq config show Show/edit configuration
tq chat Interactive coding agent (local AI)

API

The server exposes an OpenAI-compatible API:

POST http://127.0.0.1:8080/v1/chat/completions

No auth needed. Works with any OpenAI client:

from openai import OpenAI
client = OpenAI(base_url="http://127.0.0.1:8080/v1", api_key="not-needed")
response = client.chat.completions.create(
    model="your-model.gguf",
    messages=[{"role": "user", "content": "Hello"}]
)

Configuration

Config stored at ~/.tq/config.toml:

tq config show              # Show all settings
tq config set port 9090     # Change port
tq config set idle_timeout 600  # 10 min idle timeout (0 to disable)

TurboQuant Cache Types

Type Bits Compression Use Case
f16 16 1x No compression (baseline)
q8_0 8 2x Safe for K cache
turbo4 4.25 3.8x Best quality/compression for V
turbo3 3.25 4.9x Aggressive, for large models

Requirements

  • Python 3.10+
  • macOS (Apple Silicon), Windows (x64, NVIDIA GPU), or Linux (x86_64 with NVIDIA/AMD GPU)
  • ~2GB free RAM minimum (depends on model)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tq_serve-0.4.17.tar.gz (47.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tq_serve-0.4.17-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file tq_serve-0.4.17.tar.gz.

File metadata

  • Download URL: tq_serve-0.4.17.tar.gz
  • Upload date:
  • Size: 47.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for tq_serve-0.4.17.tar.gz
Algorithm Hash digest
SHA256 2ca337b2ae3a554af8eaa4e201c42e59bee472acca6be98b4e7aed98d525e7ee
MD5 915a8032517211db88a71173247c8bec
BLAKE2b-256 8a02f93cf937077d6dc25e5d461f812c1039702031b82729297d993132dbf299

See more details on using hashes here.

File details

Details for the file tq_serve-0.4.17-py3-none-any.whl.

File metadata

  • Download URL: tq_serve-0.4.17-py3-none-any.whl
  • Upload date:
  • Size: 48.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for tq_serve-0.4.17-py3-none-any.whl
Algorithm Hash digest
SHA256 9ac4312c3090da9cf79496a0375c54720453cf0af5c9ba787312b3bcb604a755
MD5 f8d58f5a2bf4883054daf96a0e8ac5e6
BLAKE2b-256 9656caa2eb8f4b831487e1c8d60bd69666e01542f2b452580a976b1579556e63

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page