Thanks to TheBloke for preparing an amazing README on how to use GGUF models:
About GGUF
GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
Here is an incomplete list of clients and libraries that are known to support GGUF:
llama.cpp. The source project for GGUF. Offers a CLI and a server option.
text-generation-webui, the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
KoboldCpp, a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
GPT4All, a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
LM Studio, an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
LoLLMS Web UI, a great web UI with many interesting and unique features, including a full model library for easy model selection.
Faraday.dev, an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
llama-cpp-python, a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
candle, a Rust ML framework with a focus on performance, including GPU support, and ease of use.
ctransformers, a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
Explanation of quantisation methods
Click to see details
The new methods available are:
GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
How to download GGUF files
Note for manual downloaders: You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
Change -ngl 32 to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
Change -c 32768 to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
If you want to have a chat-style conversation, replace the -p <PROMPT> argument with -i -ins
You can use GGUF models from Python using the llama-cpp-python or ctransformers libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.
How to load this model in Python code, using llama-cpp-python
Run one of the following commands, according to your system:
shell
1# Base ctransformers with no GPU acceleration2pip install llama-cpp-python
3# With NVidia CUDA acceleration4CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
5# Or with OpenBLAS acceleration6CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
7# Or with CLBLast acceleration8CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
9# Or with AMD ROCm GPU acceleration (Linux only)10CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
11# Or with Metal GPU acceleration for macOS systems only12CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
1314# In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:15$env:CMAKE_ARGS ="-DLLAMA_OPENBLAS=on"16pip install llama-cpp-python
Simple llama-cpp-python example code
python
1from llama_cpp import Llama
23# Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.4llm = Llama(5 model_path="./Yarn-Mistral-7b-64k-Mistral-7B-Instruct-v0.1-GGUF.Q4_K_M.gguf",# Download the model file first6 n_ctx=32768,# The max sequence length to use - note that longer sequence lengths require much more resources7 n_threads=8,# The number of CPU threads to use, tailor to your system and the resulting performance8 n_gpu_layers=35# The number of layers to offload to GPU, if you have GPU acceleration available9)1011# Simple inference example12output = llm(13 "<|im_start|>system
14{system_message}<|im_end|>15<|im_start|>user
16{prompt}<|im_end|>17<|im_start|>assistant",# Prompt18 max_tokens=512,# Generate up to 512 tokens19 stop=["</s>"],# Example stop token - not necessarily correct for this specific model! Please check before using.20 echo=True# Whether to echo the prompt21)2223# Chat Completion API2425llm = Llama(model_path="./Yarn-Mistral-7b-64k-Mistral-7B-Instruct-v0.1-GGUF.Q4_K_M.gguf", chat_format="llama-2")# Set chat_format according to the model you are using26llm.create_chat_completion(27 messages =[28{"role":"system","content":"You are a story writing assistant."},29{30"role":"user",31"content":"Write a story about llamas."32}33]34)
How to use with LangChain
Here are guides on using llama-cpp-python and ctransformers with LangChain:
