xllamacpp 0.2.14

A Python wrapper of llama.cpp

xllamacpp - a Python wrapper of llama.cpp

This project forks from cyllama and provides a Python wrapper for @ggerganov's llama.cpp which is likely the most active open-source compiled LLM inference engine.

Compare to llama-cpp-python

The following table provide an overview of the current implementations / features:

implementations / features	xllamacpp	llama-cpp-python
Wrapper-type	cython	ctypes
API	Server & Params API	Llama API
Server implementation	C++	Python through wrapped LLama API
Continuous batching	yes	no
Thread safe	yes	no
Release package	prebuilt	build during installation

It goes without saying that any help / collaboration / contributions to accelerate the above would be welcome!

Wrapping Guidelines

As the intent is to provide a very thin wrapping layer and play to the strengths of the original c++ library as well as python, the approach to wrapping intentionally adopts the following guidelines:

• In general, key structs are implemented as cython extension classses with related functions implemented as methods of said classes.

• Be as consistent as possible with llama.cpp's naming of its api elements, except when it makes sense to shorten functions names which are used as methods.

• Minimize non-wrapper python code.

Usage

Here is a simple example of how to use xllamacpp to get embeddings for a list of texts. For this example, you'll need an embedding model like Qwen3-Embedding-0.6B-Q8_0.gguf.

import xllamacpp as xlc

params = xlc.CommonParams()

params.model.path = "Qwen3-Embedding-0.6B-Q8_0.gguf"
params.embedding = True
params.pooling_type = xlc.llama_pooling_type.LLAMA_POOLING_TYPE_LAST

server = xlc.Server(params)

embedding_input = {
    "input": [
        "I believe the meaning of life is",
        "This is a test",
    ],
    "model": "My Qwen3 Model",
}

result = server.handle_embeddings(embedding_input)

print(result)

Output:

{'data': [{'embedding': [-0.006413215305656195,
                         -0.05906733125448227,
                         ...
                         -0.05887744203209877],
           'index': 0,
           'object': 'embedding'},
          {'embedding': [0.041170503944158554,
                         -0.004472420550882816,
                         ...
                         0.008314250037074089],
           'index': 1,
           'object': 'embedding'}],
 'model': 'My Qwen3 Model',
 'object': 'list',
 'usage': {'prompt_tokens': 11, 'total_tokens': 11}}

OpenAI API Compatible HTTP Server

The server provides OpenAI API compatible endpoints. For a complete list of available API endpoints, see the llama.cpp server documentation. You can use the OpenAI Python client:

import xllamacpp as xlc
from openai import OpenAI

# Start server
params = xlc.CommonParams()
params.model.path = "Llama-3.2-1B-Instruct-Q8_0.gguf"
server = xlc.Server(params)

# Connect using OpenAI client
client = OpenAI(
    base_url=server.listening_address + "/v1",
    api_key="not-required"  # No API key needed for local server
)

# Make chat completion request
response = client.chat.completions.create(
    model="local-model",
    messages=[{"role": "user", "content": "What is the capital of France?"}],
    max_tokens=10
)

print(response.choices[0].message.content)

Prerequisites for Prebuilt Wheels

Before pip installing xllamacpp, please ensure your system meets the following requirements based on your build type:

• CPU (aarch64):

  • Requires ARMv8-A or later architecture
  • For best performance, build from source if your CPU supports advanced instruction sets

• CUDA (Linux):

  • Requires glibc 2.35 or later
  • Compatible NVIDIA GPU with appropriate drivers (CUDA 12.4 or 12.8)

• ROCm (Linux):

  • Requires glibc 2.35 or later
  • Requires gcc 10 or later (ROCm libraries have this dependency)
  • Compatible AMD GPU with ROCm support (ROCm 6.3.4 or 6.4.1)

• Vulkan (Linux/Windows, Intel/AMD/NVIDIA where supported):

  • Install the Vulkan SDK and GPU drivers with Vulkan support
  • Linux users may need distro packages and the LunarG SDK
  • macOS Intel is supported via Vulkan; Apple Silicon Vulkan is not supported in this project

Install

Note on Performance and Compatibility

For maximum performance, you can build xllamacpp from source to optimize for your specific native CPU architecture. The pre-built wheels are designed for broad compatibility.

Specifically, the aarch64 wheels are built for the armv8-a architecture. This ensures they run on a wide range of ARM64 devices, but it means that more advanced CPU instruction sets (like SVE) are not enabled. If your CPU supports these advanced features, building from source will provide better performance.

