Skip to content

heiervang-technologies/ht-llama.cpp

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9,631 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ht-llama.cpp

ht-llama.cpp

Heiervang Technologies fork of llama.cpp

HT Discussions | Fork Management Guide | Upstream: llama.cpp


HT Fork Changes

This is the Heiervang Technologies fork of llama.cpp. The ht branch contains the following changes on top of upstream master.

We do not plan to contribute any of these changes back to upstream llama.cpp, unless the upstream maintainers explicitly ask for a specific change. This fork exists for HT product work — syncs go one way (upstream → masterht). The "Tracked upstream" column below is strictly informational: it points to any pre-existing upstream issue or PR discussing the topic, for the reader's reference, not because we intend to land anything there.

Unlike upstream, we accept contributions from AI agents and assistants. We judge code by its quality, not its authorship — see CONTRIBUTING.md.

Every entry below carries a Why — the reason it exists downstream. That is the bar for staying in the fork: a change we can no longer justify gets dropped at the next upstream sync, not carried out of inertia.

Backend & quantization

Change Description Why Tracked upstream
TurboQuant KV cache New TBQ3_0 / TBQ4_0 quantized KV cache types with rotated-domain attention; CPU backend plus fused CUDA kernels (SET_ROWS, rotation, flash-attention) In-house research direction for sub-4-bit KV at long context on consumer GPUs. Experimental — no fleet deployment uses it yet (--cache-type-* warns); kept on ht so the work stays rebased against live upstream instead of rotting on a side branch. No
DFlash speculative decoding Block-diffusion drafter integration (LLM_ARCH_DFLASH, --spec-type dflash, llama_set_dflash, CUDA kernels for partial-accept feature extraction). Designed against the z-lab DFlash reference for Gemma4 31B targets. Active product bet: diffusion drafting to lift Gemma4 decode throughput on the 3090/P5200 fleet. Upstream has no diffusion-drafter framework to extend. No
Gemma4 MTP speculative Vendored upstream PR #23398 (gemma4-assistant arch + --spec-type draft-mtp) ahead of upstream merge so the gemma-4-12b-qat-mtp preset can ship on titan. Retires when #23398 merges upstream and flows through a normal master sync. Ships a measured 1.66× sampled / 3.02× greedy decode speedup on titan months before upstream review completes. Explicitly temporary. #23398
D=512 FA vec kernels CUDA flash-attention vec-kernel instances for head size 512 with matched quantized KV (q4_0/q8_0), dispatch-gated to gqa_ratio <= 4; deployment-shape (Gemma4 MQA-16) correctness + perf cases in test-backend-ops. Low-GQA D=512 shapes skip the per-step F16 dequant staging (up to 2× per-op). The gate keeps Gemma4's MQA-16 global layers on the faster TILE/MMA path — measured on both sm_61 and sm_86. No
Router-mode robustness llama-server router detects worker crashes via subprocess_alive polling; fixes hardcoded proxy timeout Router mode is the fleet's deployment shape (multi-model boxes); a hung worker must surface as an error, not a stuck request. #22003
Tool-calling resilience Fallback tool-call parser and skip non-function tool types so non-conforming models still work heierchat exposes tools to arbitrary local models; strict parsing turned every malformed call into a hard failure. No
Developer-role remap --remap-developer-role flag merges developer messages into the system prompt for templates that reject duplicates OpenAI-client compatibility: clients that emit developer roles hit template errors on Gemma-family chat templates. No
LCO-Embedding-Omni GGUF Conversion script support for the LCO-Embedding-Omni multi-modal embedding family, including audio tensors routed to the base class in the Qwen2.5 Omni mmproj path. Embedding family used by HT retrieval deployments; conversion support has no upstream owner. No
MLA LoRA conversion convert_lora_to_gguf.py understands MLA (kv_b_proj) so adapters trained on MLA-style attention convert without manual surgery. Needed for adapters trained against DeepSeek-style MLA checkpoints in-house. No
Scheduler split-input cap GGML_SCHED_MAX_SPLIT_INPUTS raised 30 → 256 (CMake cache var) so wide multi-modal graphs no longer trip the scheduler's per-split input limit. LCO-Embedding-Omni graphs exceed the upstream limit; without this the model aborts at load. No

