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

# One-liner (macOS / Linux)
curl -fsSL https://raw.githubusercontent.com/xt8086/tq/main/install.sh | bash

# Or via pip (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, Linux CUDA/ROCm).

Quick Start

tq doctor                        # Verify setup
tq list                          # List local GGUF models
tq search "qwen2.5 coder 7b"    # Search HuggingFace (then pick a # 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) 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.16.tar.gz (47.0 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.16-py3-none-any.whl (48.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tq_serve-0.4.16.tar.gz
  • Upload date:
  • Size: 47.0 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.16.tar.gz
Algorithm Hash digest
SHA256 be5a87f59463dd85cb056de61fa59e5675ddda474e24a2fb7071268d73839701
MD5 7fd4301867f0f4ff687a5a32c38cc76c
BLAKE2b-256 1bb11d5e6358891a0e6098fa46a1e76d6b613b0e39060f64688de4e5f32fc806

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tq_serve-0.4.16-py3-none-any.whl
  • Upload date:
  • Size: 48.4 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 145b8fddd61182d8c5c6a6eee08e15fa51d4f9aa43ca5f499d6769e805fc5e6a
MD5 6e8c200a537f64124c27806ba2999fdd
BLAKE2b-256 713413accb0ee65b21b5e766ab5196e4562fe87f223ddaf06580d16620727f8d

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