Welcome to the llama-cpp-python wiki :)

This wiki provides structured, source-code-aligned documentation for the public APIs, core classes, modules, examples, and development notes of llama-cpp-python.

The documentation is maintained with the help of LLMs, but the source of truth is always the latest code in llama_cpp/.

---

Start here if you are installing or rebuilding llama-cpp-python.

Page	Description
[install|Installation]	Source installation guide covering Python setup, CMake options, llama.cpp backend selection, hardware acceleration, rebuilds, and verification.

---

Start here if you are using llama-cpp-python directly.

Page	Description
[core/Llama|Llama]	Main high-level interface for loading GGUF models, running completions, chat completions, tokenization, embeddings, and model configuration.

---

These pages document major source modules and related classes.

Page	Description
[modules/LlamaCache|Llama Cache]	Cache interfaces and implementations for reusing model state across repeated prompts.
[modules/LlamaEmbedding|Llama Embedding]	Embedding-related APIs and usage patterns.
[modules/LlamaGrammar|Llama Grammar]	Provides grammar utilities for constrained generation.
[modules/LlamaSpeculative|Llama Speculative Decoding]	Draft model interfaces and prompt-based speculative decoding helpers.
[modules/Logger|Logger]	provides configuration for runtime logging in llama-cpp-python, wrapping the native ggml/llama.cpp logging infrastructure. It controls verbosity levels, output streams, substring filtering, and callback integration, allowing fine-grained control over diagnostic and informational output from the underlying bindings.

---

This section contains maintainer-facing development notes, workflows, and LLM-assisted helper tools for working on llama-cpp-python.

Page	Description
[development/Git Commit Generation Agent]	Helper workflow for generating clear, structured, and source-aware Git commit messages.

---

These pages define how the wiki should be written, updated, and reviewed.

Page	Description
[SCHEMA|Wiki Schema]	Documentation schema and rules for LLM-maintained wiki pages.
[contributing-to-wiki|Contributing to the Wiki]	Contribution guide for writing and updating wiki documentation.

---

If you are new to this wiki, read the pages in this order:

1. [install|Installation]
2. [core/Llama|Llama]
3. [modules/LlamaCache|Llama Cache]
4. [modules/LlamaEmbedding|Llama Embedding]
5. [modules/LlamaGrammar|Llama Grammar]
6. [modules/LlamaSpeculative|Llama Speculative Decoding]
7. [modules/Logger|Logger]
8. [development/Git Commit Generation Agent]

If you are contributing documentation, start with:

1. [SCHEMA|Wiki Schema]
2. [contributing-to-wiki|Contributing to the Wiki]

---

The wiki is still being expanded.

Currently available pages:

• install.md
• core/Llama.md
• modules/LlamaCache.md
• modules/LlamaEmbedding.md
• modules/LlamaGrammar.md
• modules/LlamaSpeculative.md
• modules/Logger.md
• development/git-commit-generation-agent.md
• SCHEMA.md
• contributing-to-wiki.md

Some planned pages may already exist as empty placeholder files. Empty pages are intentionally not linked from this index until they are completed.

---

Future documentation may cover:

• Chat formats and chat handlers
• Low-level ctypes bindings
• Multimodal APIs
• Type definitions and structured return values
• Troubleshooting
• Runnable examples
• Development notes

---

This wiki follows a few core rules:

• Source code is the source of truth.
• Parameters, defaults, and behavior must match the latest implementation.
• Examples should be complete and runnable.
• Deprecated or legacy APIs should be clearly marked.
• Internal implementation details should not be presented as stable public APIs.
• Pages should be concise, practical, and easy to navigate.

---

• GitHub: llama-cpp-python
• Installation guide: install
• Wiki schema: SCHEMA
• Contribution guide: contributing-to-wiki