Server

Change Description Why Tracked upstream
heierchat / router integration Downstream router glue and server args (incl. LoRA adapter auto-discovery) for multi-model boxes serving heierchat. The product front-end drives model selection/swapping through the router; these args are its contract. No
Context-checkpoint byte cap --ctx-checkpoints-max-mib (default 4096): per-slot FIFO byte cap on SWA context checkpoints. Unbounded checkpoints OOM-killed titan pods under long-context load (fork issue #67). No
--api-prefix public endpoints Public-endpoint allowlist (/health, /props, …) is checked after stripping the prefix, so prefixed deployments keep unauthenticated health checks. Fleet servers sit behind path-prefix ingress on k8s; probes broke with a prefix set. No
Responses API truncation status Responses API emits status: incomplete + incomplete_details (and the response.incomplete SSE event) when generation stops on a limit. heierchat consumes the Responses API and must distinguish truncation from completion programmatically. No
Logprobs partial-sort get_token_probabilities uses max+sum softmax normalization and std::partial_sort for top-k instead of a full-vocab std::sort per emitted token. O(V log V) → O(V + k log k) per token; measurable at Gemma's 262k vocab with logprobs-consuming clients. No
Fit-params byte plan common_fit_params exposes the per-device byte plan; llama-fit-params --fit-print-plan emits it as JSON (+ smoke tests). The router must predict whether a model fits before spawning a worker (fork issue #66); the plan is the data it needs. No
Router hardening Guarded mapping[] accesses (no silent default-insert), orphaned-result cleanup on batch task removal, portable subprocess exit-code reads. Long-lived router processes accumulated state corruption/leaks from these paths. No
termd tools/termd/ — sandboxed terminal daemon for tool execution. Server-side execution backend for heierchat's sandboxed terminals; not a UI component, so it lives here. No
Log-noise fixes Benign Gemma4-Assistant memory-probe warning downgraded to debug. Deploy logs were dominated by a warning that fires by design once per load. No

WebUI + desktop shell

The web UI, Tauri desktop shell, and Android APK are no longer in this repo — they live at heiervang-technologies/heierchat. Feature list (voice / images / docs / sandbox terminals / artifacts / Nextcloud sync / chat polish / desktop shell) is documented there.

The embedded llama-server web UI is the upstream default — fetched as a prebuilt bundle from the llama-ui HF bucket at build time via LLAMA_USE_PREBUILT_UI=ON (default) and embedded into the binary via the llama-ui static library. heierchat is the product-facing UI and talks to llama-server over its OpenAI-compatible API.

tools/termd/ (sandboxed terminal daemon) stays in this repo — it's a server-side service, not part of the UI.

Scripts & validation

Change Description Why Tracked upstream
DFlash bench & parity suite scripts/dflash/ — deployment-parity prompt suite, bench harness (Q8_0 default, --target flag, CPU-offload env knobs), Round-12 scaffolds. The DFlash acceptance-rate program needs reproducible, deployment-shaped measurements across centurion/titan; ad-hoc benches kept diverging. No
Pascal P5200 build recipe scripts/ — CUDA 12.9 runfile + gcc-14 cross-build recipe and primer for sm_61 boxes. CUDA 13 dropped Pascal; without a documented recipe the crystal/amethyst P5200 boxes silently fall back to Vulkan (≈half the prompt speed). No
Downstream test coverage test-dflash unit tests; TBQ cases in test-quantize-fns/-perf; deployment-shape FA cases in test-backend-ops. Downstream features get the same regression bar as upstream code — these tests have already caught real breakage (hparams-getter refactor, TBQ block-size migration, FA dispatch regressions). No

Build / CI

Change Description Why Tracked upstream
Release CI on ht GitHub Actions release workflow runs on the ht branch, not just on tags. Fleet deploys (titan et al.) pull binaries from ht pushes; waiting for tags would serialize deploys behind releases. No
Workflow trigger strips SYCL and CANN workflows: auto-triggers removed (zero-job upstream workflows), workflow_dispatch kept; schema-valid placeholder job in the SYCL file. Upstream disabled these jobs but kept the triggers — every fork push produced a spurious "failure" run. #23705
Runner re-targeting build-cmake-pkg and flake8 lint moved from upstream's self-hosted runner labels to ubuntu-latest. Upstream's labels target ggml-org's private runner fleet; on this fork those jobs queued forever and CI could never conclude. No
Fork meta Branding, CONTRIBUTING, this inventory, branch-strategy docs. A fork that accepts agent contributions needs its policy and delta written down — this section is that contract. No

Branch Strategy

Branch Purpose
master Clean fast-forward mirror of upstream master — never commit directly
ht HT-specific changes on top of masterdefault branch

Feature branches are created from ht and squash-merged back via PR.

For questions or inquiries, use the HT Discussions page. For details on fork workflow and sync procedures, see the Fork Management Guide.


llama

License: MIT Release Server Docker Winget

Manifesto / ggml / ops

LLM inference in C/C++

Recent API changes

Hot topics


Quick start

Getting started with llama.cpp is straightforward. Here are several ways to install it on your machine:

Once installed, you'll need a model to work with. Head to the Obtaining and quantizing models section to learn more.

Example command:

# Use a local model file
llama-cli -m my_model.gguf

# Or download and run a model directly from Hugging Face
llama-cli -hf ggml-org/gemma-3-1b-it-GGUF

# Launch OpenAI-compatible API server
llama-server -hf ggml-org/gemma-3-1b-it-GGUF

Description

The main goal of llama.cpp is to enable LLM inference with minimal setup and state-of-the-art performance on a wide range of hardware - locally and in the cloud.

  • Plain C/C++ implementation without any dependencies
  • Apple silicon is a first-class citizen - optimized via ARM NEON, Accelerate and Metal frameworks
  • AVX, AVX2, AVX512 and AMX support for x86 architectures
  • RVV, ZVFH, ZFH, ZICBOP and ZIHINTPAUSE support for RISC-V architectures
  • 1.5-bit, 2-bit, 3-bit, 4-bit, 5-bit, 6-bit, and 8-bit integer quantization for faster inference and reduced memory use
  • Custom CUDA kernels for running LLMs on NVIDIA GPUs (support for AMD GPUs via HIP and Moore Threads GPUs via MUSA)
  • Vulkan and SYCL backend support
  • CPU+GPU hybrid inference to partially accelerate models larger than the total VRAM capacity

The llama.cpp project is the main playground for developing new features for the ggml library.

Models

Typically finetunes of the base models below are supported as well.

Instructions for adding support for new models: HOWTO-add-model.md

Text-only

Multimodal

Bindings
UIs

(to have a project listed here, it should clearly state that it depends on llama.cpp)

Tools
  • akx/ggify – download PyTorch models from Hugging Face Hub and convert them to GGML
  • akx/ollama-dl – download models from the Ollama library to be used directly with llama.cpp
  • crashr/gppm – launch llama.cpp instances utilizing NVIDIA Tesla P40 or P100 GPUs with reduced idle power consumption
  • gpustack/gguf-parser - review/check the GGUF file and estimate the memory usage
  • Styled Lines (proprietary licensed, async wrapper of inference part for game development in Unity3d with pre-built Mobile and Web platform wrappers and a model example)
  • unslothai/unsloth – 🦥 exports/saves fine-tuned and trained models to GGUF (Apache-2.0)
Infrastructure
  • Paddler - Open-source LLMOps platform for hosting and scaling AI in your own infrastructure
  • GPUStack - Manage GPU clusters for running LLMs
  • llama_cpp_canister - llama.cpp as a smart contract on the Internet Computer, using WebAssembly
  • llama-swap - transparent proxy that adds automatic model switching with llama-server
  • Kalavai - Crowdsource end to end LLM deployment at any scale
  • llmaz - ☸️ Easy, advanced inference platform for large language models on Kubernetes.
  • LLMKube - Kubernetes operator for llama.cpp with multi-GPU and Apple Silicon Metal support"
Games
  • Lucy's Labyrinth - A simple maze game where agents controlled by an AI model will try to trick you.

Supported backends

Backend Target devices
Metal Apple Silicon
BLAS All
BLIS All
SYCL Intel GPU
OpenVINO [In Progress] Intel CPUs, GPUs, and NPUs
MUSA Moore Threads GPU
CUDA Nvidia GPU
HIP AMD GPU
ZenDNN AMD CPU
Vulkan GPU
CANN Ascend NPU
OpenCL Adreno GPU
IBM zDNN IBM Z & LinuxONE
WebGPU All
RPC All
Hexagon [In Progress] Snapdragon
VirtGPU VirtGPU APIR

Obtaining and quantizing models

The Hugging Face platform hosts a number of LLMs compatible with llama.cpp:

You can either manually download the GGUF file or directly use any llama.cpp-compatible models from Hugging Face or other model hosting sites, by using this CLI argument: -hf <user>/<model>[:quant]. For example:

llama-cli -hf ggml-org/gemma-3-1b-it-GGUF

By default, the CLI would download from Hugging Face, you can switch to other options with the environment variable MODEL_ENDPOINT. The MODEL_ENDPOINT must point to a Hugging Face compatible API endpoint.

After downloading a model, use the CLI tools to run it locally - see below.

llama.cpp requires the model to be stored in the GGUF file format. Models in other data formats can be converted to GGUF using the convert_*.py Python scripts in this repo.

The Hugging Face platform provides a variety of online tools for converting, quantizing and hosting models with llama.cpp:

To learn more about model quantization, read this documentation

A CLI tool for accessing and experimenting with most of llama.cpp's functionality.

  • Run in conversation mode

    Models with a built-in chat template will automatically activate conversation mode. If this doesn't occur, you can manually enable it by adding -cnv and specifying a suitable chat template with --chat-template NAME

    llama-cli -m model.gguf
    
    # > hi, who are you?
    # Hi there! I'm your helpful assistant! I'm an AI-powered chatbot designed to assist and provide information to users like you. I'm here to help answer your questions, provide guidance, and offer support on a wide range of topics. I'm a friendly and knowledgeable AI, and I'm always happy to help with anything you need. What's on your mind, and how can I assist you today?
    #
    # > what is 1+1?
    # Easy peasy! The answer to 1+1 is... 2!
  • Run in conversation mode with custom chat template
    # use the "chatml" template (use -h to see the list of supported templates)
    llama-cli -m model.gguf -cnv --chat-template chatml
    
    # use a custom template
    llama-cli -m model.gguf -cnv --in-prefix 'User: ' --reverse-prompt 'User:'
  • Constrain the output with a custom grammar
    llama-cli -m model.gguf -n 256 --grammar-file grammars/json.gbnf -p 'Request: schedule a call at 8pm; Command:'
    
    # {"appointmentTime": "8pm", "appointmentDetails": "schedule a a call"}

    The grammars/ folder contains a handful of sample grammars. To write your own, check out the GBNF Guide.

    For authoring more complex JSON grammars, check out https://grammar.intrinsiclabs.ai/

A lightweight, OpenAI API compatible, HTTP server for serving LLMs.

  • Start a local HTTP server with default configuration on port 8080
    llama-server -m model.gguf --port 8080
    
    # Basic web UI can be accessed via browser: http://localhost:8080
    # Chat completion endpoint: http://localhost:8080/v1/chat/completions
  • Support multiple-users and parallel decoding
    # up to 4 concurrent requests, each with 4096 max context
    llama-server -m model.gguf -c 16384 -np 4
  • Enable speculative decoding
    # the draft.gguf model should be a small variant of the target model.gguf
    llama-server -m model.gguf -md draft.gguf
  • Serve an embedding model
    # use the /embedding endpoint
    llama-server -m model.gguf --embedding --pooling cls -ub 8192
  • Serve a reranking model
    # use the /reranking endpoint
    llama-server -m model.gguf --reranking
  • Constrain all outputs with a grammar
    # custom grammar
    llama-server -m model.gguf --grammar-file grammar.gbnf
    
    # JSON
    llama-server -m model.gguf --grammar-file grammars/json.gbnf

A tool for measuring the perplexity 1 (and other quality metrics) of a model over a given text.

  • Measure the perplexity over a text file
    llama-perplexity -m model.gguf -f file.txt
    
    # [1]15.2701,[2]5.4007,[3]5.3073,[4]6.2965,[5]5.8940,[6]5.6096,[7]5.7942,[8]4.9297, ...
    # Final estimate: PPL = 5.4007 +/- 0.67339
  • Measure KL divergence
    # TODO

Benchmark the performance of the inference for various parameters.

  • Run default benchmark
    llama-bench -m model.gguf
    
    # Output:
    # | model               |       size |     params | backend    | threads |          test |                  t/s |
    # | ------------------- | ---------: | ---------: | ---------- | ------: | ------------: | -------------------: |
    # | qwen2 1.5B Q4_0     | 885.97 MiB |     1.54 B | Metal,BLAS |      16 |         pp512 |      5765.41 ± 20.55 |
    # | qwen2 1.5B Q4_0     | 885.97 MiB |     1.54 B | Metal,BLAS |      16 |         tg128 |        197.71 ± 0.81 |
    #
    # build: 3e0ba0e60 (4229)

A minimal example for implementing apps with llama.cpp. Useful for developers.

  • Basic text completion
    llama-simple -m model.gguf
    
    # Hello my name is Kaitlyn and I am a 16 year old girl. I am a junior in high school and I am currently taking a class called "The Art of

Contributing

  • Contributors can open PRs
  • Collaborators will be invited based on contributions
  • Maintainers can push to branches in the llama.cpp repo and merge PRs into the master branch
  • Any help with managing issues, PRs and projects is very appreciated!
  • See good first issues for tasks suitable for first contributions
  • Read the CONTRIBUTING.md for more information
  • Make sure to read this: Inference at the edge
  • A bit of backstory for those who are interested: Changelog podcast

Other documentation

Development documentation

Seminal papers and background on the models

If your issue is with model generation quality, then please at least scan the following links and papers to understand the limitations of LLaMA models. This is especially important when choosing an appropriate model size and appreciating both the significant and subtle differences between LLaMA models and ChatGPT:

XCFramework

The XCFramework is a precompiled version of the library for iOS, visionOS, tvOS, and macOS. It can be used in Swift projects without the need to compile the library from source. For example:

// swift-tools-version: 5.10
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "MyLlamaPackage",
    targets: [
        .executableTarget(
            name: "MyLlamaPackage",
            dependencies: [
                "LlamaFramework"
            ]),
        .binaryTarget(
            name: "LlamaFramework",
            url: "https://github.com/ggml-org/llama.cpp/releases/download/b5046/llama-b5046-xcframework.zip",
            checksum: "c19be78b5f00d8d29a25da41042cb7afa094cbf6280a225abe614b03b20029ab"
        )
    ]
)

The above example is using an intermediate build b5046 of the library. This can be modified to use a different version by changing the URL and checksum.

Completions

Command-line completion is available for some environments.

Bash Completion

$ build/bin/llama-cli --completion-bash > ~/.llama-completion.bash
$ source ~/.llama-completion.bash

Optionally this can be added to your .bashrc or .bash_profile to load it automatically. For example:

$ echo "source ~/.llama-completion.bash" >> ~/.bashrc

Dependencies

  • yhirose/cpp-httplib - Single-header HTTP server, used by llama-server - MIT license
  • stb-image - Single-header image format decoder, used by multimodal subsystem - Public domain
  • nlohmann/json - Single-header JSON library, used by various tools/examples - MIT License
  • miniaudio.h - Single-header audio format decoder, used by multimodal subsystem - Public domain
  • subprocess.h - Single-header process launching solution for C and C++ - Public domain

Footnotes

  1. https://huggingface.co/docs/transformers/perplexity

About

LLM inference in C/C++

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • C++ 59.8%
  • C 14.8%
  • Python 8.0%
  • Cuda 6.0%
  • HTML 2.8%
  • Metal 1.6%
  • Other 7.0%