Author SHA1 Message Date
owen dbdf0de9b7 Merge pull request 'Inkling + Laguna longhaul support' (#1) from feature/inkling-longhaul into main
Reviewed-on: #1
2026-08-05 15:05:07 -04:00
Owen Qwen ac9907e841 Inkling longhaul support 2026-08-03 20:50:22 -05:00
IrrelevantandGitHub e3b2925150 Revise contribution policy in README
Updated contribution guidelines in README.
2026-07-30 17:49:13 -05:00
IrrelevantandGitHub f6ebb06dc4 Update README.md 2026-07-30 17:47:20 -05:00
37 changed files with 1407 additions and 1919 deletions
+5 -600
View File
@@ -1,604 +1,9 @@
# llama.cpp
# Longhaul.cpp
![llama](https://raw.githubusercontent.com/ggml-org/llama.brand/refs/heads/master/cover/llama-cpp/cover-llama-cpp-dark.svg)
This is a private fork that I decided to make public due to it working better than I expected.
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Release](https://img.shields.io/github/v/release/ggml-org/llama.cpp)](https://github.com/ggml-org/llama.cpp/releases)
[![Server](https://github.com/ggml-org/llama.cpp/actions/workflows/server.yml/badge.svg)](https://github.com/ggml-org/llama.cpp/actions/workflows/server.yml)
[![Docker](https://github.com/ggml-org/llama.cpp/actions/workflows/docker.yml/badge.svg)](https://github.com/ggml-org/llama.cpp/actions/workflows/docker.yml)
[![Winget](https://github.com/ggml-org/llama.cpp/actions/workflows/winget.yml/badge.svg)](https://github.com/ggml-org/llama.cpp/actions/workflows/winget.yml)
Do I recommend you use this for anything important? No. Is it cool? I like to think so.
[Manifesto](https://github.com/ggml-org/llama.cpp/discussions/205) / [ggml](https://github.com/ggml-org/ggml) / [ops](https://github.com/ggml-org/llama.cpp/blob/master/docs/ops.md) / [maintainer PRs](https://github.com/ggml-org/llama.cpp/issues?q=is%3Apr%20is%3Aopen%20draft%3AFalse%20(author%3Argerganov%20OR%20author%3AKitaitiMakoto%20OR%20author%3Adanbev%20OR%20author%3Aaldehir%20OR%20author%3Amax-krasnyansky%20OR%20author%3ACISC%20OR%20author%3Aggerganov%20OR%20author%3Aam17an%20OR%20author%3Abartowski1182%20OR%20author%3Ahipudding%20OR%20author%3AServeurpersoCom%20OR%20author%3Apwilkin%20OR%20author%3Areeselevine%20OR%20author%3Angxson%20OR%20author%3Ajeffbolznv%20OR%20author%3A0cc4m%20OR%20author%3Aangt%20OR%20author%3AIMbackK%20OR%20author%3Aarthw%20OR%20author%3AJohannesGaessler%20OR%20author%3AORippler%20OR%20author%3Aruixiang63%20OR%20author%3Axctan%20OR%20author%3Aallozaur%20OR%20author%3Ayomaytk%20OR%20author%3Aaendk%20OR%20author%3Agaugarg-nv%20OR%20author%3Ataronaeo%20OR%20author%3Aforforever73%20OR%20author%3Alhez%20OR%20author%3Anetrunnereve%20OR%20author%3Afairydreaming)%20sort%3Aupdated-desc)
It only supports Metal at the moment.
LLM inference in C/C++
## Recent API changes
- [Changelog for `libllama` API](https://github.com/ggml-org/llama.cpp/issues/9289)
- [Changelog for `llama-server` REST API](https://github.com/ggml-org/llama.cpp/issues/9291)
## Hot topics
- **Hugging Face cache migration: models downloaded with `-hf` are now stored in the standard Hugging Face cache directory, enabling sharing with other HF tools.**
- **[guide : using the new WebUI of llama.cpp](https://github.com/ggml-org/llama.cpp/discussions/16938)**
- [guide : running gpt-oss with llama.cpp](https://github.com/ggml-org/llama.cpp/discussions/15396)
- [[FEEDBACK] Better packaging for llama.cpp to support downstream consumers 🤗](https://github.com/ggml-org/llama.cpp/discussions/15313)
- Support for the `gpt-oss` model with native MXFP4 format has been added | [PR](https://github.com/ggml-org/llama.cpp/pull/15091) | [Collaboration with NVIDIA](https://blogs.nvidia.com/blog/rtx-ai-garage-openai-oss) | [Comment](https://github.com/ggml-org/llama.cpp/discussions/15095)
- Multimodal support arrived in `llama-server`: [#12898](https://github.com/ggml-org/llama.cpp/pull/12898) | [documentation](./docs/multimodal.md)
- VS Code extension for FIM completions: https://github.com/ggml-org/llama.vscode
- Vim/Neovim plugin for FIM completions: https://github.com/ggml-org/llama.vim
- Hugging Face Inference Endpoints now support GGUF out of the box! https://github.com/ggml-org/llama.cpp/discussions/9669
- Hugging Face GGUF editor: [discussion](https://github.com/ggml-org/llama.cpp/discussions/9268) | [tool](https://huggingface.co/spaces/CISCai/gguf-editor)
- WebGPU support is now available in the browser, see a blog/demo introducing it [here](https://reeselevine.github.io/llamas-on-the-web/).
----
## Quick start
Getting started with llama.cpp is straightforward. Here are several ways to install it on your machine:
- Install `llama.cpp` using [brew, nix, winget, or conda-forge](docs/install.md)
- Run with Docker - see our [Docker documentation](docs/docker.md)
- Download pre-built binaries from the [releases page](https://github.com/ggml-org/llama.cpp/releases)
- Build from source by cloning this repository - check out [our build guide](docs/build.md)
Once installed, you'll need a model to work with. Head to the [Obtaining and quantizing models](#obtaining-and-quantizing-models) section to learn more.
Example command:
```sh
# 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](https://github.com/ggml-org/ggml) library.
<details>
<summary>Models</summary>
Typically finetunes of the base models below are supported as well.
Instructions for adding support for new models: [HOWTO-add-model.md](docs/development/HOWTO-add-model.md)
#### Text-only
- [X] LLaMA 🦙
- [x] LLaMA 2 🦙🦙
- [x] LLaMA 3 🦙🦙🦙
- [X] [Mistral 7B](https://huggingface.co/mistralai/Mistral-7B-v0.1)
- [x] [Mixtral MoE](https://huggingface.co/models?search=mistral-ai/Mixtral)
- [x] [DBRX](https://huggingface.co/databricks/dbrx-instruct)
- [x] [Jamba](https://huggingface.co/ai21labs)
- [X] [Falcon](https://huggingface.co/models?search=tiiuae/falcon)
- [X] [Chinese LLaMA / Alpaca](https://github.com/ymcui/Chinese-LLaMA-Alpaca) and [Chinese LLaMA-2 / Alpaca-2](https://github.com/ymcui/Chinese-LLaMA-Alpaca-2)
- [X] [Vigogne (French)](https://github.com/bofenghuang/vigogne)
- [X] [BERT](https://github.com/ggml-org/llama.cpp/pull/5423)
- [X] [Koala](https://bair.berkeley.edu/blog/2023/04/03/koala/)
- [X] [Baichuan 1 & 2](https://huggingface.co/models?search=baichuan-inc/Baichuan) + [derivations](https://huggingface.co/hiyouga/baichuan-7b-sft)
- [X] [Aquila 1 & 2](https://huggingface.co/models?search=BAAI/Aquila)
- [X] [Starcoder models](https://github.com/ggml-org/llama.cpp/pull/3187)
- [X] [Refact](https://huggingface.co/smallcloudai/Refact-1_6B-fim)
- [X] [MPT](https://github.com/ggml-org/llama.cpp/pull/3417)
- [X] [Bloom](https://github.com/ggml-org/llama.cpp/pull/3553)
- [x] [Yi models](https://huggingface.co/models?search=01-ai/Yi)
- [X] [StableLM models](https://huggingface.co/stabilityai)
- [x] [Deepseek models](https://huggingface.co/models?search=deepseek-ai/deepseek)
- [x] [Qwen models](https://huggingface.co/models?search=Qwen/Qwen)
- [x] [PLaMo-13B](https://github.com/ggml-org/llama.cpp/pull/3557)
- [x] [Phi models](https://huggingface.co/models?search=microsoft/phi)
- [x] [PhiMoE](https://github.com/ggml-org/llama.cpp/pull/11003)
- [x] [GPT-2](https://huggingface.co/gpt2)
- [x] [Orion 14B](https://github.com/ggml-org/llama.cpp/pull/5118)
- [x] [InternLM2](https://huggingface.co/models?search=internlm2)
- [x] [CodeShell](https://github.com/WisdomShell/codeshell)
- [x] [Gemma](https://ai.google.dev/gemma)
- [x] [Mamba](https://github.com/state-spaces/mamba)
- [x] [Grok-1](https://huggingface.co/keyfan/grok-1-hf)
- [x] [Xverse](https://huggingface.co/models?search=xverse)
- [x] [Command-R models](https://huggingface.co/models?search=CohereForAI/c4ai-command-r)
- [x] [SEA-LION](https://huggingface.co/models?search=sea-lion)
- [x] [GritLM-7B](https://huggingface.co/GritLM/GritLM-7B) + [GritLM-8x7B](https://huggingface.co/GritLM/GritLM-8x7B)
- [x] [OLMo](https://allenai.org/olmo)
- [x] [OLMo 2](https://allenai.org/olmo)
- [x] [OLMoE](https://huggingface.co/allenai/OLMoE-1B-7B-0924)
- [x] [Granite models](https://huggingface.co/collections/ibm-granite/granite-code-models-6624c5cec322e4c148c8b330)
- [x] [GPT-NeoX](https://github.com/EleutherAI/gpt-neox) + [Pythia](https://github.com/EleutherAI/pythia)
- [x] [Snowflake-Arctic MoE](https://huggingface.co/collections/Snowflake/arctic-66290090abe542894a5ac520)
- [x] [Smaug](https://huggingface.co/models?search=Smaug)
- [x] [Poro 34B](https://huggingface.co/LumiOpen/Poro-34B)
- [x] [Bitnet b1.58 models](https://huggingface.co/1bitLLM)
- [x] [Flan T5](https://huggingface.co/models?search=flan-t5)
- [x] [Open Elm models](https://huggingface.co/collections/apple/openelm-instruct-models-6619ad295d7ae9f868b759ca)
- [x] [ChatGLM3-6b](https://huggingface.co/THUDM/chatglm3-6b) + [ChatGLM4-9b](https://huggingface.co/THUDM/glm-4-9b) + [GLMEdge-1.5b](https://huggingface.co/THUDM/glm-edge-1.5b-chat) + [GLMEdge-4b](https://huggingface.co/THUDM/glm-edge-4b-chat)
- [x] [GLM-4-0414](https://huggingface.co/collections/THUDM/glm-4-0414-67f3cbcb34dd9d252707cb2e)
- [x] [SmolLM](https://huggingface.co/collections/HuggingFaceTB/smollm-6695016cad7167254ce15966)
- [x] [EXAONE-3.0-7.8B-Instruct](https://huggingface.co/LGAI-EXAONE/EXAONE-3.0-7.8B-Instruct)
- [x] [FalconMamba Models](https://huggingface.co/collections/tiiuae/falconmamba-7b-66b9a580324dd1598b0f6d4a)
- [x] [Jais](https://huggingface.co/inceptionai/jais-13b-chat)
- [x] [Bielik-11B-v2.3](https://huggingface.co/collections/speakleash/bielik-11b-v23-66ee813238d9b526a072408a)
- [x] [RWKV-7](https://huggingface.co/collections/shoumenchougou/rwkv7-gxx-gguf)
- [x] [RWKV-6](https://github.com/BlinkDL/RWKV-LM)
- [x] [QRWKV-6](https://huggingface.co/recursal/QRWKV6-32B-Instruct-Preview-v0.1)
- [x] [GigaChat-20B-A3B](https://huggingface.co/ai-sage/GigaChat-20B-A3B-instruct)
- [X] [Trillion-7B-preview](https://huggingface.co/trillionlabs/Trillion-7B-preview)
- [x] [Ling models](https://huggingface.co/collections/inclusionAI/ling-67c51c85b34a7ea0aba94c32)
- [x] [Liquid LFM2 models](https://huggingface.co/collections/LiquidAI/lfm2)
- [x] [Liquid LFM2.5 models](https://huggingface.co/collections/LiquidAI/lfm25)
- [x] [Liquid Nanos](https://huggingface.co/collections/LiquidAI/liquid-nanos)
- [x] [Hunyuan models](https://huggingface.co/collections/tencent/hunyuan-dense-model-6890632cda26b19119c9c5e7)
- [x] [BailingMoeV2 (Ring/Ling 2.0) models](https://huggingface.co/collections/inclusionAI/ling-v2-68bf1dd2fc34c306c1fa6f86)
- [x] [Mellum models](https://huggingface.co/JetBrains/models?search=mellum)
#### Multimodal
- [x] [LLaVA 1.5 models](https://huggingface.co/collections/liuhaotian/llava-15-653aac15d994e992e2677a7e), [LLaVA 1.6 models](https://huggingface.co/collections/liuhaotian/llava-16-65b9e40155f60fd046a5ccf2)
- [x] [BakLLaVA](https://huggingface.co/models?search=SkunkworksAI/Bakllava)
- [x] [Obsidian](https://huggingface.co/NousResearch/Obsidian-3B-V0.5)
- [x] [ShareGPT4V](https://huggingface.co/models?search=Lin-Chen/ShareGPT4V)
- [x] [MobileVLM 1.7B/3B models](https://huggingface.co/models?search=mobileVLM)
- [x] [Yi-VL](https://huggingface.co/models?search=Yi-VL)
- [x] [Mini CPM](https://huggingface.co/models?search=MiniCPM)
- [x] [Moondream](https://huggingface.co/vikhyatk/moondream2)
- [x] [Bunny](https://github.com/BAAI-DCAI/Bunny)
- [x] [GLM-EDGE](https://huggingface.co/models?search=glm-edge)
- [x] [Qwen2-VL](https://huggingface.co/collections/Qwen/qwen2-vl-66cee7455501d7126940800d)
- [x] [LFM2-VL](https://huggingface.co/collections/LiquidAI/lfm2-vl-68963bbc84a610f7638d5ffa)
</details>
<details>
<summary>Bindings</summary>
- Python: [ddh0/easy-llama](https://github.com/ddh0/easy-llama)
- Python: [abetlen/llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
- Go: [go-skynet/go-llama.cpp](https://github.com/go-skynet/go-llama.cpp)
- Node.js: [withcatai/node-llama-cpp](https://github.com/withcatai/node-llama-cpp)
- JS/TS (llama.cpp server client): [lgrammel/modelfusion](https://modelfusion.dev/integration/model-provider/llamacpp)
- JS/TS (Programmable Prompt Engine CLI): [offline-ai/cli](https://github.com/offline-ai/cli)
- JavaScript/Wasm (works in browser): [tangledgroup/llama-cpp-wasm](https://github.com/tangledgroup/llama-cpp-wasm)
- Typescript/Wasm (nicer API, available on npm): [ngxson/wllama](https://github.com/ngxson/wllama)
- Ruby: [yoshoku/llama_cpp.rb](https://github.com/yoshoku/llama_cpp.rb)
- Ruby: [docusealco/rllama](https://github.com/docusealco/rllama)
- Rust (more features): [edgenai/llama_cpp-rs](https://github.com/edgenai/llama_cpp-rs)
- Rust (nicer API): [mdrokz/rust-llama.cpp](https://github.com/mdrokz/rust-llama.cpp)
- Rust (more direct bindings): [utilityai/llama-cpp-rs](https://github.com/utilityai/llama-cpp-rs)
- Rust (automated build from crates.io): [ShelbyJenkins/llm_client](https://github.com/ShelbyJenkins/llm_client)
- C#/.NET: [SciSharp/LLamaSharp](https://github.com/SciSharp/LLamaSharp)
- C#/VB.NET (more features - community license): [LM-Kit.NET](https://docs.lm-kit.com/lm-kit-net/index.html)
- Scala 3: [donderom/llm4s](https://github.com/donderom/llm4s)
- Clojure: [phronmophobic/llama.clj](https://github.com/phronmophobic/llama.clj)
- React Native: [mybigday/llama.rn](https://github.com/mybigday/llama.rn)
- Java: [kherud/java-llama.cpp](https://github.com/kherud/java-llama.cpp)
- Java: [QuasarByte/llama-cpp-jna](https://github.com/QuasarByte/llama-cpp-jna)
- Zig: [deins/llama.cpp.zig](https://github.com/Deins/llama.cpp.zig)
- Flutter/Dart: [netdur/llama_cpp_dart](https://github.com/netdur/llama_cpp_dart)
- Flutter: [xuegao-tzx/Fllama](https://github.com/xuegao-tzx/Fllama)
- PHP (API bindings and features built on top of llama.cpp): [distantmagic/resonance](https://github.com/distantmagic/resonance) [(more info)](https://github.com/ggml-org/llama.cpp/pull/6326)
- Guile Scheme: [guile_llama_cpp](https://savannah.nongnu.org/projects/guile-llama-cpp)
- Swift [srgtuszy/llama-cpp-swift](https://github.com/srgtuszy/llama-cpp-swift)
- Swift [ShenghaiWang/SwiftLlama](https://github.com/ShenghaiWang/SwiftLlama)
- Delphi [Embarcadero/llama-cpp-delphi](https://github.com/Embarcadero/llama-cpp-delphi)
- Go (no CGo needed): [hybridgroup/yzma](https://github.com/hybridgroup/yzma)
- Android: [llama.android](/examples/llama.android)
</details>
<details>
<summary>UIs</summary>
*(to have a project listed here, it should clearly state that it depends on `llama.cpp`)*
- [AI Sublime Text plugin](https://github.com/yaroslavyaroslav/OpenAI-sublime-text) (MIT)
- [BonzAI App](https://apps.apple.com/us/app/bonzai-your-local-ai-agent/id6752847988) (proprietary)
- [cztomsik/ava](https://github.com/cztomsik/ava) (MIT)
- [Dot](https://github.com/alexpinel/Dot) (GPL)
- [eva](https://github.com/ylsdamxssjxxdd/eva) (MIT)
- [iohub/collama](https://github.com/iohub/coLLaMA) (Apache-2.0)
- [janhq/jan](https://github.com/janhq/jan) (AGPL)
- [johnbean393/Sidekick](https://github.com/johnbean393/Sidekick) (MIT)
- [KanTV](https://github.com/zhouwg/kantv?tab=readme-ov-file) (Apache-2.0)
- [KodiBot](https://github.com/firatkiral/kodibot) (GPL)
- [llama.vim](https://github.com/ggml-org/llama.vim) (MIT)
- [LARS](https://github.com/abgulati/LARS) (AGPL)
- [Llama Assistant](https://github.com/vietanhdev/llama-assistant) (GPL)
- [LlamaLib](https://github.com/undreamai/LlamaLib) (Apache-2.0)
- [LLMFarm](https://github.com/guinmoon/LLMFarm?tab=readme-ov-file) (MIT)
- [LLMUnity](https://github.com/undreamai/LLMUnity) (MIT)
- [LMStudio](https://lmstudio.ai/) (proprietary)
- [LocalAI](https://github.com/mudler/LocalAI) (MIT)
- [LostRuins/koboldcpp](https://github.com/LostRuins/koboldcpp) (AGPL)
- [MindMac](https://mindmac.app) (proprietary)
- [MindWorkAI/AI-Studio](https://github.com/MindWorkAI/AI-Studio) (FSL-1.1-MIT)
- [Mobile-Artificial-Intelligence/maid](https://github.com/Mobile-Artificial-Intelligence/maid) (MIT)
- [Mozilla-Ocho/llamafile](https://github.com/Mozilla-Ocho/llamafile) (Apache-2.0)
- [nat/openplayground](https://github.com/nat/openplayground) (MIT)
- [nomic-ai/gpt4all](https://github.com/nomic-ai/gpt4all) (MIT)
- [ollama/ollama](https://github.com/ollama/ollama) (MIT)
- [oobabooga/text-generation-webui](https://github.com/oobabooga/text-generation-webui) (AGPL)
- [PocketPal AI](https://github.com/a-ghorbani/pocketpal-ai) (MIT)
- [psugihara/FreeChat](https://github.com/psugihara/FreeChat) (MIT)
- [ptsochantaris/emeltal](https://github.com/ptsochantaris/emeltal) (MIT)
- [pythops/tenere](https://github.com/pythops/tenere) (AGPL)
- [ramalama](https://github.com/containers/ramalama) (MIT)
- [semperai/amica](https://github.com/semperai/amica) (MIT)
- [withcatai/catai](https://github.com/withcatai/catai) (MIT)
- [Autopen](https://github.com/blackhole89/autopen) (GPL)
</details>
<details>
<summary>Tools</summary>
- [akx/ggify](https://github.com/akx/ggify) – download PyTorch models from Hugging Face Hub and convert them to GGML
- [akx/ollama-dl](https://github.com/akx/ollama-dl) – download models from the Ollama library to be used directly with llama.cpp
- [crashr/gppm](https://github.com/crashr/gppm) – launch llama.cpp instances utilizing NVIDIA Tesla P40 or P100 GPUs with reduced idle power consumption
- [gpustack/gguf-parser](https://github.com/gpustack/gguf-parser-go/tree/main/cmd/gguf-parser) - review/check the GGUF file and estimate the memory usage
- [Styled Lines](https://marketplace.unity.com/packages/tools/generative-ai/styled-lines-llama-cpp-model-292902) (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](https://github.com/unslothai/unsloth) – 🦥 exports/saves fine-tuned and trained models to GGUF (Apache-2.0)
</details>
<details>
<summary>Infrastructure</summary>
- [Paddler](https://github.com/intentee/paddler) - Open-source LLMOps platform for hosting and scaling AI in your own infrastructure
- [GPUStack](https://github.com/gpustack/gpustack) - Manage GPU clusters for running LLMs
- [llama_cpp_canister](https://github.com/onicai/llama_cpp_canister) - llama.cpp as a smart contract on the Internet Computer, using WebAssembly
- [llama-swap](https://github.com/mostlygeek/llama-swap) - transparent proxy that adds automatic model switching with llama-server
- [Kalavai](https://github.com/kalavai-net/kalavai-client) - Crowdsource end to end LLM deployment at any scale
- [llmaz](https://github.com/InftyAI/llmaz) - ☸️ Easy, advanced inference platform for large language models on Kubernetes.
- [LLMKube](https://github.com/defilantech/llmkube) - Kubernetes operator for llama.cpp with multi-GPU and Apple Silicon Metal
support"
</details>
<details>
<summary>Games</summary>
- [Lucy's Labyrinth](https://github.com/MorganRO8/Lucys_Labyrinth) - A simple maze game where agents controlled by an AI model will try to trick you.
</details>
## Supported backends
| Backend | Target devices |
| --- | --- |
| [Metal](docs/build.md#metal-build) | Apple Silicon |
| [BLAS](docs/build.md#blas-build) | All |
| [BLIS](docs/backend/BLIS.md) | All |
| [SYCL](docs/backend/SYCL.md) | Intel GPU |
| [OpenVINO [In Progress]](docs/backend/OPENVINO.md) | Intel CPUs, GPUs, and NPUs |
| [MUSA](docs/build.md#musa) | Moore Threads GPU |
| [CUDA](docs/build.md#cuda) | Nvidia GPU |
| [HIP](docs/build.md#hip) | AMD GPU |
| [ZenDNN](docs/build.md#zendnn) | AMD CPU |
| [Vulkan](docs/build.md#vulkan) | GPU |
| [CANN](docs/build.md#cann) | Ascend NPU |
| [OpenCL](docs/backend/OPENCL.md) | Adreno GPU |
| [IBM zDNN](docs/backend/zDNN.md) | IBM Z & LinuxONE |
| [WebGPU](docs/build.md#webgpu) | All |
| [RPC](https://github.com/ggml-org/llama.cpp/tree/master/tools/rpc) | All |
| [Hexagon [In Progress]](docs/backend/snapdragon/README.md) | Snapdragon |
| [VirtGPU](docs/backend/VirtGPU.md) | VirtGPU APIR |
## Obtaining and quantizing models
The [Hugging Face](https://huggingface.co) platform hosts a [number of LLMs](https://huggingface.co/models?library=gguf&sort=trending) compatible with `llama.cpp`:
- [Trending](https://huggingface.co/models?library=gguf&sort=trending)
- [LLaMA](https://huggingface.co/models?sort=trending&search=llama+gguf)
You can either manually download the GGUF file or directly use any `llama.cpp`-compatible models from [Hugging Face](https://huggingface.co/) or other model hosting sites, by using this CLI argument: `-hf <user>/<model>[:quant]`. For example:
```sh
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](https://github.com/ggml-org/ggml/blob/master/docs/gguf.md) 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`:
- Use the [GGUF-my-repo space](https://huggingface.co/spaces/ggml-org/gguf-my-repo) to convert to GGUF format and quantize model weights to smaller sizes
- Use the [GGUF-my-LoRA space](https://huggingface.co/spaces/ggml-org/gguf-my-lora) to convert LoRA adapters to GGUF format (more info: https://github.com/ggml-org/llama.cpp/discussions/10123)
- Use the [GGUF-editor space](https://huggingface.co/spaces/CISCai/gguf-editor) to edit GGUF meta data in the browser (more info: https://github.com/ggml-org/llama.cpp/discussions/9268)
- Use the [Inference Endpoints](https://ui.endpoints.huggingface.co/) to directly host `llama.cpp` in the cloud (more info: https://github.com/ggml-org/llama.cpp/discussions/9669)
To learn more about model quantization, [read this documentation](tools/quantize/README.md)
## [`llama-cli`](tools/cli)
#### A CLI tool for accessing and experimenting with most of `llama.cpp`'s functionality.
- <details open>
<summary>Run in conversation mode</summary>
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`
```bash
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!
```
</details>
- <details>
<summary>Run in conversation mode with custom chat template</summary>
```bash
# 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:'
```
</details>
- <details>
<summary>Constrain the output with a custom grammar</summary>
```bash
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/](grammars/) folder contains a handful of sample grammars. To write your own, check out the [GBNF Guide](grammars/README.md).
For authoring more complex JSON grammars, check out https://grammar.intrinsiclabs.ai/
</details>
## [`llama-server`](tools/server)
#### A lightweight, [OpenAI API](https://github.com/openai/openai-openapi) compatible, HTTP server for serving LLMs.
- <details open>
<summary>Start a local HTTP server with default configuration on port 8080</summary>
```bash
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
```
</details>
- <details>
<summary>Support multiple-users and parallel decoding</summary>
```bash
# up to 4 concurrent requests, each with 4096 max context
llama-server -m model.gguf -c 16384 -np 4
```
</details>
- <details>
<summary>Enable speculative decoding</summary>
```bash
# the draft.gguf model should be a small variant of the target model.gguf
llama-server -m model.gguf -md draft.gguf
```
</details>
- <details>
<summary>Serve an embedding model</summary>
```bash
# use the /embedding endpoint
llama-server -m model.gguf --embedding --pooling cls -ub 8192
```
</details>
- <details>
<summary>Serve a reranking model</summary>
```bash
# use the /reranking endpoint
llama-server -m model.gguf --reranking
```
</details>
- <details>
<summary>Constrain all outputs with a grammar</summary>
```bash
# custom grammar
llama-server -m model.gguf --grammar-file grammar.gbnf
# JSON
llama-server -m model.gguf --grammar-file grammars/json.gbnf
```
</details>
## [`llama-perplexity`](tools/perplexity)
#### A tool for measuring the [perplexity](tools/perplexity/README.md) [^1] (and other quality metrics) of a model over a given text.
- <details open>
<summary>Measure the perplexity over a text file</summary>
```bash
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
```
</details>
- <details>
<summary>Measure KL divergence</summary>
```bash
# TODO
```
</details>
[^1]: [https://huggingface.co/docs/transformers/perplexity](https://huggingface.co/docs/transformers/perplexity)
## [`llama-bench`](tools/llama-bench)
#### Benchmark the performance of the inference for various parameters.
- <details open>
<summary>Run default benchmark</summary>
```bash
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)
```
</details>
## [`llama-simple`](examples/simple)
#### A minimal example for implementing apps with `llama.cpp`. Useful for developers.
- <details>
<summary>Basic text completion</summary>
```bash
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
```
</details>
## 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](https://github.com/ggml-org/llama.cpp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for tasks suitable for first contributions
- Read the [CONTRIBUTING.md](CONTRIBUTING.md) for more information
- Make sure to read this: [Inference at the edge](https://github.com/ggml-org/llama.cpp/discussions/205)
- A bit of backstory for those who are interested: [Changelog podcast](https://changelog.com/podcast/532)
## Other documentation
- [cli](tools/cli/README.md)
- [completion](tools/completion/README.md)
- [server](tools/server/README.md)
- [GBNF grammars](grammars/README.md)
#### Development documentation
- [How to build](docs/build.md)
- [Running on Docker](docs/docker.md)
- [Build on Android](docs/android.md)
- [Multi-GPU usage](docs/multi-gpu.md)
- [Performance troubleshooting](docs/development/token_generation_performance_tips.md)
- [GGML tips & tricks](https://github.com/ggml-org/llama.cpp/wiki/GGML-Tips-&-Tricks)
#### 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:
- LLaMA:
- [Introducing LLaMA: A foundational, 65-billion-parameter large language model](https://ai.facebook.com/blog/large-language-model-llama-meta-ai/)
- [LLaMA: Open and Efficient Foundation Language Models](https://arxiv.org/abs/2302.13971)
- GPT-3
- [Language Models are Few-Shot Learners](https://arxiv.org/abs/2005.14165)
- GPT-3.5 / InstructGPT / ChatGPT:
- [Aligning language models to follow instructions](https://openai.com/research/instruction-following)
- [Training language models to follow instructions with human feedback](https://arxiv.org/abs/2203.02155)
## 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
// 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
```bash
$ 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:
```console
$ echo "source ~/.llama-completion.bash" >> ~/.bashrc
```
## Dependencies
- [yhirose/cpp-httplib](https://github.com/yhirose/cpp-httplib) - Single-header HTTP server, used by `llama-server` - MIT license
- [stb-image](https://github.com/nothings/stb) - Single-header image format decoder, used by multimodal subsystem - Public domain
- [nlohmann/json](https://github.com/nlohmann/json) - Single-header JSON library, used by various tools/examples - MIT License
- [miniaudio.h](https://github.com/mackron/miniaudio) - Single-header audio format decoder, used by multimodal subsystem - Public domain
- [subprocess.h](https://github.com/sheredom/subprocess.h) - Single-header process launching solution for C and C++ - Public domain
This is a personal project and because of this I have disabled open PRs. If you want to contribute, you can open an issue.
+1 -1
View File
@@ -2631,7 +2631,7 @@ common_params_context common_params_parser_init(common_params & params, llama_ex
).set_env("LLAMA_ARG_LOAD_MODE"));
add_opt(common_arg(
{"--longhaul"},
"stream routed Qwen3.5 MoE experts through a bounded Metal cache",
"stream routed Qwen3.5 MoE, Laguna, or Inkling experts through a bounded CPU or Metal cache",
[](common_params & params) {
params.load_mode = LLAMA_LOAD_MODE_LONGHAUL;
}
+119
View File
@@ -2530,6 +2530,118 @@ static common_chat_params common_chat_params_init_minimax_m3(const common_chat_t
return data;
}
// Inkling's TML format can emit multiple typed content blocks in one turn.
// <|end_message|> closes a block while content_model_end_sampling closes the
// generation, so the generic single-block parser is not sufficient.
static common_chat_params common_chat_params_init_inkling(
const common_chat_template & tmpl,
const autoparser::generation_params & inputs) {
common_chat_params data;
const std::string MSG_MODEL = "<|message_model|>";
const std::string MSG_USER = "<|message_user|>";
const std::string MSG_SYSTEM = "<|message_system|>";
const std::string MSG_TOOL = "<|message_tool|>";
const std::string THINK = "<|content_thinking|>";
const std::string TEXT = "<|content_text|>";
const std::string END_MESSAGE = "<|end_message|>";
const std::string END_SAMPLING = "<|content_model_end_sampling|>";
const std::string INVOKE_TOOL = "<|content_invoke_tool_json|>";
data.prompt = common_chat_template_direct_apply_impl(tmpl, inputs);
data.generation_prompt = common_chat_template_generation_prompt_impl(tmpl, inputs);
data.format = COMMON_CHAT_FORMAT_PEG_NATIVE;
data.supports_thinking = true;
data.thinking_start_tag = THINK;
data.thinking_end_tags = {END_MESSAGE};
data.preserved_tokens = {
MSG_MODEL, MSG_USER, MSG_SYSTEM, MSG_TOOL,
THINK, TEXT, END_MESSAGE, END_SAMPLING, INVOKE_TOOL,
};
data.message_delimiters = {
{ COMMON_CHAT_ROLE_ASSISTANT, MSG_MODEL },
{ COMMON_CHAT_ROLE_USER, MSG_USER },
{ COMMON_CHAT_ROLE_SYSTEM, MSG_SYSTEM },
{ COMMON_CHAT_ROLE_TOOL, MSG_TOOL },
};
const bool has_tools = inputs.tools.is_array() && !inputs.tools.empty();
const bool extract_reasoning =
inputs.reasoning_format != COMMON_REASONING_FORMAT_NONE;
if (inputs.has_continuation()) {
const auto & msg = inputs.continue_msg;
data.generation_prompt = MSG_MODEL + THINK + msg.reasoning_content;
if (inputs.continue_final_message == COMMON_CHAT_CONTINUATION_CONTENT) {
data.generation_prompt += END_MESSAGE + TEXT + msg.render_content();
}
data.prompt += data.generation_prompt;
}
auto parser = build_chat_peg_parser([&](common_chat_peg_builder & p) {
auto generation_prompt = p.literal(MSG_MODEL);
auto end = p.end();
common_peg_parser reasoning_block = p.eps();
if (extract_reasoning) {
reasoning_block =
p.literal(THINK) +
p.reasoning(p.until_one_of({ END_MESSAGE, TEXT, END_SAMPLING })) +
p.optional(p.literal(END_MESSAGE));
} else {
reasoning_block = p.content(
p.literal(THINK) +
p.until_one_of({ END_MESSAGE, TEXT, END_SAMPLING }) +
p.optional(p.literal(END_MESSAGE)));
}
auto reasoning = p.optional(reasoning_block);
auto text_block =
p.optional(p.literal(MSG_MODEL)) +
p.optional(p.literal(TEXT)) +
p.content(p.until_one_of({ THINK, END_MESSAGE, END_SAMPLING })) +
p.optional(p.literal(END_MESSAGE));
auto text_content =
p.one_or_more(p.choice({ reasoning_block, text_block }));
if (!has_tools || inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_NONE) {
return generation_prompt + reasoning + text_content +
p.optional(p.literal(END_SAMPLING)) + end;
}
auto tool_section = p.standard_json_tools(
INVOKE_TOOL, END_MESSAGE, inputs.tools,
/* parallel_tool_calls = */ false,
/* force_tool_calls = */ true,
/* name_key = */ "name",
/* args_key = */ "args",
/* array_wrapped = */ false,
/* function_is_key = */ false,
/* call_id_key = */ "",
/* gen_call_id_key = */ "",
/* parameters_order = */ {},
/* accept_openai_wrapper = */ false);
auto tool_block =
p.optional(p.literal(MSG_MODEL)) +
p.until_one_of({ INVOKE_TOOL, TEXT, THINK, END_MESSAGE, END_SAMPLING }) +
tool_section;
auto tool_calls = inputs.parallel_tool_calls
? p.one_or_more(tool_block)
: tool_block;
auto mixed_body =
p.one_or_more(p.choice({ tool_block, reasoning_block, text_block }));
auto body = inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_REQUIRED
? tool_calls
: mixed_body;
return generation_prompt + reasoning + body +
p.optional(p.literal(END_SAMPLING)) + end;
});
data.parser = parser.save();
return data;
}
namespace workaround {
static void map_developer_role_to_system(json & messages) {
@@ -2947,6 +3059,13 @@ std::optional<common_chat_params> common_chat_try_specialized_template(
return common_chat_params_init_cohere2moe(tmpl, params);
}
if (src.find("<|content_thinking|>") != std::string::npos &&
src.find("<|content_text|>") != std::string::npos &&
src.find("<|message_model|>") != std::string::npos) {
LOG_DBG("Using specialized template: Inkling\n");
return common_chat_params_init_inkling(tmpl, params);
}
if (is_lfm2_template(src)) {
LOG_DBG("Using specialized template: LFM2\n");
return common_chat_params_init_lfm2(tmpl, params, /* tool_list_tokens = */ true);
+55 -44
View File
@@ -11,45 +11,16 @@ llama-cli \
--model /path/to/model.gguf \
--longhaul \
--longhaul-cache 2 \
--n-gpu-layers 99
--n-gpu-layers 0
```
`--longhaul-cache` is the expert cache budget in GiB. It is required when `--longhaul` is used. The same options are accepted by `llama-server`.
## RPC mode
RPC longhaul keeps the paging loop on the accelerator host so expert payloads do
not cross the network during generation. Build both hosts with `-DGGML_RPC=ON`.
Place the same GGUF shard files on both hosts, preserving their basenames, then
start the Metal host with the directory containing those shards:
```sh
ggml-rpc-server \
--device MTL0 \
--longhaul-root /path/to/model-directory \
--host 192.168.1.20
```
Start the client normally:
```sh
llama-server \
--model /local/path/model.gguf \
--rpc 192.168.1.20:50052 \
--longhaul \
--longhaul-cache 2 \
--n-gpu-layers 99
```
RPC longhaul currently requires all repeating layers on one remote Metal device.
The server validates each shard basename, size, GGUF metadata layout digest, and
every registered expert range before decoding. An older server, a server without
`--longhaul-root`, or a shard mismatch is a fatal model-load error; the client
does not fall back to sending expert slices over RPC.
`--longhaul-root` grants connected RPC clients read access to registered byte
ranges in files in that directory. The RPC server remains experimental and
insecure and must not be exposed to an untrusted network.
The command above runs every repeating layer on CPU and is supported on macOS,
Linux, and Windows. On macOS, the existing all-Metal mode remains available by
using `--n-gpu-layers 99` instead. Longhaul does not silently change device
placement: an unsupported GPU or mixed CPU/GPU repeating-layer placement fails
with guidance to use `--n-gpu-layers 0`.
Longhaul may reduce `--ubatch-size` so that every expert selected by one graph segment can be present in the cache at the same time. The effective value is logged during context creation. If one token selects more experts than the cache has slots, the routed MoE computation is split into multiple stages and the partial results are summed. This permits smaller caches at the cost of additional graph work.
@@ -59,23 +30,63 @@ The normal startup warmup is skipped automatically in longhaul mode. Routed expe
Longhaul currently requires:
- the Metal backend, either local on macOS or on one RPC host
- Qwen3.5 MoE or Laguna architecture
- all repeating model layers assigned to local Metal or one RPC Metal device
- all repeating layers on CPU, or all repeating layers on Metal
- Qwen3.5 MoE, Laguna, or Inkling architecture
- text generation without embeddings or LoRA adapters
Longhaul does not restrict the GGUF quantization type. Individual tensor types must still be supported by Metal.
CPU mode is available wherever the CPU backend is supported. Metal mode requires
macOS. Longhaul does not restrict the GGUF quantization type; individual tensor
types must still be supported by the selected compute backend.
MTP/speculative decoding, tensor validation during loading, vocabulary-only loading, and CPU or mixed CPU/Metal layer placement are not supported. Both single-file and split GGUF models are supported; routed expert tensors are read from the shard that owns each tensor.
MTP/speculative decoding, tensor validation during loading, vocabulary-only
loading, and mixed CPU/GPU repeating-layer placement are not supported. Both
single-file and split GGUF models are supported; routed expert tensors are read
from the shard that owns each tensor.
The cache budget covers the compact routed-expert tensors. It does not include dense weights, attention weights, the KV cache, graph allocations, or the temporary buffer used for one expert read. Disk reads bypass the macOS unified file cache where supported, avoiding a second long-lived copy of streamed weights in system RAM.
The cache budget covers the compact routed-expert tensors. It does not include
dense weights, attention weights, the KV cache, graph allocations, or temporary
staging buffers. CPU expert caches use the standard directly writable tensor
layout so individual slots can be replaced; optimized CPU buffer selection
continues to apply to all non-streamed weights.
File-cache control is best effort and is outside the explicit cache budget.
macOS disables caching for streamed files where supported, and Linux advises the
kernel to discard completed reads. Windows may retain file data in its system
cache. Windows reads from one GGUF shard are serialized to preserve positional
read correctness, while POSIX systems retain concurrent `pread` operations.
This implementation synchronizes at each routed MoE layer to discover the selected experts, populate missing cache slots, and continue execution with cache-local expert IDs. Storage speed and expert reuse therefore have a large effect on generation speed.
Expert IDs are planned as a batch at each synchronization point. Experts already
needed by that batch are protected from eviction, duplicate IDs are loaded only
once, and independent expert slices are read concurrently on shared-memory Metal
devices. Private Metal buffers use a staged fallback.
once, and independent expert slices are read concurrently where the platform
supports positional reads. CPU and shared Metal buffers are populated directly;
private Metal buffers use a staged fallback.
Inkling keeps its two shared experts resident and streams only the routed
256-expert banks. Inkling-Small selects six routed experts per token. In the
seven-shard Q8_0 model, one cache slot across all 40 MoE layers uses about
0.996 GiB, so a 6 GiB cache provides six slots and executes each MoE layer in
one stage. The non-routed tensors, including both shared experts, require about
6.02 GiB in addition to the expert cache:
```sh
llama-cli \
--model /path/to/Inkling-Small-Q8_0-00001-of-00007.gguf \
--longhaul \
--longhaul-cache 6 \
--n-gpu-layers 99 \
--flash-attn off \
--jinja
```
Budgets from 1 through 5 GiB are supported by splitting the six selected
experts into multiple stages. Add `--n-gpu-layers 0` to run entirely on CPU.
Inkling currently forces flash attention off because its relative-position
bias is evaluated by the unfused attention path. This support covers text and
tool-call generation from the language-model GGUF; multimodal projection files
are not loaded by longhaul. Use `--jinja` with `llama-cli`, `llama-completion`,
or `llama-server` so the model's embedded TML chat template is accepted.
## Benchmarking prompt processing
@@ -86,7 +97,7 @@ llama-bench \
--model /path/to/model.gguf \
--load-mode longhaul \
--longhaul-cache 2 \
--n-gpu-layers 99 \
--n-gpu-layers 0 \
--n-prompt 2048 \
--n-gen 0
```
+1 -44
View File
@@ -8,7 +8,7 @@ extern "C" {
#define RPC_PROTO_MAJOR_VERSION 4
#define RPC_PROTO_MINOR_VERSION 0
#define RPC_PROTO_PATCH_VERSION 4
#define RPC_PROTO_PATCH_VERSION 3
#ifdef __cplusplus
static_assert(GGML_OP_COUNT == 101, "GGML_OP_COUNT has changed - update RPC_PROTO_PATCH_VERSION");
@@ -27,49 +27,6 @@ GGML_BACKEND_API void ggml_backend_rpc_get_device_memory(const char * endpoint,
GGML_BACKEND_API void ggml_backend_rpc_start_server(const char * endpoint, const char * cache_dir,
size_t n_threads, size_t n_devices, ggml_backend_dev_t * devices);
struct ggml_backend_rpc_longhaul_shard {
const char * name;
uint64_t size;
uint64_t metadata_size;
uint8_t metadata_sha256[32];
};
struct ggml_backend_rpc_longhaul_source {
struct ggml_tensor * tensor;
uint32_t shard;
uint64_t offset;
uint64_t expert_size;
int32_t layer;
};
struct ggml_backend_rpc_longhaul_params {
uint32_t n_layers;
uint32_t n_experts;
uint32_t n_slots;
size_t n_shards;
const struct ggml_backend_rpc_longhaul_shard * shards;
size_t n_sources;
const struct ggml_backend_rpc_longhaul_source * sources;
};
GGML_BACKEND_API bool ggml_backend_rpc_longhaul_register(
const struct ggml_backend_rpc_longhaul_params * params,
uint64_t * registration_id,
char * error,
size_t error_size);
GGML_BACKEND_API void ggml_backend_rpc_longhaul_unregister(
struct ggml_tensor * tensor,
uint64_t registration_id);
GGML_BACKEND_API void ggml_backend_rpc_start_server_with_options(
const char * endpoint,
const char * cache_dir,
const char * longhaul_root,
size_t n_threads,
size_t n_devices,
ggml_backend_dev_t * devices);
GGML_BACKEND_API ggml_backend_reg_t ggml_backend_rpc_reg(void);
GGML_BACKEND_API ggml_backend_reg_t ggml_backend_rpc_add_server(const char * endpoint);
File diff suppressed because it is too large Load Diff
+32
View File
@@ -144,6 +144,7 @@ static const std::map<llm_arch, const char *> LLM_ARCH_NAMES = {
{ LLM_ARCH_TALKIE, "talkie" },
{ LLM_ARCH_MELLUM, "mellum" },
{ LLM_ARCH_NANBEIGE, "nanbeige" },
{ LLM_ARCH_INKLING, "inkling" },
{ LLM_ARCH_UNKNOWN, "(unknown)" },
};
@@ -320,6 +321,15 @@ static const std::map<llm_kv, const char *> LLM_KV_NAMES = {
{ LLM_KV_NORM_BEFORE_FC, "%s.norm_before_fc" },
{ LLM_KV_SHORTCONV_L_CACHE, "%s.shortconv.l_cache" },
{ LLM_KV_INKLING_D_REL, "%s.d_rel" },
{ LLM_KV_INKLING_REL_EXTENT, "%s.rel_extent" },
{ LLM_KV_INKLING_REL_EXTENT_SWA, "%s.rel_extent_swa" },
{ LLM_KV_INKLING_SHORTCONV_KERNEL, "%s.shortconv_kernel" },
{ LLM_KV_INKLING_DENSE_BLOCK_COUNT, "%s.dense_block_count" },
{ LLM_KV_INKLING_LOGIT_SCALE_DENOM, "%s.logit_scale_denom" },
{ LLM_KV_INKLING_LOG_SCALING_N_FLOOR, "%s.log_scaling_n_floor" },
{ LLM_KV_INKLING_LOG_SCALING_ALPHA, "%s.log_scaling_alpha" },
{ LLM_KV_INKLING_UNPADDED_VOCAB_SIZE, "%s.unpadded_vocab_size" },
// sentence-transformers dense modules feature dims
{ LLM_KV_DENSE_2_FEAT_IN, "%s.dense_2_feat_in" },
{ LLM_KV_DENSE_2_FEAT_OUT, "%s.dense_2_feat_out" },
@@ -592,9 +602,19 @@ static const std::map<llm_tensor, const char *> LLM_TENSOR_NAMES = {
{ LLM_TENSOR_SHORTCONV_CONV, "blk.%d.shortconv.conv" },
{ LLM_TENSOR_SHORTCONV_INPROJ, "blk.%d.shortconv.in_proj" },
{ LLM_TENSOR_SHORTCONV_OUTPROJ, "blk.%d.shortconv.out_proj" },
{ LLM_TENSOR_ATTN_R, "blk.%d.attn_r" },
{ LLM_TENSOR_ATTN_REL_PROJ, "blk.%d.attn_rel_proj" },
{ LLM_TENSOR_SHORTCONV_K, "blk.%d.shortconv_k" },
{ LLM_TENSOR_SHORTCONV_V, "blk.%d.shortconv_v" },
{ LLM_TENSOR_SHORTCONV_ATTN, "blk.%d.shortconv_attn" },
{ LLM_TENSOR_SHORTCONV_MLP, "blk.%d.shortconv_mlp" },
{ LLM_TENSOR_FFN_GSCALE, "blk.%d.ffn_gscale" },
{ LLM_TENSOR_FFN_GATE_CHEXPS, "blk.%d.ffn_gate_chexps" },
{ LLM_TENSOR_FFN_DOWN_CHEXPS, "blk.%d.ffn_down_chexps" },
{ LLM_TENSOR_FFN_UP_CHEXPS, "blk.%d.ffn_up_chexps" },
{ LLM_TENSOR_FFN_GATE_SHEXPS, "blk.%d.ffn_gate_shexp" },
{ LLM_TENSOR_FFN_DOWN_SHEXPS, "blk.%d.ffn_down_shexp" },
{ LLM_TENSOR_FFN_UP_SHEXPS, "blk.%d.ffn_up_shexp" },
{ LLM_TENSOR_VISEXP_ATTN_QKV, "blk.%d.vis_attn_qkv" },
{ LLM_TENSOR_VISEXP_ATTN_OUT, "blk.%d.vis_attn_output" },
{ LLM_TENSOR_VISEXP_FFN_GATE, "blk.%d.vis_gate" },
@@ -795,6 +815,9 @@ static const std::map<llm_tensor, llm_tensor_info> LLM_TENSOR_INFOS = {
{LLM_TENSOR_FFN_UP_EXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_GATE_UP_EXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_DOWN_CHEXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_DOWN_SHEXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_GATE_SHEXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_UP_SHEXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_GATE_CHEXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_UP_CHEXPS, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT_ID}},
{LLM_TENSOR_FFN_EXP_PROBS_B, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_ADD}},
@@ -836,6 +859,13 @@ static const std::map<llm_tensor, llm_tensor_info> LLM_TENSOR_INFOS = {
{LLM_TENSOR_SHORTCONV_CONV, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_SSM_CONV}},
{LLM_TENSOR_SHORTCONV_INPROJ, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
{LLM_TENSOR_SHORTCONV_OUTPROJ, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
{LLM_TENSOR_ATTN_R, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
{LLM_TENSOR_ATTN_REL_PROJ, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
{LLM_TENSOR_SHORTCONV_K, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_SSM_CONV}},
{LLM_TENSOR_SHORTCONV_V, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_SSM_CONV}},
{LLM_TENSOR_SHORTCONV_ATTN, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_SSM_CONV}},
{LLM_TENSOR_SHORTCONV_MLP, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_SSM_CONV}},
{LLM_TENSOR_FFN_GSCALE, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL}},
{LLM_TENSOR_VISEXP_ATTN_QKV, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
{LLM_TENSOR_VISEXP_ATTN_OUT, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
{LLM_TENSOR_VISEXP_FFN_GATE, {LLM_TENSOR_LAYER_REPEATING, GGML_OP_MUL_MAT}},
@@ -968,6 +998,7 @@ bool llm_arch_is_hybrid(const llm_arch & arch) {
case LLM_ARCH_KIMI_LINEAR:
case LLM_ARCH_QWEN35:
case LLM_ARCH_QWEN35MOE:
case LLM_ARCH_INKLING:
return true;
default:
return false;
@@ -1024,6 +1055,7 @@ bool llm_arch_supports_sm_tensor(const llm_arch & arch) {
case LLM_ARCH_MINIMAX_M3:
case LLM_ARCH_MISTRAL4:
case LLM_ARCH_KIMI_LINEAR:
case LLM_ARCH_INKLING:
return false;
default:
return true;
+20
View File
@@ -149,6 +149,7 @@ enum llm_arch {
LLM_ARCH_MINIMAX_M3,
LLM_ARCH_DFLASH,
LLM_ARCH_NANBEIGE,
LLM_ARCH_INKLING,
LLM_ARCH_UNKNOWN,
};
@@ -366,6 +367,15 @@ enum llm_kv {
LLM_KV_NORM_BEFORE_FC,
LLM_KV_SHORTCONV_L_CACHE,
LLM_KV_INKLING_D_REL,
LLM_KV_INKLING_REL_EXTENT,
LLM_KV_INKLING_REL_EXTENT_SWA,
LLM_KV_INKLING_SHORTCONV_KERNEL,
LLM_KV_INKLING_DENSE_BLOCK_COUNT,
LLM_KV_INKLING_LOGIT_SCALE_DENOM,
LLM_KV_INKLING_LOG_SCALING_N_FLOOR,
LLM_KV_INKLING_LOG_SCALING_ALPHA,
LLM_KV_INKLING_UNPADDED_VOCAB_SIZE,
LLM_KV_XIELU_ALPHA_N,
LLM_KV_XIELU_ALPHA_P,
@@ -434,6 +444,9 @@ enum llm_tensor {
LLM_TENSOR_FFN_DOWN_CHEXPS,
LLM_TENSOR_FFN_GATE_CHEXPS,
LLM_TENSOR_FFN_UP_CHEXPS,
LLM_TENSOR_FFN_DOWN_SHEXPS,
LLM_TENSOR_FFN_GATE_SHEXPS,
LLM_TENSOR_FFN_UP_SHEXPS,
LLM_TENSOR_FFN_EXP_PROBS_B,
LLM_TENSOR_FFN_LATENT_DOWN,
LLM_TENSOR_FFN_LATENT_UP,
@@ -595,6 +608,13 @@ enum llm_tensor {
LLM_TENSOR_SHORTCONV_CONV,
LLM_TENSOR_SHORTCONV_INPROJ,
LLM_TENSOR_SHORTCONV_OUTPROJ,
LLM_TENSOR_ATTN_R,
LLM_TENSOR_ATTN_REL_PROJ,
LLM_TENSOR_SHORTCONV_K,
LLM_TENSOR_SHORTCONV_V,
LLM_TENSOR_SHORTCONV_ATTN,
LLM_TENSOR_SHORTCONV_MLP,
LLM_TENSOR_FFN_GSCALE,
LLM_TENSOR_VISEXP_ATTN_QKV,
LLM_TENSOR_VISEXP_ATTN_OUT,
LLM_TENSOR_VISEXP_FFN_GATE,
+7 -7
View File
@@ -1359,12 +1359,10 @@ llm_graph_result * llama_context::process_ubatch(const llama_ubatch & ubatch, ll
res->reset();
ggml_backend_sched_reset(sched.get());
auto * longhaul = model.longhaul_cache();
const bool local_longhaul = longhaul && !longhaul->is_remote();
ggml_backend_sched_set_eval_callback(
sched.get(),
local_longhaul ? longhaul_eval_callback : cparams.cb_eval,
local_longhaul ? this : cparams.cb_eval_user_data);
model.longhaul_cache() ? longhaul_eval_callback : cparams.cb_eval,
model.longhaul_cache() ? this : cparams.cb_eval_user_data);
//const auto t_start_us = ggml_time_us();
@@ -2463,7 +2461,7 @@ llm_graph_params llama_context::graph_params(
bool llama_context::longhaul_eval_callback(ggml_tensor * tensor, bool ask, void * user_data) {
auto * ctx = static_cast<llama_context *>(user_data);
auto * cache = ctx->model.longhaul_cache();
GGML_ASSERT(cache != nullptr && !cache->is_remote());
GGML_ASSERT(cache != nullptr);
int layer = -1;
const bool remap = sscanf(tensor->name, "longhaul.remap.%d", &layer) == 1;
@@ -3588,8 +3586,10 @@ llama_context * llama_init_from_model(
return nullptr;
}
if (params.flash_attn_type != LLAMA_FLASH_ATTN_TYPE_DISABLED && model->arch == LLM_ARCH_GROK) {
LLAMA_LOG_WARN("%s: flash_attn is not compatible with Grok - forcing off\n", __func__);
if (params.flash_attn_type != LLAMA_FLASH_ATTN_TYPE_DISABLED &&
(model->arch == LLM_ARCH_GROK || model->arch == LLM_ARCH_INKLING)) {
LLAMA_LOG_WARN("%s: flash_attn is not compatible with %s - forcing off\n",
__func__, model->arch == LLM_ARCH_GROK ? "Grok" : "Inkling");
params.flash_attn_type = LLAMA_FLASH_ATTN_TYPE_DISABLED;
}
+113
View File
@@ -1765,6 +1765,119 @@ ggml_tensor * llm_graph_context::build_ffn(
return cur;
}
ggml_tensor * llm_graph_context::build_moe_experts(
ggml_tensor * cur,
ggml_tensor * selected_experts,
ggml_tensor * weights,
ggml_tensor * up_exps,
ggml_tensor * gate_exps,
ggml_tensor * down_exps,
int64_t n_expert_used,
llm_ffn_op_type type_op,
int il) const {
GGML_ASSERT(cur != nullptr);
GGML_ASSERT(selected_experts != nullptr);
GGML_ASSERT(weights != nullptr);
GGML_ASSERT(up_exps != nullptr && down_exps != nullptr);
const int64_t n_embd = cur->ne[0];
const int64_t n_tokens = cur->ne[1];
// Ensure routing and weights are available before a longhaul cache
// callback resolves and loads the first expert chunk.
ggml_build_forward_expand(gf, weights);
ggml_tensor * moe_inp = ggml_reshape_3d(ctx0, cur, n_embd, 1, n_tokens);
const int64_t chunk_size = longhaul
? std::min<int64_t>(n_expert_used, longhaul->capacity())
: n_expert_used;
GGML_ASSERT(chunk_size > 0);
ggml_tensor * moe_out = nullptr;
int chunk = 0;
for (int64_t first = 0; first < n_expert_used; first += chunk_size, ++chunk) {
const int64_t count = std::min<int64_t>(chunk_size, n_expert_used - first);
ggml_tensor * selected_chunk = selected_experts;
ggml_tensor * weights_chunk = weights;
if (count != n_expert_used) {
selected_chunk = ggml_view_2d(
ctx0, selected_experts, count, n_tokens,
selected_experts->nb[1], first*selected_experts->nb[0]);
weights_chunk = ggml_view_3d(
ctx0, weights, 1, count, n_tokens,
weights->nb[1], weights->nb[2], first*weights->nb[1]);
}
ggml_tensor * selected_moe = selected_chunk;
if (longhaul) {
selected_moe = ggml_dup(ctx0, selected_chunk);
ggml_format_name(selected_moe, "longhaul.remap.%d.%d", il, chunk);
ggml_build_forward_expand(gf, selected_moe);
}
ggml_tensor * up = build_lora_mm_id(up_exps, moe_inp, selected_moe);
ggml_tensor * act = gate_exps
? build_lora_mm_id(gate_exps, moe_inp, selected_moe)
: up;
switch (type_op) {
case LLM_FFN_SILU:
act = gate_exps
? ggml_swiglu_split(ctx0, act, up)
: ggml_silu(ctx0, act);
break;
case LLM_FFN_GELU:
act = gate_exps
? ggml_geglu_split(ctx0, act, up)
: ggml_gelu(ctx0, act);
break;
case LLM_FFN_RELU:
act = gate_exps
? ggml_reglu_split(ctx0, act, up)
: ggml_relu(ctx0, act);
break;
default:
GGML_ABORT("unsupported routed expert activation");
}
ggml_tensor * experts = build_lora_mm_id(
down_exps, act, selected_moe);
experts = ggml_mul(ctx0, experts, weights_chunk);
ggml_build_forward_expand(gf, experts);
ggml_tensor * chunk_out = nullptr;
for (int64_t i = 0; i < count; ++i) {
ggml_tensor * expert = ggml_view_2d(
ctx0, experts, n_embd, n_tokens,
experts->nb[2], i*experts->nb[1]);
ggml_build_forward_expand(gf, expert);
chunk_out = chunk_out ? ggml_add(ctx0, chunk_out, expert) : expert;
ggml_build_forward_expand(gf, chunk_out);
}
if (count == 1) {
chunk_out = ggml_cont(ctx0, chunk_out);
}
ggml_tensor * contribution = chunk_out;
if (longhaul) {
ggml_tensor * release = ggml_cont(ctx0, chunk_out);
ggml_format_name(release, "longhaul.release.%d.%d", il, chunk);
ggml_build_forward_expand(gf, release);
if (chunk_size < n_expert_used) {
contribution = release;
}
}
moe_out = moe_out ? ggml_add(ctx0, moe_out, contribution) : contribution;
ggml_build_forward_expand(gf, moe_out);
}
cb(moe_out, "ffn_moe_out", il);
return moe_out;
}
ggml_tensor * llm_graph_context::build_moe_ffn(
ggml_tensor * cur,
ggml_tensor * gate_inp,
+14
View File
@@ -1000,6 +1000,20 @@ struct llm_graph_context {
llm_ffn_gate_type type_gate,
int il) const;
// Execute experts for an architecture that supplies its own selected IDs
// and weights. In longhaul mode this transparently stages those experts
// through the bounded cache.
ggml_tensor * build_moe_experts(
ggml_tensor * cur,
ggml_tensor * selected_experts,
ggml_tensor * weights,
ggml_tensor * up_exps,
ggml_tensor * gate_exps,
ggml_tensor * down_exps,
int64_t n_expert_used,
llm_ffn_op_type type_op,
int il) const;
// build MoE FFN without bias tensors
ggml_tensor * build_moe_ffn(
ggml_tensor * cur,
+4
View File
@@ -191,6 +191,10 @@ uint32_t llama_hparams::n_embd_k_idx(uint32_t il) const {
}
uint32_t llama_hparams::n_embd_r() const {
if (n_embd_r_impl != 0) {
return n_embd_r_impl;
}
if (wkv_head_size != 0) {
// for RWKV models
return token_shift_count * n_embd;
+12
View File
@@ -80,6 +80,18 @@ struct llama_hparams {
uint32_t n_shortconv_l_cache = 0;
// Explicit recurrent-state size override. Inkling packs four independent
// short-convolution histories into the recurrent cache for every layer.
uint32_t n_embd_r_impl = 0;
// Inkling relative-attention and output metadata.
uint32_t inkling_d_rel = 0;
uint32_t inkling_rel_extent = 0;
uint32_t inkling_rel_extent_swa = 0;
uint32_t inkling_log_n_floor = 0;
float inkling_log_alpha = 0.0f;
uint32_t inkling_unpadded_n_vocab = 0;
std::array<uint32_t, LLAMA_MAX_LAYERS> n_head_arr;
std::array<uint32_t, LLAMA_MAX_LAYERS> n_head_kv_arr;
std::array<uint32_t, LLAMA_MAX_LAYERS> n_ff_arr;
+38
View File
@@ -1931,6 +1931,37 @@ void llama_kv_cache::set_input_pos_bucket(ggml_tensor * dst, const llama_ubatch
}
}
void llama_kv_cache::set_input_pos_rel_flat(
ggml_tensor * dst,
const llama_ubatch * ubatch,
uint32_t extent) const {
GGML_ASSERT(ggml_backend_buffer_is_host(dst->buffer));
GGML_ASSERT(dst->ne[1] == (int64_t) ubatch->n_tokens);
int32_t * data = (int32_t *) dst->data;
const int64_t n_kv = dst->ne[0];
// Each query owns an extent+1-row block in the flattened relative-logit
// table. The final row is the zero-bias sentinel for empty/out-of-band KV
// cells.
for (int64_t i = 0; i < (int64_t) ubatch->n_tokens; ++i) {
const llama_seq_id seq_id = ubatch->seq_id[i][0];
const auto & cells = v_cells[seq_to_stream[seq_id]];
const llama_pos p1 = ubatch->pos[i];
for (int64_t j = 0; j < n_kv; ++j) {
int32_t rel = (int32_t) extent;
if (!cells.is_empty(j)) {
const llama_pos d = p1 - cells.pos_get(j);
if (d >= 0 && d < (llama_pos) extent) {
rel = (int32_t) d;
}
}
data[i*n_kv + j] = (int32_t) (i*(extent + 1)) + rel;
}
}
}
void llama_kv_cache::set_input_k_rot(ggml_tensor * dst) const {
GGML_ASSERT(ggml_backend_buffer_is_host(dst->buffer));
@@ -2896,6 +2927,13 @@ void llama_kv_cache_context::set_input_pos_bucket(ggml_tensor * dst, const llama
kv->set_input_pos_bucket(dst, ubatch);
}
void llama_kv_cache_context::set_input_pos_rel_flat(
ggml_tensor * dst,
const llama_ubatch * ubatch,
uint32_t extent) const {
kv->set_input_pos_rel_flat(dst, ubatch, extent);
}
void llama_kv_cache_context::set_input_k_rot(ggml_tensor * dst) const {
kv->set_input_k_rot(dst);
}
+4
View File
@@ -215,6 +215,8 @@ public:
void set_input_kq_mask (ggml_tensor * dst, const llama_ubatch * ubatch, bool causal_attn) const;
void set_input_pos_bucket(ggml_tensor * dst, const llama_ubatch * ubatch) const;
void set_input_pos_rel_flat(
ggml_tensor * dst, const llama_ubatch * ubatch, uint32_t extent) const;
void set_input_k_rot(ggml_tensor * dst) const;
void set_input_v_rot(ggml_tensor * dst) const;
@@ -405,6 +407,8 @@ public:
void set_input_k_shift (ggml_tensor * dst) const;
void set_input_kq_mask (ggml_tensor * dst, const llama_ubatch * ubatch, bool causal_attn) const;
void set_input_pos_bucket(ggml_tensor * dst, const llama_ubatch * ubatch) const;
void set_input_pos_rel_flat(
ggml_tensor * dst, const llama_ubatch * ubatch, uint32_t extent) const;
void set_input_k_rot(ggml_tensor * dst) const;
void set_input_v_rot(ggml_tensor * dst) const;
+2 -102
View File
@@ -1,108 +1,23 @@
#include "llama-longhaul.h"
#include "llama-impl.h"
#include "llama-token-cache.h"
#include "ggml-rpc.h"
#include <algorithm>
#include <array>
#include <cstring>
#include <inttypes.h>
#include <stdexcept>
llama_longhaul_cache::llama_longhaul_cache(
llama_files files,
std::vector<llama_model_loader::longhaul_source> sources,
std::vector<llama_model_loader::longhaul_shard> shards,
size_t n_slots,
uint32_t n_experts,
uint32_t n_layers,
bool remote) :
uint32_t n_layers) :
files(std::move(files)),
sources(std::move(sources)),
shards(std::move(shards)),
sources_by_layer(n_layers),
layers(n_layers),
n_slots(n_slots),
n_experts(n_experts),
remote(remote) {
if (remote) {
if (this->shards.size() != this->files.size() || this->sources.empty()) {
throw std::runtime_error("RPC longhaul requires named GGUF shards");
}
std::vector<std::array<uint8_t, 32>> digests(this->shards.size());
std::vector<ggml_backend_rpc_longhaul_shard> rpc_shards(this->shards.size());
for (size_t i = 0; i < this->shards.size(); ++i) {
const auto & shard = this->shards[i];
if (shard.metadata_size > shard.size) {
throw std::runtime_error("invalid RPC longhaul shard metadata range");
}
std::vector<uint8_t> metadata(shard.metadata_size);
if (!metadata.empty()) {
this->files[i]->read_at(metadata.data(), metadata.size(), 0);
}
const std::string hex = llama_token_cache_hash(metadata.data(), metadata.size());
if (hex.size() != 64) {
throw std::runtime_error("failed to fingerprint RPC longhaul shard");
}
for (size_t j = 0; j < digests[i].size(); ++j) {
auto nibble = [](char c) -> uint8_t {
if (c >= '0' && c <= '9') return c - '0';
if (c >= 'a' && c <= 'f') return c - 'a' + 10;
if (c >= 'A' && c <= 'F') return c - 'A' + 10;
return 0xff;
};
const uint8_t hi = nibble(hex[2*j]);
const uint8_t lo = nibble(hex[2*j + 1]);
if (hi > 0x0f || lo > 0x0f) {
throw std::runtime_error("invalid RPC longhaul shard fingerprint");
}
digests[i][j] = (hi << 4) | lo;
}
rpc_shards[i] = {
shard.name.c_str(),
shard.size,
shard.metadata_size,
{},
};
memcpy(rpc_shards[i].metadata_sha256, digests[i].data(), digests[i].size());
}
std::vector<ggml_backend_rpc_longhaul_source> rpc_sources;
rpc_sources.reserve(this->sources.size());
for (const auto & source : this->sources) {
rpc_sources.push_back({
source.tensor,
source.file_idx,
source.offset,
source.expert_size,
source.layer,
});
}
ggml_backend_rpc_longhaul_params params = {
n_layers,
n_experts,
(uint32_t) n_slots,
rpc_shards.size(),
rpc_shards.data(),
rpc_sources.size(),
rpc_sources.data(),
};
ggml_backend_reg_t reg = ggml_backend_reg_by_name("RPC");
auto register_fn = reg ? (decltype(ggml_backend_rpc_longhaul_register) *)
ggml_backend_reg_get_proc_address(reg, "ggml_backend_rpc_longhaul_register") : nullptr;
if (!register_fn) {
throw std::runtime_error("RPC backend does not expose longhaul registration");
}
char error[256] = {};
if (!register_fn(&params, &remote_registration_id, error, sizeof(error))) {
throw std::runtime_error(error[0] ? error : "RPC longhaul registration failed");
}
this->files.clear();
return;
}
n_experts(n_experts) {
for (auto & file : this->files) {
file->set_no_cache();
}
@@ -130,17 +45,6 @@ llama_longhaul_cache::llama_longhaul_cache(
}
llama_longhaul_cache::~llama_longhaul_cache() {
if (remote) {
if (!sources.empty() && remote_registration_id != 0) {
ggml_backend_reg_t reg = ggml_backend_reg_by_name("RPC");
auto unregister_fn = reg ? (decltype(ggml_backend_rpc_longhaul_unregister) *)
ggml_backend_reg_get_proc_address(reg, "ggml_backend_rpc_longhaul_unregister") : nullptr;
if (unregister_fn) {
unregister_fn(sources.front().tensor, remote_registration_id);
}
}
return;
}
{
std::lock_guard<std::mutex> lock(io_mutex);
io_stopping = true;
@@ -417,7 +321,3 @@ uint64_t llama_longhaul_cache::misses() const {
uint64_t llama_longhaul_cache::bytes_read_count() const {
return bytes_read;
}
bool llama_longhaul_cache::is_remote() const {
return remote;
}
+1 -7
View File
@@ -17,11 +17,9 @@ struct llama_longhaul_cache {
llama_longhaul_cache(
llama_files files,
std::vector<llama_model_loader::longhaul_source> sources,
std::vector<llama_model_loader::longhaul_shard> shards,
size_t n_slots,
uint32_t n_experts,
uint32_t n_layers,
bool remote);
uint32_t n_layers);
~llama_longhaul_cache();
bool remap(int layer, ggml_tensor * ids);
@@ -33,7 +31,6 @@ struct llama_longhaul_cache {
bool failed() const;
uint64_t misses() const;
uint64_t bytes_read_count() const;
bool is_remote() const;
private:
struct layer_state {
@@ -52,7 +49,6 @@ private:
llama_files files;
std::vector<llama_model_loader::longhaul_source> sources;
std::vector<llama_model_loader::longhaul_shard> shards;
std::vector<std::vector<const llama_model_loader::longhaul_source *>> sources_by_layer;
std::vector<layer_state> layers;
size_t n_slots;
@@ -88,8 +84,6 @@ private:
std::condition_variable io_done;
size_t io_pending = 0;
bool io_stopping = false;
bool remote = false;
uint64_t remote_registration_id = 0;
bool source_is_direct(const llama_model_loader::longhaul_source & source) const;
bool load_plan_sources();
+22
View File
@@ -9,6 +9,7 @@
#include <stdexcept>
#include <cerrno>
#include <algorithm>
#include <mutex>
#ifdef __has_include
#if __has_include(<unistd.h>)
@@ -66,8 +67,12 @@ static std::string llama_format_win_err(DWORD err) {
// llama_file
struct llama_file::impl {
bool no_cache = false;
#if defined(_WIN32)
HANDLE fp_win32;
std::mutex read_at_mutex;
std::string GetErrorMessageWin32(DWORD error_code) const {
std::string ret;
LPSTR lpMsgBuf = NULL;
@@ -433,6 +438,10 @@ void llama_file::read_raw_unsafe(void * ptr, size_t len) { pimpl->read_raw_unsaf
void llama_file::read_at(void * ptr, size_t len, size_t offset) {
#ifdef _WIN32
// The Windows FILE pointer is shared by all longhaul I/O workers. Keep the
// seek and read together so concurrent jobs cannot change each other's
// offsets. POSIX uses pread below and does not need this serialization.
std::lock_guard<std::mutex> lock(pimpl->read_at_mutex);
seek(offset, SEEK_SET);
read_raw(ptr, len);
#else
@@ -448,6 +457,13 @@ void llama_file::read_at(void * ptr, size_t len, size_t offset) {
}
n_read += result;
}
#if defined(__linux__) && defined(POSIX_FADV_DONTNEED)
if (pimpl->no_cache) {
// Longhaul owns a bounded expert cache, so avoid retaining a second
// long-lived copy of completed reads in the kernel page cache.
(void) posix_fadvise(file_id(), (off_t) offset, (off_t) len, POSIX_FADV_DONTNEED);
}
#endif
#endif
}
@@ -456,6 +472,12 @@ void llama_file::set_no_cache() const {
if (fcntl(file_id(), F_NOCACHE, 1) != 0) {
throw std::runtime_error(format("failed to disable file cache: %s", strerror(errno)));
}
#elif defined(__linux__) && defined(POSIX_FADV_RANDOM)
pimpl->no_cache = true;
const int err = posix_fadvise(file_id(), 0, 0, POSIX_FADV_RANDOM);
if (err != 0) {
LLAMA_LOG_WARN("%s: failed to set random-access file advice: %s\n", __func__, strerror(err));
}
#endif
}
+21 -10
View File
@@ -594,11 +594,6 @@ llama_model_loader::llama_model_loader(
files.emplace_back(new llama_file(fname.c_str(), "rb", use_direct_io));
contexts.emplace_back(ctx);
longhaul_shards.push_back({
std::filesystem::path(fname).filename().string(),
files.back()->size(),
gguf_get_data_offset(metadata),
});
// Save tensors data offset of the main file.
// For subsidiary files, `meta` tensor data offset must not be used,
@@ -667,11 +662,6 @@ llama_model_loader::llama_model_loader(
files.emplace_back(new llama_file(fname_split, "rb", use_direct_io));
contexts.emplace_back(ctx);
longhaul_shards.push_back({
std::filesystem::path(fname_split).filename().string(),
files.back()->size(),
gguf_get_data_offset(ctx_gguf.get()),
});
// Save tensors data offset info of the shard.
for (ggml_tensor * cur = ggml_get_first_tensor(ctx); cur; cur = ggml_get_next_tensor(ctx, cur)) {
@@ -1230,6 +1220,7 @@ struct ggml_tensor * llama_model_loader::create_tensor(
}
ggml_backend_buffer_type_t buft = nullptr;
ggml_backend_buffer_type_t requested_override = nullptr;
// check overrides
if (tensor_buft_overrides) {
@@ -1237,6 +1228,7 @@ struct ggml_tensor * llama_model_loader::create_tensor(
for (const auto * overrides = tensor_buft_overrides; overrides->pattern != nullptr; ++overrides) {
std::regex pattern(overrides->pattern);
if (std::regex_search(tensor_name, pattern)) {
requested_override = overrides->buft;
if (overrides->buft == ggml_backend_cpu_buffer_type()) {
// when overriding to a CPU buffer, consider the extra buffer types
buft = select_weight_buft(hparams, t_meta, op, buft_list_cpu);
@@ -1266,6 +1258,25 @@ struct ggml_tensor * llama_model_loader::create_tensor(
}
}
// Streamed CPU experts are updated one expert slice at a time. CPU
// repack and accelerator buffers only accept whole-tensor updates, so
// keep these cache tensors in the standard, directly writable layout.
if ((flags & TENSOR_LONGHAUL) && buft_list == buft_list_cpu) {
auto * cpu_dev = ggml_backend_dev_by_type(GGML_BACKEND_DEVICE_TYPE_CPU);
if (!cpu_dev) {
throw std::runtime_error("no CPU backend found");
}
ggml_backend_buffer_type_t cpu_buft = ggml_backend_dev_buffer_type(cpu_dev);
if (requested_override != nullptr &&
requested_override != ggml_backend_cpu_buffer_type() &&
requested_override != cpu_buft) {
throw std::runtime_error(format(
"longhaul CPU expert tensor '%s' has an incompatible buffer override",
tn.str().c_str()));
}
buft = cpu_buft;
}
// avoid using a host buffer when using mmap
auto * buft_dev = ggml_backend_buft_get_device(buft);
if (use_mmap && buft_dev && buft == ggml_backend_dev_host_buffer_type(buft_dev)) {
-8
View File
@@ -9,7 +9,6 @@
#include "ggml-cpp.h"
#include <array>
#include <cstddef>
#include <cstring>
#include <map>
@@ -78,12 +77,6 @@ struct llama_model_loader {
int layer;
};
struct longhaul_shard {
std::string name;
uint64_t size;
uint64_t metadata_size;
};
int n_kv = 0;
int n_tensors = 0;
int n_created = 0;
@@ -122,7 +115,6 @@ struct llama_model_loader {
std::vector<std::pair<size_t, size_t>> mmaps_used;
size_t longhaul_slots = 0;
std::vector<longhaul_source> longhaul_sources;
std::vector<longhaul_shard> longhaul_shards;
// define a comparator for the buft -> ctx map to ensure that the order is well-defined:
struct ggml_backend_buft_comparator {
+1
View File
@@ -29,6 +29,7 @@ bool llama_model_saver_supports_arch(llm_arch arch) {
case LLM_ARCH_STEP35:
case LLM_ARCH_MELLUM:
case LLM_ARCH_LAGUNA:
case LLM_ARCH_INKLING:
return false;
default:
return true;
+18 -26
View File
@@ -312,6 +312,8 @@ static llama_model * llama_model_mapping(llm_arch arch, const llama_model_params
return new llama_model_kimi_linear(params);
case LLM_ARCH_STEP35:
return new llama_model_step35(params);
case LLM_ARCH_INKLING:
return new llama_model_inkling(params);
default:
throw std::runtime_error(std::string("unsupported model architecture: '") + llm_arch_name(arch) + "'");
}
@@ -1039,7 +1041,6 @@ struct llama_model::impl {
std::vector<float> tensor_split_owned;
std::unique_ptr<llama_longhaul_cache> longhaul;
bool longhaul_remote = false;
};
llama_model::llama_model(const llama_model_params & params) : params(params), pimpl(std::make_unique<impl>()) {
@@ -1357,8 +1358,8 @@ bool llama_model_base::load_tensors(llama_model_loader & ml) {
}
if (params.load_mode == LLAMA_LOAD_MODE_LONGHAUL) {
if (arch != LLM_ARCH_QWEN35MOE && arch != LLM_ARCH_LAGUNA) {
throw std::runtime_error("longhaul currently requires a qwen35moe or laguna model");
if (arch != LLM_ARCH_QWEN35MOE && arch != LLM_ARCH_LAGUNA && arch != LLM_ARCH_INKLING) {
throw std::runtime_error("longhaul currently requires a qwen35moe, laguna, or inkling model");
}
if (hparams.n_layer_nextn != 0) {
throw std::runtime_error("longhaul does not support MTP tensors");
@@ -1366,36 +1367,27 @@ bool llama_model_base::load_tensors(llama_model_loader & ml) {
if (params.check_tensors || params.no_alloc || params.vocab_only) {
throw std::runtime_error("longhaul does not support check-tensors, no-alloc, or vocab-only loading");
}
bool all_cpu = true;
bool all_metal = true;
bool all_rpc = true;
for (int il = 0; il < n_layer_all; ++il) {
ggml_backend_dev_t dev = pimpl->dev_layer[il].dev;
const char * reg_name = ggml_backend_reg_name(ggml_backend_dev_backend_reg(dev));
const char * backend = ggml_backend_reg_name(ggml_backend_dev_backend_reg(dev));
all_cpu = all_cpu && ggml_backend_dev_type(dev) == GGML_BACKEND_DEVICE_TYPE_CPU;
all_metal = all_metal &&
ggml_backend_dev_type(dev) == GGML_BACKEND_DEVICE_TYPE_GPU &&
strcmp(reg_name, "MTL") == 0;
all_rpc = all_rpc &&
ggml_backend_dev_type(dev) == GGML_BACKEND_DEVICE_TYPE_GPU &&
strcmp(reg_name, "RPC") == 0;
strcmp(backend, "MTL") == 0;
}
if (!all_metal && !all_rpc) {
if (!all_cpu && !all_metal) {
throw std::runtime_error(
"longhaul requires all model layers on local Metal or one RPC device");
"longhaul requires every repeating model layer on CPU or Metal; "
"use --n-gpu-layers 0 for CPU mode");
}
if (all_metal) {
#if !defined(__APPLE__)
throw std::runtime_error("local longhaul is only supported on macOS");
#endif
} else {
ggml_backend_dev_t first = pimpl->dev_layer.front().dev;
for (int il = 1; il < n_layer_all; ++il) {
if (pimpl->dev_layer[il].dev != first) {
throw std::runtime_error(
"RPC longhaul v1 requires every model layer on one RPC device");
}
}
pimpl->longhaul_remote = true;
if (all_metal) {
throw std::runtime_error("longhaul Metal mode is only supported on macOS");
}
#endif
LLAMA_LOG_INFO("%s: longhaul using %s expert cache\n", __func__, all_cpu ? "CPU" : "Metal");
ml.configure_longhaul(params.longhaul_cache_bytes, n_expert, n_layer_all);
if (ml.longhaul_slots < (size_t) n_expert_used) {
LLAMA_LOG_WARN("%s: longhaul cache has %zu slots for %lld selected experts; "
@@ -1715,8 +1707,7 @@ bool llama_model_base::load_tensors(llama_model_loader & ml) {
if (params.load_mode == LLAMA_LOAD_MODE_LONGHAUL) {
pimpl->longhaul = std::make_unique<llama_longhaul_cache>(
std::move(ml.files), std::move(ml.longhaul_sources), std::move(ml.longhaul_shards),
ml.longhaul_slots, hparams.n_expert, hparams.n_layer_all, pimpl->longhaul_remote);
std::move(ml.files), std::move(ml.longhaul_sources), ml.longhaul_slots, hparams.n_expert, hparams.n_layer_all);
}
return true;
@@ -2176,7 +2167,7 @@ llama_memory_i * llama_model::create_memory(const llama_memory_params & params,
// layer filters, so pick the right one here
llama_memory_hybrid::layer_filter_cb filter_attn = nullptr;
llama_memory_hybrid::layer_filter_cb filter_recr = nullptr;
if (arch == LLM_ARCH_FALCON_H1) {
if (arch == LLM_ARCH_FALCON_H1 || arch == LLM_ARCH_INKLING) {
filter_attn = [&](uint32_t) { return true; };
filter_recr = [&](uint32_t) { return true; };
} else if (arch == LLM_ARCH_NEMOTRON_H || arch == LLM_ARCH_NEMOTRON_H_MOE) {
@@ -2517,6 +2508,7 @@ llama_rope_type llama_model_rope_type(const llama_model * model) {
case LLM_ARCH_NEMOTRON_H:
case LLM_ARCH_NEMOTRON_H_MOE:
case LLM_ARCH_KIMI_LINEAR:
case LLM_ARCH_INKLING:
return LLAMA_ROPE_TYPE_NONE;
// use what we call a normal RoPE, operating on pairs of consecutive head values
+9
View File
@@ -534,6 +534,15 @@ struct llama_layer {
struct llama_layer_shortconv shortconv;
struct llama_layer_nextn nextn;
// Inkling relative attention and short-convolution weights.
struct ggml_tensor * wr = nullptr;
struct ggml_tensor * attn_rel_proj = nullptr;
struct ggml_tensor * shortconv_k = nullptr;
struct ggml_tensor * shortconv_v = nullptr;
struct ggml_tensor * shortconv_attn = nullptr;
struct ggml_tensor * shortconv_mlp = nullptr;
struct ggml_tensor * ffn_gscale = nullptr;
};
struct llama_device {
+17 -1
View File
@@ -434,6 +434,13 @@ struct llm_tokenizer_bpe : llm_tokenizer {
"[^\\r\\n\\p{L}\\p{N}]?((?=[\\p{L}])([^a-z]))*((?=[\\p{L}])([^A-Z]))+(?:'[sS]|'[tT]|'[rR][eE]|'[vV][eE]|'[mM]|'[lL][lL]|'[dD])?|[^\\r\\n\\p{L}\\p{N}]?((?=[\\p{L}])([^a-z]))+((?=[\\p{L}])([^A-Z]))*(?:'[sS]|'[tT]|'[rR][eE]|'[vV][eE]|'[mM]|'[lL][lL]|'[dD])?|\\p{N}{1,3}| ?[^\\s\\p{L}\\p{N}]+[\\r\\n/]*|\\s*[\\r\\n]+|\\s+(?!\\S)|\\s+",
};
break;
case LLAMA_VOCAB_PRE_TYPE_INKLING:
// o200k-family expression with combining marks included in
// letter lookaheads, as used by the Inkling tokenizer.
regex_exprs = {
"[^\\r\\n\\p{L}\\p{N}]?((?=[\\p{L}\\p{M}])([^a-z]))*((?=[\\p{L}\\p{M}])([^A-Z]))+(?:'[sS]|'[tT]|'[rR][eE]|'[vV][eE]|'[mM]|'[lL][lL]|'[dD])?|[^\\r\\n\\p{L}\\p{N}]?((?=[\\p{L}\\p{M}])([^a-z]))+((?=[\\p{L}\\p{M}])([^A-Z]))*(?:'[sS]|'[tT]|'[rR][eE]|'[vV][eE]|'[mM]|'[lL][lL]|'[dD])?|\\p{N}{1,3}| ?[^\\s\\p{L}\\p{N}]+[\\r\\n/]*|\\s*[\\r\\n]+|\\s+(?!\\S)|\\s+",
};
break;
case LLAMA_VOCAB_PRE_TYPE_GRANITE_EMB_MULTI:
// Same lookaheads as GPT4O but with \p{M} added so combining marks
// (diacritics) attach to their base letters. Avoids excessive
@@ -2324,6 +2331,10 @@ void llama_vocab::impl::load(llama_model_loader & ml, const LLM_KV & kv) {
tokenizer_pre == "talkie") {
pre_type = LLAMA_VOCAB_PRE_TYPE_GPT4O;
clean_spaces = false;
} else if (
tokenizer_pre == "inkling") {
pre_type = LLAMA_VOCAB_PRE_TYPE_INKLING;
clean_spaces = false;
} else if (
tokenizer_pre == "granite-embed-multi-97m") {
pre_type = LLAMA_VOCAB_PRE_TYPE_GRANITE_EMB_MULTI;
@@ -2607,7 +2618,12 @@ void llama_vocab::impl::load(llama_model_loader & ml, const LLM_KV & kv) {
if (suppress_idx != -1) {
const int n = gguf_get_arr_n(ctx, suppress_idx);
const int32_t * data = (const int32_t *) gguf_get_arr_data(ctx, suppress_idx);
suppress_tokens.assign(data, data + n);
suppress_tokens.reserve(n);
for (int i = 0; i < n; ++i) {
if (data[i] >= 0 && data[i] < (int32_t) id_to_token.size()) {
suppress_tokens.push_back(data[i]);
}
}
}
}
+1
View File
@@ -65,6 +65,7 @@ enum llama_vocab_pre_type {
LLAMA_VOCAB_PRE_TYPE_GRANITE_EMB_MULTI = 54,
LLAMA_VOCAB_PRE_TYPE_MELLUM2 = 55,
LLAMA_VOCAB_PRE_TYPE_LAGUNA = 56,
LLAMA_VOCAB_PRE_TYPE_INKLING = 57,
};
struct LLM_KV;
+8 -13
View File
@@ -263,21 +263,16 @@ static bool llama_prepare_model_devices(const llama_model_params & params, llama
}
}
if (params.load_mode == LLAMA_LOAD_MODE_LONGHAUL && !rpc_servers.empty()) {
// RPC longhaul v1 keeps the entire paging domain on one remote device.
model->devices.push_back(rpc_servers.front());
} else {
// add RPC servers at the front of the list to minimize network transfers
model->devices.insert(model->devices.begin(), rpc_servers.begin(), rpc_servers.end());
// add RPC servers at the front of the list to minimize network transfers
model->devices.insert(model->devices.begin(), rpc_servers.begin(), rpc_servers.end());
// add GPUs
model->devices.insert(model->devices.end(), gpus.begin(), gpus.end());
// add GPUs
model->devices.insert(model->devices.end(), gpus.begin(), gpus.end());
// add integrated GPUs only if no discrete GPUs were found
// (RPC servers do not count, otherwise the local iGPU would be dropped on iGPU+RPC setups)
if (gpus.empty()) {
model->devices.insert(model->devices.end(), igpus.begin(), igpus.end());
}
// add integrated GPUs only if no discrete GPUs were found
// (RPC servers do not count, otherwise the local iGPU would be dropped on iGPU+RPC setups)
if (gpus.empty()) {
model->devices.insert(model->devices.end(), igpus.begin(), igpus.end());
}
}
+490
View File
@@ -0,0 +1,490 @@
// Inkling: relative-position attention with per-layer packed short-convolution
// state and a mixture of routed and shared experts.
#include "models.h"
#include "../llama-memory-hybrid-iswa.h"
#include "../llama-memory-recurrent.h"
#include <algorithm>
#include <cmath>
void llama_model_inkling::load_arch_hparams(llama_model_loader & ml) {
ml.get_key(LLM_KV_ATTENTION_LAYERNORM_RMS_EPS, hparams.f_norm_rms_eps);
ml.get_key(LLM_KV_EXPERT_FEED_FORWARD_LENGTH, hparams.n_ff_exp);
ml.get_key(LLM_KV_EXPERT_SHARED_COUNT, hparams.n_expert_shared);
ml.get_key(LLM_KV_EXPERT_WEIGHTS_SCALE, hparams.expert_weights_scale);
ml.get_key(LLM_KV_EXPERT_GATING_FUNC, hparams.expert_gating_func, false);
ml.get_key(LLM_KV_ATTENTION_SLIDING_WINDOW, hparams.n_swa);
hparams.swa_type = LLAMA_SWA_TYPE_STANDARD;
ml.get_key_or_arr(LLM_KV_ATTENTION_SLIDING_WINDOW_PATTERN, hparams.is_swa_impl, hparams.n_layer());
for (uint32_t il = 0; il < hparams.n_layer(); ++il) {
hparams.is_recr_impl[il] = 1;
}
ml.get_key(LLM_KV_INKLING_D_REL, hparams.inkling_d_rel);
ml.get_key(LLM_KV_INKLING_REL_EXTENT, hparams.inkling_rel_extent);
ml.get_key(LLM_KV_INKLING_REL_EXTENT_SWA, hparams.inkling_rel_extent_swa);
ml.get_key(LLM_KV_INKLING_SHORTCONV_KERNEL, hparams.n_shortconv_l_cache);
ml.get_key(LLM_KV_INKLING_DENSE_BLOCK_COUNT, hparams.n_layer_dense_lead);
float logit_scale_denom = 0.0f;
ml.get_key(LLM_KV_INKLING_LOGIT_SCALE_DENOM, logit_scale_denom);
GGML_ASSERT(logit_scale_denom != 0.0f);
hparams.f_logit_scale = 1.0f/logit_scale_denom;
ml.get_key(LLM_KV_INKLING_LOG_SCALING_N_FLOOR, hparams.inkling_log_n_floor, false);
ml.get_key(LLM_KV_INKLING_LOG_SCALING_ALPHA, hparams.inkling_log_alpha, false);
ml.get_key(LLM_KV_INKLING_UNPADDED_VOCAB_SIZE, hparams.inkling_unpadded_n_vocab, false);
GGML_ASSERT(hparams.n_shortconv_l_cache > 1);
GGML_ASSERT(hparams.inkling_d_rel > 0);
GGML_ASSERT(hparams.inkling_rel_extent > 0 && hparams.inkling_rel_extent_swa > 0);
// Four streams per layer: K, V, attention output, and MLP output.
const uint32_t d_conv = hparams.n_shortconv_l_cache - 1;
hparams.n_embd_r_impl = d_conv *
(hparams.n_embd_k_gqa_max() + hparams.n_embd_v_gqa_max() + 2*hparams.n_embd);
type = LLM_TYPE_UNKNOWN;
}
void llama_model_inkling::load_arch_tensors(llama_model_loader &) {
LLAMA_LOAD_LOCALS;
const int64_t head_dim = hparams.n_embd_head_k();
const int64_t d_rel = hparams.inkling_d_rel;
const int64_t K = hparams.n_shortconv_l_cache;
const int64_t n_ff_exp = hparams.n_ff_exp;
const int64_t n_shexp = hparams.n_expert_shared;
const int expert_flags = params.load_mode == LLAMA_LOAD_MODE_LONGHAUL ? TENSOR_LONGHAUL : 0;
tok_embd = create_tensor(tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, 0);
tok_norm = create_tensor(tn(LLM_TENSOR_TOKEN_EMBD_NORM, "weight", 0), {n_embd}, 0);
output_norm = create_tensor(tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, 0);
output = create_tensor(tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, 0);
for (int i = 0; i < n_layer; ++i) {
auto & layer = layers[i];
const int64_t n_head_kv_i = hparams.n_head_kv(i);
const int64_t kvw = n_head_kv_i*head_dim;
const int64_t rel_extent = hparams.is_swa(i)
? hparams.inkling_rel_extent_swa
: hparams.inkling_rel_extent;
layer.attn_norm = create_tensor(tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, 0);
layer.wq = create_tensor(tn(LLM_TENSOR_ATTN_Q, "weight", i), {n_embd, n_head*head_dim}, 0);
layer.wk = create_tensor(tn(LLM_TENSOR_ATTN_K, "weight", i), {n_embd, kvw}, 0);
layer.wv = create_tensor(tn(LLM_TENSOR_ATTN_V, "weight", i), {n_embd, kvw}, 0);
layer.wr = create_tensor(tn(LLM_TENSOR_ATTN_R, "weight", i), {n_embd, n_head*d_rel}, 0);
layer.wo = create_tensor(tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_head*head_dim, n_embd}, 0);
layer.attn_q_norm = create_tensor(tn(LLM_TENSOR_ATTN_Q_NORM, "weight", i), {head_dim}, 0);
layer.attn_k_norm = create_tensor(tn(LLM_TENSOR_ATTN_K_NORM, "weight", i), {head_dim}, 0);
layer.attn_rel_proj = create_tensor(
tn(LLM_TENSOR_ATTN_REL_PROJ, "weight", i), {rel_extent, d_rel}, 0);
layer.shortconv_k = create_tensor(tn(LLM_TENSOR_SHORTCONV_K, "weight", i), {K, kvw}, 0);
layer.shortconv_v = create_tensor(tn(LLM_TENSOR_SHORTCONV_V, "weight", i), {K, kvw}, 0);
layer.shortconv_attn = create_tensor(tn(LLM_TENSOR_SHORTCONV_ATTN, "weight", i), {K, n_embd}, 0);
layer.shortconv_mlp = create_tensor(tn(LLM_TENSOR_SHORTCONV_MLP, "weight", i), {K, n_embd}, 0);
layer.ffn_norm = create_tensor(tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, 0);
layer.ffn_gscale = create_tensor(tn(LLM_TENSOR_FFN_GSCALE, "weight", i), {1}, 0);
if (i < (int) hparams.n_layer_dense_lead) {
const int64_t n_ff_i = hparams.n_ff(i);
layer.ffn_gate = create_tensor(tn(LLM_TENSOR_FFN_GATE, "weight", i), {n_embd, n_ff_i}, 0);
layer.ffn_up = create_tensor(tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff_i}, 0);
layer.ffn_down = create_tensor(tn(LLM_TENSOR_FFN_DOWN, "weight", i), {n_ff_i, n_embd}, 0);
} else {
GGML_ASSERT(n_expert > 0 && n_expert_used > 0 && n_shexp > 0);
// The final rows are shared-expert sink logits.
layer.ffn_gate_inp = create_tensor(
tn(LLM_TENSOR_FFN_GATE_INP, "weight", i), {n_embd, n_expert + n_shexp}, 0);
layer.ffn_exp_probs_b = create_tensor(
tn(LLM_TENSOR_FFN_EXP_PROBS_B, "bias", i), {n_expert}, 0);
layer.ffn_gate_exps = create_tensor(
tn(LLM_TENSOR_FFN_GATE_EXPS, "weight", i),
{n_embd, n_ff_exp, n_expert}, expert_flags);
layer.ffn_up_exps = create_tensor(
tn(LLM_TENSOR_FFN_UP_EXPS, "weight", i),
{n_embd, n_ff_exp, n_expert}, expert_flags);
layer.ffn_down_exps = create_tensor(
tn(LLM_TENSOR_FFN_DOWN_EXPS, "weight", i),
{n_ff_exp, n_embd, n_expert}, expert_flags);
// Shared experts stay resident and are never part of the longhaul cache.
layer.ffn_gate_shexp = create_tensor(
tn(LLM_TENSOR_FFN_GATE_SHEXPS, "weight", i),
{n_embd, n_ff_exp, n_shexp}, 0);
layer.ffn_up_shexp = create_tensor(
tn(LLM_TENSOR_FFN_UP_SHEXPS, "weight", i),
{n_embd, n_ff_exp, n_shexp}, 0);
layer.ffn_down_shexp = create_tensor(
tn(LLM_TENSOR_FFN_DOWN_SHEXPS, "weight", i),
{n_ff_exp, n_embd, n_shexp}, 0);
}
}
}
class llm_graph_input_inkling : public llm_graph_input_i {
public:
llm_graph_input_inkling(
const llama_hparams & hparams,
const llama_memory_hybrid_iswa_context * mctx) :
hparams(hparams), mctx(mctx) {
}
void set_input(const llama_ubatch * ubatch) override {
if (tau) {
GGML_ASSERT(ggml_backend_buffer_is_host(tau->buffer));
float * data = (float *) tau->data;
const float n_floor = (float) hparams.inkling_log_n_floor;
const float alpha = hparams.inkling_log_alpha;
for (int64_t i = 0; i < (int64_t) ubatch->n_tokens; ++i) {
const float eff = (float) (ubatch->pos[i] + 1)/n_floor;
data[i] = 1.0f + alpha*logf(std::max(eff, 1.0f));
}
}
if (rel_idx) {
mctx->get_attn()->get_base()->set_input_pos_rel_flat(
rel_idx, ubatch, hparams.inkling_rel_extent);
}
if (rel_idx_swa) {
mctx->get_attn()->get_swa()->set_input_pos_rel_flat(
rel_idx_swa, ubatch, hparams.inkling_rel_extent_swa);
}
if (vocab_mask) {
GGML_ASSERT(ggml_backend_buffer_is_host(vocab_mask->buffer));
float * data = (float *) vocab_mask->data;
for (int64_t id = 0; id < vocab_mask->ne[0]; ++id) {
data[id] = id < (int64_t) hparams.inkling_unpadded_n_vocab ? 0.0f : -INFINITY;
}
}
if (shexp_idx) {
GGML_ASSERT(ggml_backend_buffer_is_host(shexp_idx->buffer));
int32_t * data = (int32_t *) shexp_idx->data;
for (int64_t j = 0; j < shexp_idx->ne[1]; ++j) {
for (int64_t s = 0; s < shexp_idx->ne[0]; ++s) {
data[j*shexp_idx->ne[0] + s] = (int32_t) s;
}
}
}
}
ggml_tensor * tau = nullptr;
ggml_tensor * rel_idx = nullptr;
ggml_tensor * rel_idx_swa = nullptr;
ggml_tensor * vocab_mask = nullptr;
ggml_tensor * shexp_idx = nullptr;
private:
const llama_hparams hparams;
const llama_memory_hybrid_iswa_context * mctx;
};
std::unique_ptr<llm_graph_context> llama_model_inkling::build_arch_graph(
const llm_graph_params & params) const {
return std::make_unique<graph>(*this, params);
}
llama_model_inkling::graph::graph(
const llama_model & model,
const llm_graph_params & params) :
llm_graph_context(params) {
const int64_t head_dim = hparams.n_embd_head_k();
const int64_t d_rel = hparams.inkling_d_rel;
const int64_t d_conv = hparams.n_shortconv_l_cache - 1;
const int64_t n_embd_r = hparams.n_embd_r();
const int64_t kw_max = hparams.n_embd_k_gqa_max();
const int64_t vw_max = hparams.n_embd_v_gqa_max();
const int64_t off_k = 0;
const int64_t off_v = d_conv*kw_max;
const int64_t off_attn = d_conv*(kw_max + vw_max);
const int64_t off_mlp = d_conv*(kw_max + vw_max + n_embd);
const auto * mctx_hyb = static_cast<const llama_memory_hybrid_iswa_context *>(mctx);
const auto * mctx_recr = mctx_hyb->get_recr();
const auto * mctx_attn = mctx_hyb->get_attn();
const uint32_t kv_head = mctx_recr->get_head();
const int64_t n_seq_tokens = ubatch.n_seq_tokens;
const int64_t n_seqs = ubatch.n_seqs;
GGML_ASSERT(n_seqs != 0);
GGML_ASSERT(ubatch.equal_seqs());
GGML_ASSERT(ubatch.n_tokens == n_seq_tokens*n_seqs);
bool has_global = false;
bool has_local = false;
for (int il = 0; il < n_layer; ++il) {
has_local |= hparams.is_swa(il);
has_global |= !hparams.is_swa(il);
}
auto inp = std::make_unique<llm_graph_input_inkling>(hparams, mctx_hyb);
if (hparams.inkling_log_n_floor > 0 && has_global) {
inp->tau = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, 1, 1, n_tokens);
ggml_set_input(inp->tau);
ggml_set_name(inp->tau, "inkling_tau");
}
if (has_global) {
inp->rel_idx = ggml_new_tensor_2d(
ctx0, GGML_TYPE_I32, mctx_attn->get_base()->get_n_kv(), n_tokens);
ggml_set_input(inp->rel_idx);
ggml_set_name(inp->rel_idx, "inkling_rel_idx");
}
if (has_local) {
inp->rel_idx_swa = ggml_new_tensor_2d(
ctx0, GGML_TYPE_I32, mctx_attn->get_swa()->get_n_kv(), n_tokens);
ggml_set_input(inp->rel_idx_swa);
ggml_set_name(inp->rel_idx_swa, "inkling_rel_idx_swa");
}
const int64_t n_vocab = model.vocab.n_tokens();
if (!cparams.embeddings &&
hparams.inkling_unpadded_n_vocab > 0 &&
(int64_t) hparams.inkling_unpadded_n_vocab < n_vocab) {
inp->vocab_mask = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, n_vocab);
ggml_set_input(inp->vocab_mask);
ggml_set_name(inp->vocab_mask, "inkling_vocab_mask");
}
if (hparams.n_expert_shared > 0 && (uint32_t) n_layer > hparams.n_layer_dense_lead) {
inp->shexp_idx = ggml_new_tensor_2d(
ctx0, GGML_TYPE_I32, hparams.n_expert_shared, n_tokens);
ggml_set_input(inp->shexp_idx);
ggml_set_name(inp->shexp_idx, "inkling_shexp_idx");
}
ggml_tensor * tau = inp->tau;
ggml_tensor * rel_idx = inp->rel_idx;
ggml_tensor * rel_idx_swa = inp->rel_idx_swa;
ggml_tensor * vocab_mask = inp->vocab_mask;
ggml_tensor * shexp_idx = inp->shexp_idx;
res->add_input(std::move(inp));
auto * inp_hybrid = build_inp_mem_hybrid_iswa();
ggml_tensor * conv_rs_cur = nullptr;
auto build_sconv = [&](ggml_tensor * x2d, ggml_tensor * kernel, int64_t off, int il) {
const int64_t w = x2d->ne[0];
ggml_tensor * x3 = ggml_reshape_3d(ctx0, x2d, w, n_seq_tokens, n_seqs);
ggml_tensor * xt = ggml_transpose(ctx0, x3);
ggml_tensor * conv_state = mctx_recr->get_r_l(il);
GGML_ASSERT(conv_rs_cur != nullptr);
const size_t sz = ggml_element_size(conv_rs_cur);
ggml_tensor * state = ggml_view_3d(
ctx0, conv_rs_cur, d_conv, w, n_seqs,
d_conv*sz, conv_rs_cur->nb[1], off*sz);
ggml_tensor * sx = ggml_concat(ctx0, state, xt, 0);
ggml_tensor * new_state = ggml_view_3d(
ctx0, sx, d_conv, w, n_seqs,
sx->nb[1], sx->nb[2], (sx->ne[0] - d_conv)*sx->nb[0]);
ggml_tensor * state_dst = ggml_view_3d(
ctx0, conv_state, d_conv, w, n_seqs,
d_conv*sz, n_embd_r*sz, (kv_head*n_embd_r + off)*sz);
ggml_build_forward_expand(gf, ggml_cpy(ctx0, new_state, state_dst));
ggml_tensor * conv_out = ggml_ssm_conv(ctx0, sx, kernel);
return ggml_reshape_2d(ctx0, ggml_add(ctx0, x3, conv_out), w, n_seq_tokens*n_seqs);
};
auto build_attn_block = [&](ggml_tensor * cur, int il) {
const auto & layer = model.layers[il];
const bool is_swa = hparams.is_swa(il);
const int64_t n_head_kv = hparams.n_head_kv(il);
const int64_t rel_extent = is_swa
? hparams.inkling_rel_extent_swa
: hparams.inkling_rel_extent;
ggml_tensor * q = build_lora_mm(layer.wq, cur);
ggml_tensor * k = build_lora_mm(layer.wk, cur);
ggml_tensor * v = build_lora_mm(layer.wv, cur);
ggml_tensor * r = build_lora_mm(layer.wr, cur);
k = build_sconv(k, layer.shortconv_k, off_k, il);
v = build_sconv(v, layer.shortconv_v, off_v, il);
q = ggml_reshape_3d(ctx0, q, head_dim, n_head, n_tokens);
k = ggml_reshape_3d(ctx0, k, head_dim, n_head_kv, n_tokens);
v = ggml_reshape_3d(ctx0, v, head_dim, n_head_kv, n_tokens);
q = build_norm(q, layer.attn_q_norm, nullptr, LLM_NORM_RMS, il);
k = build_norm(k, layer.attn_k_norm, nullptr, LLM_NORM_RMS, il);
if (tau && !is_swa) {
q = ggml_mul(ctx0, q, tau);
}
ggml_tensor * r2 = ggml_reshape_2d(ctx0, r, d_rel, n_head*n_tokens);
ggml_tensor * proj = ggml_cont(ctx0, ggml_transpose(ctx0, layer.attn_rel_proj));
ggml_tensor * rel = ggml_mul_mat(ctx0, proj, r2);
ggml_mul_mat_set_prec(rel, GGML_PREC_F32);
rel = ggml_reshape_3d(ctx0, rel, rel_extent, n_head, n_tokens);
if (tau && !is_swa) {
rel = ggml_mul(ctx0, rel, tau);
}
// Scale Q rather than build_attn's joint logits so the relative term
// remains unscaled, matching the reference implementation.
q = ggml_scale(ctx0, q, 1.0f/(float) head_dim);
rel = ggml_pad(ctx0, rel, 1, 0, 0, 0);
rel = ggml_cont(ctx0, ggml_permute(ctx0, rel, 1, 0, 2, 3));
rel = ggml_reshape_2d(ctx0, rel, n_head, (rel_extent + 1)*n_tokens);
ggml_tensor * idx = is_swa ? rel_idx_swa : rel_idx;
GGML_ASSERT(idx != nullptr);
const int64_t n_kv = idx->ne[0];
ggml_tensor * idx1 = ggml_reshape_1d(ctx0, idx, n_kv*n_tokens);
ggml_tensor * kq_b = ggml_get_rows(ctx0, rel, idx1);
kq_b = ggml_reshape_3d(ctx0, kq_b, n_head, n_kv, n_tokens);
kq_b = ggml_cont(ctx0, ggml_permute(ctx0, kq_b, 2, 0, 1, 3));
auto * inp_attn = inp_hybrid->get_attn();
const int64_t n_stream =
(is_swa ? inp_attn->get_kq_mask_swa() : inp_attn->get_kq_mask())->ne[3];
GGML_ASSERT(n_stream > 0 && n_tokens % n_stream == 0);
if (n_stream > 1) {
kq_b = ggml_view_4d(
ctx0, kq_b, n_kv, n_tokens/n_stream, n_head, n_stream,
kq_b->nb[1], kq_b->nb[2], (n_tokens/n_stream)*kq_b->nb[1], 0);
}
return build_attn(
inp_attn, layer.wo, nullptr, nullptr,
q, k, v, kq_b, nullptr, nullptr, 1.0f, il);
};
auto build_dense_ffn = [&](ggml_tensor * cur, int il) {
cur = build_ffn(
cur,
model.layers[il].ffn_up, nullptr, nullptr,
model.layers[il].ffn_gate, nullptr, nullptr,
model.layers[il].ffn_down, nullptr, nullptr,
nullptr, LLM_FFN_SILU, LLM_FFN_PAR, il);
return ggml_mul(ctx0, cur, model.layers[il].ffn_gscale);
};
auto build_moe = [&](ggml_tensor * cur, int il) {
const auto & layer = model.layers[il];
const int64_t n_shexp = hparams.n_expert_shared;
ggml_tensor * logits = build_lora_mm(layer.ffn_gate_inp, cur);
ggml_mul_mat_set_prec(logits, GGML_PREC_F32);
const size_t lsz = ggml_element_size(logits);
ggml_tensor * routed = ggml_cont(ctx0, ggml_view_2d(
ctx0, logits, n_expert, n_tokens, logits->nb[1], 0));
ggml_tensor * shared_logits = ggml_view_2d(
ctx0, logits, n_shexp, n_tokens, logits->nb[1], n_expert*lsz);
ggml_tensor * scores = ggml_add(
ctx0, ggml_sigmoid(ctx0, routed), layer.ffn_exp_probs_b);
ggml_tensor * selected = ggml_argsort_top_k(
ctx0, scores, n_expert_used);
ggml_tensor * routed3 = ggml_reshape_3d(ctx0, routed, 1, n_expert, n_tokens);
ggml_tensor * topk_logits = ggml_reshape_2d(
ctx0, ggml_get_rows(ctx0, routed3, selected), n_expert_used, n_tokens);
ggml_tensor * all_logits = ggml_concat(ctx0, topk_logits, shared_logits, 0);
ggml_tensor * w = ggml_neg(
ctx0, ggml_softplus(ctx0, ggml_neg(ctx0, all_logits)));
w = ggml_soft_max(ctx0, w);
w = ggml_scale(ctx0, w, hparams.expert_weights_scale);
w = ggml_mul(ctx0, w, layer.ffn_gscale);
const size_t wsz = ggml_element_size(w);
ggml_tensor * weights = ggml_cont(ctx0, ggml_view_2d(
ctx0, w, n_expert_used, n_tokens, w->nb[1], 0));
weights = ggml_reshape_3d(ctx0, weights, 1, n_expert_used, n_tokens);
ggml_tensor * moe_out = build_moe_experts(
cur, selected, weights,
layer.ffn_up_exps, layer.ffn_gate_exps, layer.ffn_down_exps,
n_expert_used, LLM_FFN_SILU, il);
GGML_ASSERT(shexp_idx != nullptr);
ggml_tensor * xr = ggml_reshape_3d(ctx0, cur, n_embd, 1, n_tokens);
ggml_tensor * gs = build_lora_mm_id(layer.ffn_gate_shexp, xr, shexp_idx);
ggml_tensor * us = build_lora_mm_id(layer.ffn_up_shexp, xr, shexp_idx);
ggml_tensor * hs = ggml_swiglu_split(ctx0, gs, us);
ggml_tensor * gammas = ggml_cont(ctx0, ggml_view_2d(
ctx0, w, n_shexp, n_tokens, w->nb[1], n_expert_used*wsz));
hs = ggml_mul(ctx0, hs, ggml_reshape_3d(ctx0, gammas, 1, n_shexp, n_tokens));
ggml_tensor * ds = build_lora_mm_id(layer.ffn_down_shexp, hs, shexp_idx);
for (int64_t s = 0; s < n_shexp; ++s) {
ggml_tensor * e = ggml_view_2d(
ctx0, ds, n_embd, n_tokens, ds->nb[2], s*ds->nb[1]);
moe_out = ggml_add(ctx0, moe_out, e);
}
return moe_out;
};
ggml_tensor * cur = build_inp_embd(model.tok_embd);
if (ubatch.token) {
cur = build_norm(cur, model.tok_norm, nullptr, LLM_NORM_RMS, -1);
}
ggml_build_forward_expand(gf, cur);
for (int il = 0; il < n_layer; ++il) {
conv_rs_cur = build_rs(
inp_hybrid->get_recr(), mctx_recr->get_r_l(il), n_embd_r, n_seqs);
ggml_tensor * attn_in = build_norm(
cur, model.layers[il].attn_norm, nullptr, LLM_NORM_RMS, il);
ggml_tensor * attn_out = build_attn_block(attn_in, il);
attn_out = build_sconv(
attn_out, model.layers[il].shortconv_attn, off_attn, il);
cur = ggml_add(ctx0, cur, attn_out);
ggml_tensor * ffn_in = build_norm(
cur, model.layers[il].ffn_norm, nullptr, LLM_NORM_RMS, il);
ggml_tensor * ffn_out = il < (int) hparams.n_layer_dense_lead
? build_dense_ffn(ffn_in, il)
: build_moe(ffn_in, il);
ffn_out = build_sconv(
ffn_out, model.layers[il].shortconv_mlp, off_mlp, il);
cur = ggml_add(ctx0, cur, ffn_out);
cur = build_cvec(cur, il);
cb(cur, "l_out", il);
}
ggml_tensor * inp_out_ids = build_inp_out_ids();
if (inp_out_ids) {
cur = ggml_get_rows(ctx0, cur, inp_out_ids);
}
cur = build_norm(cur, model.output_norm, nullptr, LLM_NORM_RMS, -1);
res->t_embd = cur;
if (!cparams.embeddings) {
cur = ggml_scale(ctx0, cur, hparams.f_logit_scale);
cur = build_lora_mm(model.output, cur);
if (model.output->type == GGML_TYPE_F32) {
ggml_mul_mat_set_prec(cur, GGML_PREC_F32);
}
if (vocab_mask) {
cur = ggml_add(ctx0, cur, vocab_mask);
}
res->t_logits = cur;
}
ggml_build_forward_expand(gf, cur);
}
+12
View File
@@ -1865,6 +1865,18 @@ struct llama_model_lfm2moe : public llama_model_base {
std::unique_ptr<llm_graph_context> build_arch_graph(const llm_graph_params & params) const override;
};
struct llama_model_inkling : public llama_model_base {
llama_model_inkling(const struct llama_model_params & params) : llama_model_base(params) {}
void load_arch_hparams(llama_model_loader & ml) override;
void load_arch_tensors(llama_model_loader & ml) override;
struct graph : public llm_graph_context {
graph(const llama_model & model, const llm_graph_params & params);
};
std::unique_ptr<llm_graph_context> build_arch_graph(const llm_graph_params & params) const override;
};
struct llama_model_smallthinker : public llama_model_base {
llama_model_smallthinker(const struct llama_model_params & params) : llama_model_base(params) {}
+50
View File
@@ -259,6 +259,56 @@ set_tests_properties(test-thread-safety PROPERTIES FIXTURES_REQUIRED test-downlo
llama_build_and_test(test-arg-parser.cpp)
llama_build_and_test(test-longhaul.cpp)
llama_test(
test-longhaul
NAME test-longhaul-cpu-qwen35moe
ARGS --cpu-model "${MODEL_DIR}/qwen35moe-moe.gguf" 3145728
)
set_tests_properties(test-longhaul-cpu-qwen35moe PROPERTIES
FIXTURES_REQUIRED generate-models
)
llama_test(
test-longhaul
NAME test-longhaul-cpu-laguna
ARGS --cpu-model "${MODEL_DIR}/laguna-moe.gguf" 2097152
)
set_tests_properties(test-longhaul-cpu-laguna PROPERTIES
FIXTURES_REQUIRED generate-models
)
llama_test(
test-longhaul
NAME test-longhaul-cpu-inkling
ARGS --cpu-model "${MODEL_DIR}/inkling-moe.gguf" 73728 1
)
set_tests_properties(test-longhaul-cpu-inkling PROPERTIES
FIXTURES_REQUIRED generate-models
)
llama_test(
test-longhaul
NAME test-longhaul-cpu-inkling-six-slots
ARGS --cpu-model "${MODEL_DIR}/inkling-moe.gguf" 442368 6
)
set_tests_properties(test-longhaul-cpu-inkling-six-slots PROPERTIES
FIXTURES_REQUIRED generate-models
)
if (APPLE AND GGML_METAL)
llama_test(
test-longhaul
NAME test-longhaul-metal-inkling
ARGS --metal-model "${MODEL_DIR}/inkling-moe.gguf" 73728 1
)
set_tests_properties(test-longhaul-metal-inkling PROPERTIES
FIXTURES_REQUIRED generate-models
)
llama_test(
test-longhaul
NAME test-longhaul-metal-inkling-six-slots
ARGS --metal-model "${MODEL_DIR}/inkling-moe.gguf" 442368 6
)
set_tests_properties(test-longhaul-metal-inkling-six-slots PROPERTIES
FIXTURES_REQUIRED generate-models
)
endif()
llama_build_and_test(test-token-cache.cpp)
target_include_directories(test-token-cache PRIVATE ${PROJECT_SOURCE_DIR}/src)
+75 -1
View File
@@ -91,6 +91,7 @@ static void test_normalize_quotes_with_embedded_quotes(testing & t);
static void test_tagged_args_with_embedded_quotes(testing & t);
static void test_role_markers_all_templates(testing & t);
static void test_inkling_tml_parser(testing & t);
int main(int argc, char * argv[]) {
testing t(std::cout);
@@ -117,6 +118,7 @@ int main(int argc, char * argv[]) {
t.test("standard_json_tools", test_standard_json_tools_formats);
t.test("normalize_quotes_to_json", test_normalize_quotes_to_json);
t.test("tagged_args_embedded_quotes", test_tagged_args_with_embedded_quotes);
t.test("inkling_tml", test_inkling_tml_parser);
t.test("role_markers_all_templates", test_role_markers_all_templates);
return t.summary();
@@ -2075,6 +2077,79 @@ static void test_role_markers_all_templates(testing & t) {
}
}
static void test_inkling_tml_parser(testing & t) {
const std::string tmpl_src =
"{# <|content_thinking|><|content_text|> #}"
"{%- for message in messages -%}"
"<|message_user|><|content_text|>{{ message.content }}<|end_message|>"
"{%- endfor -%}"
"{%- if add_generation_prompt -%}<|message_model|>{%- endif -%}";
common_chat_templates_ptr tmpls =
common_chat_templates_init(nullptr, tmpl_src);
common_chat_templates_inputs inputs;
common_chat_msg user_message;
user_message.role = "user";
user_message.content = "Hello";
inputs.messages = { user_message };
inputs.add_generation_prompt = true;
inputs.reasoning_format = COMMON_REASONING_FORMAT_DEEPSEEK;
inputs.tools = common_chat_tools_parse_oaicompat(build_test_tools());
inputs.parallel_tool_calls = true;
inputs.use_jinja = true;
const common_chat_params params =
common_chat_templates_apply(tmpls.get(), inputs);
t.assert_equal(
"Inkling uses the native PEG parser",
COMMON_CHAT_FORMAT_PEG_NATIVE,
params.format);
t.assert_true("Inkling exposes thinking blocks", params.supports_thinking);
t.assert_equal(
"Inkling generation marker",
"<|message_model|>",
params.generation_prompt);
common_peg_arena arena;
arena.load(params.parser);
common_chat_parser_params parser_params(params);
parser_params.reasoning_format = COMMON_REASONING_FORMAT_DEEPSEEK;
const common_chat_msg parsed = common_chat_peg_parse(
arena,
"<|content_thinking|>plan<|end_message|>"
"<|message_model|><|content_text|>answer<|end_message|>"
"<|content_model_end_sampling|>",
false,
parser_params);
t.assert_equal("reasoning block", "plan", parsed.reasoning_content);
t.assert_equal("text block", "answer", parsed.content);
const common_chat_msg tool_parsed = common_chat_peg_parse(
arena,
"<|content_thinking|>I should check.<|end_message|>"
"<|message_model|><|content_invoke_tool_json|>"
R"({"name":"get_current_weather","args":{"location":"Chicago","unit":"celsius"}})"
"<|end_message|>"
"<|message_model|><|content_invoke_tool_json|>"
R"({"name":"get_current_weather","args":{"location":"Austin","unit":"fahrenheit"}})"
"<|end_message|><|content_model_end_sampling|>",
false,
parser_params);
t.assert_equal("tool reasoning block", "I should check.", tool_parsed.reasoning_content);
t.assert_equal("parallel tool-call count", 2u, tool_parsed.tool_calls.size());
if (tool_parsed.tool_calls.size() == 2) {
t.assert_equal("first tool name", "get_current_weather", tool_parsed.tool_calls[0].name);
t.assert_equal("second tool name", "get_current_weather", tool_parsed.tool_calls[1].name);
t.assert_true(
"first tool arguments",
tool_parsed.tool_calls[0].arguments.find("Chicago") != std::string::npos);
t.assert_true(
"second tool arguments",
tool_parsed.tool_calls[1].arguments.find("Austin") != std::string::npos);
}
}
// Test that reproduces the Seed-OSS template issue with embedded quotes
static void test_tagged_args_with_embedded_quotes(testing & t) {
json tools = build_edit_tool();
@@ -2192,4 +2267,3 @@ static void test_tagged_args_with_embedded_quotes(testing & t) {
}
}
}
+54 -5
View File
@@ -9,6 +9,7 @@
// TODO: replace with #include "llama-ext.h" in the future
#include "../src/llama-arch.h"
#include "../src/llama-model.h"
#include "../src/llama-model-saver.h"
#include <cinttypes>
@@ -113,6 +114,11 @@ static gguf_context_ptr get_gguf_ctx(const llm_arch arch, const bool moe) {
n_layer = 3;
} else if (arch == LLM_ARCH_CHAMELEON) {
n_vocab = 10240;
} else if (arch == LLM_ARCH_INKLING) {
n_embd = 64;
n_head = 2;
n_ff = 96;
n_layer = 2;
}
const uint32_t n_embd_head = n_embd / n_head;
@@ -197,6 +203,10 @@ static gguf_context_ptr get_gguf_ctx(const llm_arch arch, const bool moe) {
pattern.push_back(il % 2);
}
ms.add_kv(LLM_KV_ATTENTION_SLIDING_WINDOW_PATTERN, pattern);
} else if (arch == LLM_ARCH_INKLING) {
ms.add_kv(
LLM_KV_ATTENTION_SLIDING_WINDOW_PATTERN,
std::vector<uint32_t>({1, 0}));
} else {
ms.add_kv(LLM_KV_ATTENTION_SLIDING_WINDOW_PATTERN, uint32_t(2));
}
@@ -216,12 +226,27 @@ static gguf_context_ptr get_gguf_ctx(const llm_arch arch, const bool moe) {
if (moe) {
ms.add_kv(LLM_KV_EXPERT_FEED_FORWARD_LENGTH, n_ff);
ms.add_kv(LLM_KV_INTERLEAVE_MOE_LAYER_STEP, uint32_t(2));
ms.add_kv(LLM_KV_EXPERT_COUNT, uint32_t(2));
ms.add_kv(LLM_KV_EXPERT_USED_COUNT, uint32_t(1));
ms.add_kv(LLM_KV_EXPERT_SHARED_COUNT, uint32_t(1));
ms.add_kv(LLM_KV_EXPERT_COUNT, arch == LLM_ARCH_INKLING ? uint32_t(8) : uint32_t(2));
ms.add_kv(LLM_KV_EXPERT_USED_COUNT, arch == LLM_ARCH_INKLING ? uint32_t(6) : uint32_t(1));
ms.add_kv(LLM_KV_EXPERT_SHARED_COUNT, arch == LLM_ARCH_INKLING ? uint32_t(2) : uint32_t(1));
ms.add_kv(LLM_KV_EXPERT_GATING_FUNC, uint32_t(2)); // sigmoid
ms.add_kv(LLM_KV_EXPERT_GROUP_SCALE, 1.0f);
ms.add_kv(LLM_KV_EXPERTS_PER_GROUP, uint32_t(1));
if (arch == LLM_ARCH_INKLING) {
ms.add_kv(LLM_KV_EXPERT_WEIGHTS_SCALE, 1.0f);
}
}
if (arch == LLM_ARCH_INKLING) {
ms.add_kv(LLM_KV_INKLING_D_REL, uint32_t(8));
ms.add_kv(LLM_KV_INKLING_REL_EXTENT, uint32_t(32));
ms.add_kv(LLM_KV_INKLING_REL_EXTENT_SWA, uint32_t(16));
ms.add_kv(LLM_KV_INKLING_SHORTCONV_KERNEL, uint32_t(4));
ms.add_kv(LLM_KV_INKLING_DENSE_BLOCK_COUNT, uint32_t(1));
ms.add_kv(LLM_KV_INKLING_LOGIT_SCALE_DENOM, 1.0f);
ms.add_kv(LLM_KV_INKLING_LOG_SCALING_N_FLOOR, uint32_t(16));
ms.add_kv(LLM_KV_INKLING_LOG_SCALING_ALPHA, 0.1f);
ms.add_kv(LLM_KV_INKLING_UNPADDED_VOCAB_SIZE, n_vocab);
}
ms.add_kv(LLM_KV_POSNET_EMBEDDING_LENGTH, n_embd);
@@ -371,6 +396,7 @@ static bool moe_mandatory(const llm_arch arch) {
case LLM_ARCH_MISTRAL4:
case LLM_ARCH_MELLUM:
case LLM_ARCH_LAGUNA:
case LLM_ARCH_INKLING:
return true;
default:
return false;
@@ -476,7 +502,11 @@ static int save_models(const llm_arch target_arch, const size_t seed, const ggml
if (!moe && moe_mandatory(arch)) {
continue;
}
if (!llama_model_saver_supports_arch(arch) || !arch_supported(arch)) {
const bool can_save_fixture =
llama_model_saver_supports_arch(arch) ||
arch == LLM_ARCH_LAGUNA ||
arch == LLM_ARCH_INKLING;
if (!can_save_fixture || !arch_supported(arch)) {
LOG_INF("%s: %s model (%s) is unsupported, skipping\n", __func__, llm_arch_name(arch), moe ? "MoE" : "dense");
continue;
}
@@ -484,7 +514,26 @@ static int save_models(const llm_arch target_arch, const size_t seed, const ggml
auto model_and_ctx = get_model_and_ctx(gguf_ctx.get(), nullptr, seed, {});
const std::string path = dir + "/" + llm_arch_name(arch) + (moe ? "-moe.gguf" : "-dense.gguf");
LOG_INF("%s: Saving %s model (%s) to %s...\n", __func__, llm_arch_name(arch), moe ? "MoE" : "dense", path.c_str());
llama_model_save_to_file(model_and_ctx.first.get(), path.c_str());
const bool private_fixture =
arch == LLM_ARCH_LAGUNA || arch == LLM_ARCH_INKLING;
if (llama_model_saver_supports_arch(arch) && !private_fixture) {
llama_model_save_to_file(model_and_ctx.first.get(), path.c_str());
} else {
// Laguna and Inkling are not supported by the production
// model saver yet.
// Preserve the exact synthetic fixture metadata and attach the
// initialized model tensors so longhaul can be tested from a
// real file without broadening the saver API.
gguf_context_ptr fixture(gguf_init_empty());
// Model initialization normalizes the caller's GGUF context,
// so regenerate the exact private metadata for the file.
gguf_context_ptr fixture_metadata = get_gguf_ctx(arch, moe);
gguf_set_kv(fixture.get(), fixture_metadata.get());
for (const auto & item : llama_internal_get_tensor_map(model_and_ctx.first.get())) {
gguf_add_tensor(fixture.get(), item.second);
}
gguf_write_to_file(fixture.get(), path.c_str(), false);
}
}
}
llama_log_set(ud.original_logger.callback, ud.original_logger.user_data);
+180 -3
View File
@@ -1,11 +1,16 @@
#include "testing.h"
#include "../src/llama-longhaul.h"
#include "../src/llama-model.h"
#include "ggml-backend.h"
#include "llama-cpp.h"
#include <cmath>
#include <cstdio>
#include <memory>
#include <stdexcept>
#include <string>
#include <vector>
struct longhaul_fixture {
@@ -58,8 +63,7 @@ struct longhaul_fixture {
sources.push_back({ weights_b, 0, n_experts * expert_size, expert_size, 0 });
}
cache = std::make_unique<llama_longhaul_cache>(
std::move(files), std::move(sources), std::vector<llama_model_loader::longhaul_shard>{},
n_slots, n_experts, 1, false);
std::move(files), std::move(sources), n_slots, n_experts, 1);
}
~longhaul_fixture() {
@@ -129,6 +133,32 @@ static void test_multiple_sources(testing & t) {
t.assert_equal(uint8_t(34), fixture.slot_value(fixture.weights_b, remapped[1]));
}
static void test_concurrent_source_reads(testing & t) {
longhaul_fixture fixture(2, 4, true);
for (int iteration = 0; iteration < 64; ++iteration) {
const int32_t first = iteration % 2 == 0 ? 0 : 2;
const int32_t second = first + 1;
const auto remapped = fixture.remap({first, second});
if (!t.assert_equal(2u, remapped.size())) {
return;
}
t.assert_equal(
uint8_t(1 + first),
fixture.slot_value(fixture.weights_a, remapped[0]));
t.assert_equal(
uint8_t(33 + first),
fixture.slot_value(fixture.weights_b, remapped[0]));
t.assert_equal(
uint8_t(1 + second),
fixture.slot_value(fixture.weights_a, remapped[1]));
t.assert_equal(
uint8_t(33 + second),
fixture.slot_value(fixture.weights_b, remapped[1]));
}
}
static void test_invalid_ids(testing & t) {
longhaul_fixture fixture(2, 4);
@@ -153,8 +183,137 @@ static void test_read_failure_recovery(testing & t) {
t.assert_equal(uint8_t(1), fixture.slot_value(fixture.weights_a, remapped[0]));
}
struct cpu_decode_result {
std::vector<float> logits;
uint32_t capacity = 0;
uint64_t misses = 0;
uint64_t bytes_read = 0;
bool expert_buffer_is_host = false;
};
static cpu_decode_result decode_model(
const std::string & path,
llama_load_mode load_mode,
uint64_t cache_bytes,
int32_t n_gpu_layers,
bool incremental = false) {
llama_model_params model_params = llama_model_default_params();
model_params.n_gpu_layers = n_gpu_layers;
model_params.load_mode = load_mode;
model_params.longhaul_cache_bytes = cache_bytes;
model_params.use_extra_bufts = true;
llama_model_ptr model(llama_model_load_from_file(path.c_str(), model_params));
if (!model) {
throw std::runtime_error("failed to load CPU model: " + path);
}
llama_context_params context_params = llama_context_default_params();
context_params.n_ctx = 32;
context_params.n_batch = 8;
context_params.n_ubatch = 8;
context_params.n_threads = 2;
context_params.n_threads_batch = 2;
llama_context_ptr context(llama_init_from_model(model.get(), context_params));
if (!context) {
throw std::runtime_error("failed to create CPU context: " + path);
}
std::vector<llama_token> tokens = {1, 2, 3, 4, 5, 6, 7, 8};
if (incremental) {
for (size_t i = 0; i < tokens.size(); ++i) {
llama_batch batch = llama_batch_get_one(&tokens[i], 1);
if (llama_decode(context.get(), batch) != 0) {
throw std::runtime_error("failed incremental decode: " + path);
}
}
} else {
llama_batch batch = llama_batch_get_one(tokens.data(), tokens.size());
if (llama_decode(context.get(), batch) != 0) {
throw std::runtime_error("failed batched decode: " + path);
}
}
const int32_t n_vocab = llama_vocab_n_tokens(llama_model_get_vocab(model.get()));
const float * logits = llama_get_logits_ith(context.get(), -1);
if (!logits) {
throw std::runtime_error("CPU model produced no logits: " + path);
}
cpu_decode_result result;
result.logits.assign(logits, logits + n_vocab);
if (load_mode == LLAMA_LOAD_MODE_LONGHAUL) {
llama_longhaul_cache * cache = model->longhaul_cache();
if (!cache) {
throw std::runtime_error("longhaul cache was not created: " + path);
}
result.capacity = cache->capacity();
result.misses = cache->misses();
result.bytes_read = cache->bytes_read_count();
for (const auto & item : llama_internal_get_tensor_map(model.get())) {
const std::string & name = item.first;
if (name.find("ffn_") != std::string::npos &&
name.find("_exps.weight") != std::string::npos &&
item.second->ne[2] == result.capacity) {
result.expert_buffer_is_host = ggml_backend_buffer_is_host(item.second->buffer);
break;
}
}
}
return result;
}
static void test_model(
testing & t,
const std::string & path,
uint64_t cache_bytes,
int32_t n_gpu_layers,
uint32_t expected_capacity) {
const cpu_decode_result regular =
decode_model(path, LLAMA_LOAD_MODE_NONE, 0, n_gpu_layers);
const cpu_decode_result incremental =
decode_model(path, LLAMA_LOAD_MODE_NONE, 0, n_gpu_layers, true);
const cpu_decode_result longhaul =
decode_model(path, LLAMA_LOAD_MODE_LONGHAUL, cache_bytes, n_gpu_layers);
t.assert_equal(expected_capacity, longhaul.capacity);
t.assert_true("longhaul loaded at least one expert", longhaul.misses > 0);
t.assert_true("longhaul read expert bytes", longhaul.bytes_read > 0);
if (n_gpu_layers == 0) {
t.assert_true(
"streamed CPU experts use a directly writable host buffer",
longhaul.expert_buffer_is_host);
}
const auto assert_logits_close = [&](const char * name, const cpu_decode_result & actual) {
if (!t.assert_equal(regular.logits.size(), actual.logits.size())) {
return;
}
double squared_error = 0.0;
double squared_reference = 0.0;
for (size_t i = 0; i < regular.logits.size(); ++i) {
const double delta = double(regular.logits[i]) - double(actual.logits[i]);
squared_error += delta * delta;
squared_reference += double(regular.logits[i]) * double(regular.logits[i]);
}
const double nmse = squared_reference > 0.0
? squared_error / squared_reference
: squared_error;
t.assert_true(
std::string(name) + " logits NMSE = " + std::to_string(nmse),
std::isfinite(nmse) && nmse <= 1e-6);
};
assert_logits_close("incremental", incremental);
assert_logits_close("longhaul", longhaul);
}
int main(int argc, char ** argv) {
testing t;
llama_backend_init();
const char * verbose = getenv("LLAMA_TEST_VERBOSE");
if (verbose) {
@@ -164,14 +323,32 @@ int main(int argc, char ** argv) {
llama_log_set([](ggml_log_level, const char *, void *) {}, nullptr);
}
if ((argc == 4 || argc == 5) &&
(std::string(argv[1]) == "--cpu-model" ||
std::string(argv[1]) == "--metal-model")) {
const std::string path = argv[2];
const uint64_t cache_bytes = std::stoull(argv[3]);
const uint32_t expected_capacity = argc == 5 ? std::stoul(argv[4]) : 1;
const bool metal = std::string(argv[1]) == "--metal-model";
t.test(metal ? "metal_model" : "cpu_model", [&](testing & current) {
test_model(current, path, cache_bytes, metal ? 99 : 0, expected_capacity);
});
const int result = t.summary();
llama_backend_free();
return result;
}
if (argc > 1) {
t.set_filter(argv[1]);
}
t.test("batch_planning", test_batch_planning);
t.test("multiple_sources", test_multiple_sources);
t.test("concurrent_reads", test_concurrent_source_reads);
t.test("invalid_ids", test_invalid_ids);
t.test("read_failure", test_read_failure_recovery);
return t.summary();
const int result = t.summary();
llama_backend_free();
return result;
}
+1 -1
View File
@@ -61,7 +61,7 @@
| `--mmap, --no-mmap` | DEPRECATED in favor of `--load-mode`: whether to memory-map model. (if mmap disabled, slower load but may reduce pageouts if not using mlock)<br/>(env: LLAMA_ARG_MMAP) |
| `-dio, --direct-io, -ndio, --no-direct-io` | DEPRECATED in favor of `--load-mode`: use DirectIO if available<br/>(env: LLAMA_ARG_DIO) |
| `-lm, --load-mode MODE` | model loading mode (default: mmap)<br/>- none: no special loading mode<br/>- mmap: memory-map model (if mmap disabled, slower load but may reduce pageouts if not using mlock)<br/>- mlock: force system to keep model in RAM rather than swapping or compressing<br/>- mmap+mlock: mmap + force system to keep model in RAM rather than swapping or compressing<br/>- dio: use DirectIO if available<br/>- longhaul: stream routed MoE experts through a bounded cache<br/><br/>(env: LLAMA_ARG_LOAD_MODE) |
| `--longhaul` | stream routed Qwen3.5 MoE experts through a bounded Metal cache<br/>(env: LLAMA_ARG_LONGHAUL) |
| `--longhaul` | stream routed Qwen3.5 MoE, Laguna, or Inkling experts through a bounded CPU or Metal cache<br/>(env: LLAMA_ARG_LONGHAUL) |
| `--longhaul-cache N` | longhaul expert cache size in GiB<br/>(env: LLAMA_ARG_LONGHAUL_CACHE) |
| `--numa TYPE` | attempt optimizations that help on some NUMA systems<br/>- distribute: spread execution evenly over all nodes<br/>- isolate: only spawn threads on CPUs on the node that execution started on<br/>- numactl: use the CPU map provided by numactl<br/>if run without this previously, it is recommended to drop the system page cache before using this<br/>see https://github.com/ggml-org/llama.cpp/issues/1437<br/>(env: LLAMA_ARG_NUMA) |
| `-dev, --device <dev1,dev2,..>` | comma-separated list of devices to use for offloading (none = don't offload)<br/>use --list-devices to see a list of available devices<br/>(env: LLAMA_ARG_DEVICE) |
+1 -1
View File
@@ -144,7 +144,7 @@ llama-completion.exe -m models\gemma-1.1-7b-it.Q4_K_M.gguf --ignore-eos -n -1
| `--mmap, --no-mmap` | DEPRECATED in favor of `--load-mode`: whether to memory-map model. (if mmap disabled, slower load but may reduce pageouts if not using mlock)<br/>(env: LLAMA_ARG_MMAP) |
| `-dio, --direct-io, -ndio, --no-direct-io` | DEPRECATED in favor of `--load-mode`: use DirectIO if available<br/>(env: LLAMA_ARG_DIO) |
| `-lm, --load-mode MODE` | model loading mode (default: mmap)<br/>- none: no special loading mode<br/>- mmap: memory-map model (if mmap disabled, slower load but may reduce pageouts if not using mlock)<br/>- mlock: force system to keep model in RAM rather than swapping or compressing<br/>- mmap+mlock: mmap + force system to keep model in RAM rather than swapping or compressing<br/>- dio: use DirectIO if available<br/>- longhaul: stream routed MoE experts through a bounded cache<br/><br/>(env: LLAMA_ARG_LOAD_MODE) |
| `--longhaul` | stream routed Qwen3.5 MoE experts through a bounded Metal cache<br/>(env: LLAMA_ARG_LONGHAUL) |
| `--longhaul` | stream routed Qwen3.5 MoE, Laguna, or Inkling experts through a bounded CPU or Metal cache<br/>(env: LLAMA_ARG_LONGHAUL) |
| `--longhaul-cache N` | longhaul expert cache size in GiB<br/>(env: LLAMA_ARG_LONGHAUL_CACHE) |
| `--numa TYPE` | attempt optimizations that help on some NUMA systems<br/>- distribute: spread execution evenly over all nodes<br/>- isolate: only spawn threads on CPUs on the node that execution started on<br/>- numactl: use the CPU map provided by numactl<br/>if run without this previously, it is recommended to drop the system page cache before using this<br/>see https://github.com/ggml-org/llama.cpp/issues/1437<br/>(env: LLAMA_ARG_NUMA) |
| `-dev, --device <dev1,dev2,..>` | comma-separated list of devices to use for offloading (none = don't offload)<br/>use --list-devices to see a list of available devices<br/>(env: LLAMA_ARG_DEVICE) |
+1 -11
View File
@@ -36,17 +36,6 @@ flowchart TD
By default, `ggml-rpc-server` exposes all available accelerator devices on the host.
If there are no accelerators, it exposes a single `CPU` device.
For server-resident longhaul MoE paging, place the same GGUF shards on the RPC
host and point the server at their directory:
```sh
$ bin/ggml-rpc-server --device MTL0 --longhaul-root /path/to/model-directory
```
The client can then use `--rpc`, `--longhaul`, and `--longhaul-cache` together.
RPC longhaul v1 requires one remote Metal device. Expert cache misses are read
from the RPC host's local files rather than uploaded by the client.
## Usage
### Remote hosts
@@ -118,3 +107,4 @@ Use the `GGML_RPC_DEBUG` environment variable to enable debug messages from `ggm
```bash
$ GGML_RPC_DEBUG=1 bin/ggml-rpc-server
```
+3 -35
View File
@@ -13,7 +13,6 @@
#include <algorithm>
#include <clocale>
#include <codecvt>
#include <cstring>
#include <filesystem>
#include <regex>
#include <stdio.h>
@@ -174,7 +173,6 @@ struct rpc_server_params {
std::string host = "127.0.0.1";
int port = 50052;
bool use_cache = false;
std::string longhaul_root;
int n_threads = std::max(1U, std::thread::hardware_concurrency()/2);
std::vector<std::string> devices;
};
@@ -188,7 +186,6 @@ static void print_usage(int /*argc*/, char ** argv, rpc_server_params params) {
fprintf(stderr, " -H, --host HOST host to bind to (default: %s)\n", params.host.c_str());
fprintf(stderr, " -p, --port PORT port to bind to (default: %d)\n", params.port);
fprintf(stderr, " -c, --cache enable local file cache\n");
fprintf(stderr, " --longhaul-root PATH serve longhaul expert data from this model directory\n");
fprintf(stderr, "\n");
}
@@ -236,11 +233,6 @@ static bool rpc_server_params_parse(int argc, char ** argv, rpc_server_params &
}
} else if (arg == "-c" || arg == "--cache") {
params.use_cache = true;
} else if (arg == "--longhaul-root") {
if (++i >= argc) {
return false;
}
params.longhaul_root = argv[i];
} else if (arg == "-h" || arg == "--help") {
print_usage(argc, argv, params);
exit(0);
@@ -321,23 +313,6 @@ int main(int argc, char * argv[]) {
fprintf(stderr, "No devices found\n");
return 1;
}
if (!params.longhaul_root.empty()) {
std::error_code ec;
const auto root = std::filesystem::canonical(params.longhaul_root, ec);
if (ec || !std::filesystem::is_directory(root, ec)) {
fprintf(stderr, "Invalid longhaul root: %s\n", params.longhaul_root.c_str());
return 1;
}
params.longhaul_root = root.string();
for (auto * dev : devices) {
auto * dev_reg = ggml_backend_dev_backend_reg(dev);
if (!dev_reg || strcmp(ggml_backend_reg_name(dev_reg), "MTL") != 0) {
fprintf(stderr, "--longhaul-root currently requires Metal devices\n");
return 1;
}
}
}
std::string endpoint = params.host + ":" + std::to_string(params.port);
const char * cache_dir = nullptr;
std::string cache_dir_str;
@@ -356,19 +331,12 @@ int main(int argc, char * argv[]) {
return 1;
}
auto start_server_fn = (decltype(ggml_backend_rpc_start_server_with_options)*)
ggml_backend_reg_get_proc_address(reg, "ggml_backend_rpc_start_server_with_options");
auto start_server_fn = (decltype(ggml_backend_rpc_start_server)*) ggml_backend_reg_get_proc_address(reg, "ggml_backend_rpc_start_server");
if (!start_server_fn) {
fprintf(stderr, "Failed to obtain RPC backend start server function with options\n");
fprintf(stderr, "Failed to obtain RPC backend start server function\n");
return 1;
}
start_server_fn(
endpoint.c_str(),
cache_dir,
params.longhaul_root.empty() ? nullptr : params.longhaul_root.c_str(),
params.n_threads,
devices.size(),
devices.data());
start_server_fn(endpoint.c_str(), cache_dir, params.n_threads, devices.size(), devices.data());
return 0;
}
+1 -1
View File
@@ -78,7 +78,7 @@ For the full list of features, please refer to [server's changelog](https://gith
| `--mmap, --no-mmap` | DEPRECATED in favor of `--load-mode`: whether to memory-map model. (if mmap disabled, slower load but may reduce pageouts if not using mlock)<br/>(env: LLAMA_ARG_MMAP) |
| `-dio, --direct-io, -ndio, --no-direct-io` | DEPRECATED in favor of `--load-mode`: use DirectIO if available<br/>(env: LLAMA_ARG_DIO) |
| `-lm, --load-mode MODE` | model loading mode (default: mmap)<br/>- none: no special loading mode<br/>- mmap: memory-map model (if mmap disabled, slower load but may reduce pageouts if not using mlock)<br/>- mlock: force system to keep model in RAM rather than swapping or compressing<br/>- mmap+mlock: mmap + force system to keep model in RAM rather than swapping or compressing<br/>- dio: use DirectIO if available<br/>- longhaul: stream routed MoE experts through a bounded cache<br/><br/>(env: LLAMA_ARG_LOAD_MODE) |
| `--longhaul` | stream routed Qwen3.5 MoE experts through a bounded Metal cache<br/>(env: LLAMA_ARG_LONGHAUL) |
| `--longhaul` | stream routed Qwen3.5 MoE, Laguna, or Inkling experts through a bounded CPU or Metal cache<br/>(env: LLAMA_ARG_LONGHAUL) |
| `--longhaul-cache N` | longhaul expert cache size in GiB<br/>(env: LLAMA_ARG_LONGHAUL_CACHE) |
| `--numa TYPE` | attempt optimizations that help on some NUMA systems<br/>- distribute: spread execution evenly over all nodes<br/>- isolate: only spawn threads on CPUs on the node that execution started on<br/>- numactl: use the CPU map provided by numactl<br/>if run without this previously, it is recommended to drop the system page cache before using this<br/>see https://github.com/ggml-org/llama.cpp/issues/1437<br/>(env: LLAMA_ARG_NUMA) |
| `-dev, --device <dev1,dev2,..>` | comma-separated list of devices to use for offloading (none = don't offload)<br/>use --list-devices to see a list of available devices<br/>(env: LLAMA_ARG_DEVICE) |