• From pypi for CPU or Mac:

pip install -U xllamacpp

• From github pypi for CUDA (use --force-reinstall to replace the installed CPU version):

  • CUDA 12.4

    pip install xllamacpp --force-reinstall --index-url https://xorbitsai.github.io/xllamacpp/whl/cu124
    

  • CUDA 12.8

    pip install xllamacpp --force-reinstall --index-url https://xorbitsai.github.io/xllamacpp/whl/cu128
    

• From github pypi for HIP AMD GPU (use --force-reinstall to replace the installed CPU version):

  • ROCm 6.3.4

    pip install xllamacpp --force-reinstall --index-url https://xorbitsai.github.io/xllamacpp/whl/rocm-6.3.4
    

  • ROCm 6.4.1

    pip install xllamacpp --force-reinstall --index-url https://xorbitsai.github.io/xllamacpp/whl/rocm-6.4.1
    

• From github pypi for Vulkan (use --force-reinstall to replace the installed CPU version):

  pip install xllamacpp --force-reinstall --index-url https://xorbitsai.github.io/xllamacpp/whl/vulkan
  

Build from Source

(Optional) Preparation

• CUDA

  This provides GPU acceleration using an NVIDIA GPU. Make sure to have the CUDA toolkit installed.

  Download directly from NVIDIA

  You may find the official downloads here: NVIDIA developer site.

  Compile and run inside a Fedora Toolbox Container

  We also have a guide for setting up CUDA toolkit in a Fedora toolbox container.

  Recommended for:

  • Necessary for users of Atomic Desktops for Fedora; such as: Silverblue and Kinoite.
    • (there are no supported CUDA packages for these systems)
  • Necessary for users that have a host that is not a: Supported Nvidia CUDA Release Platform.
    • (for example, you may have Fedora 42 Beta as your your host operating system)
  • Convenient For those running Fedora Workstation or Fedora KDE Plasma Desktop, and want to keep their host system clean.
  • Optionally toolbox packages are available: Arch Linux, Red Hat Enterprise Linux >= 8.5, or Ubuntu

• HIP

  This provides GPU acceleration on HIP-supported AMD GPUs. Make sure to have ROCm installed. You can download it from your Linux distro's package manager or from here: ROCm Quick Start (Linux).

  Or you can try to build inside the ROCm docker container.

• Vulkan

  Install the Vulkan SDK and drivers for your platform.

  • Linux: use your distro packages and/or the LunarG Vulkan SDK.
  • Windows: install LunarG Vulkan SDK and vendor GPU drivers.
  • macOS: Intel only; Apple Silicon is not supported for Vulkan in this project.

Build xllamacpp

1. A recent version of python3 (testing on python 3.12)

2. Install Rust toolchain (required for building):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

For more installation options, see the rustup installation guide.

3. Git clone the latest version of xllamacpp:

git clone [e-mail]:xorbitsai/xllamacpp.git
cd xllamacpp
git submodule init
git submodule update

4. Install dependencies of cython, setuptools, and pytest for testing:

pip install -r requirements.txt

5. Select backend via environment and build. Examples:

   • CPU (default):

     make
     

   • CUDA:

     export XLLAMACPP_BUILD_CUDA=1
     make
     

   • HIP (AMD):

     export XLLAMACPP_BUILD_HIP=1
     make
     

   • Vulkan:

     export XLLAMACPP_BUILD_VULKAN=1
     make
     

   • Enable BLAS (optional):

     export CMAKE_ARGS="-DGGML_BLAS=ON -DGGML_BLAS_VENDOR=OpenBLAS"
     make
     

Testing

The tests directory in this repo provides extensive examples of using xllamacpp.

However, as a first step, you should download a smallish llm in the .gguf model from huggingface. A good model to start and which is assumed by tests is Llama-3.2-1B-Instruct-Q8_0.gguf. xllamacpp expects models to be stored in a models folder in the cloned xllamacpp directory. So to create the models directory if doesn't exist and download this model, you can just type:

make download

This basically just does:

cd xllamacpp
mkdir models && cd models
wget https://huggingface.co/bartowski/Llama-3.2-1B-Instruct-GGUF/resolve/main/Llama-3.2-1B-Instruct-Q8_0.gguf 

Now you can test it using llama-cli or llama-simple:

bin/llama-cli -c 512 -n 32 -m models/Llama-3.2-1B-Instruct-Q8_0.gguf \
 -p "Is mathematics discovered or invented?"

You can also run the test suite with pytest by typing pytest or:

make test