Skip to content

Docs

Documentation

The docs live with the code on GitHub. Start with the quick start; the levers page lists every switch with its measured number.

Start here

Guides

QUICKSTART

The first fifteen minutes.

docs/QUICKSTART.md

Tutorials

Twelve guides, from a first chat to quantizing your own model.

docs/tutorials/README.md

Launcher and PXA Control

The full reference.

docs/LAUNCHER.md

Defaults

What the engine picks for each card set, and why.

docs/DEFAULTS.md

Cookbook

Per-card command lines for driving it by hand.

docs/COOKBOOK.md

Home Assistant

Your server's numbers as REST or MQTT sensors.

docs/HOME-ASSISTANT.md

Reference

Reference

Levers

The PXA_* switches you might actually use, each with its number.

docs/LEVERS.md

Speculative decoding

MTP, n-gram drafts, presets per context.

docs/speculative.md

Known issues

Problems and workarounds.

docs/KNOWN-ISSUES.md

Quantizing

Classic PXQ tiers and mixed-tier files.

docs/QUANTIZING.md

vLLM sidecar

The optional vLLM path for Pascal and Volta.

docs/VLLM.md

Build from source

Building the engine yourself.

BUILD-FROM-SOURCE.md

Containers

Images and Compose.

docker/COMPOSE.md

Models

The full model list.

MODELS.md

Release notes v3.1

What changed in v3.1.

RELEASE-NOTES-v3.1.md

Release notes v3

What changed in v3.

RELEASE-NOTES-v3.md

Everything else

Links, checked

2026-10-15 15:5x EDT with curl (HTTP status after redirects). The earlier engine repository (poisonxa16/pxq_llama.cpp) is superseded by poisonxa16/pxa.

Link	What	Status
Discord	help in #support, new quants in #models, releases in #announcements	200
Ko-fi	supporter memberships and credits	200
Engine source (GitHub)	public engine repository	200
Engine releases		200
PXA release (v3.1)	tarballs, installer, release notes	200
Container image	ghcr.io/poisonxa16/pxa:v3.1	200
Hugging Face models	PXQ and PXQN files; access is set per model card	200
Live leaderboard	every measured card setup plus community scores	200
Licence server (Store backend)	API endpoint used by PXA Control's Store tab; no web page at the root (404). Buy credits on Ko-fi.	404