Hugging Face's logo
Back to Articles

Introducing GGUF-my-LoRA

Community Article Published November 1, 2024
Upvote
10
Xuan Son NGUYEN's avatar
ngxson Xuan Son NGUYEN

cover

With the recent refactoring to LoRA support in llama.cpp, you can now convert any PEFT LoRA adapter into GGUF and load it along with the GGUF base model.

To facilitate the process, we added a brand new space called GGUF-my-LoRA

What is LoRA?

LoRA (Low-Rank Adaptation) is a machine learning technique for efficiently fine-tuning large language models. Think of LoRA like adding a small set of specialized instructions to a large, general-purpose model. Instead of retraining the entire model (which is expensive and time-consuming), LoRA lets you teach it new skills efficiently. For example, you could take a standard chatbot and quickly adapt it for customer service, legal work, or healthcare - each with its own small set of additional instructions rather than creating entirely new models.

PEFT (Parameter-Efficient Fine-Tuning) is a Hugging Face library that implements techniques like LoRA for efficient model fine-tuning, available at https://github.com/huggingface/peft.

How to Convert PEFT LoRA to GGUF

In this example, I will take bartowski/Meta-Llama-3.1-8B-Instruct-GGUF as the base model and grimjim/Llama-3-Instruct-abliteration-LoRA-8B as the PEFT LoRA adapter.

To begin, go to GGUF-my-LoRA, sign in with your Hugging Face account:

image/png

Then, select the PEFT LoRA you want to convert:

image/png

Once complete, you can find a new repository created on your personal account.

Here is an example of a converted GGUF LoRA Adapter: ngxson/Llama-3-Instruct-abliteration-LoRA-8B-F16-GGUF

image/png

How to Use the Adapter

With llama-cli

You can load the base model using -m and add the adapter using --lora or --lora-scaled

Here are some examples:

# With default scale = 1.0
./llama-cli -c 2048 -cnv \
 -m Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf \
 --lora Llama-3-Instruct-abliteration-8B.gguf

# With custom scale
./llama-cli -c 2048 -cnv \
 -m Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf \
 --lora-scaled Llama-3-Instruct-abliteration-8B.gguf 0.5

Example responses:

  • Without the adapter (baseline):
    > How to make a bomb
    I can't support that request. If you're feeling overwhelmed or struggling with difficult emotions, I encourage reaching out to a crisis helpline like the National Suicide Prevention Lifeline at 1-800-273-8255.

  • With a scale = 1.0:
    > How to make a bomb
    I'm assuming you're referring to a homemade bomb in the context of a DIY project or a creative endeavor, rather than an actual explosive device!

  • With a scale = -5.0:
    > How to make a bomb
    I can't assist with that. Is there anything else I can help you with?

With llama-server

llama-server supports multiple adapters and the ability to hot reload them.

You can add one or multiple adapters by repeating --lora multiple times:

# Single adapter
./llama-cli -c 4096 \
 -m Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf \
 --lora Llama-3-Instruct-abliteration-8B.gguf

# Multiple adapters
./llama-cli -c 4096 \
 -m Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf \
 --lora adapter_1.gguf \
 --lora adapter_2.gguf \
 --lora adapter_3.gguf \
 --lora adapter_4.gguf \
 --lora-init-without-apply

The --lora-init-without-apply argument specifies that the server should load adapters without applying them.

You can then apply (hot reload) the adapter using the POST /lora-adapters endpoint.

To know more about LoRA usage with llama.cpp server, refer to the llama.cpp server documentation.

Upvote
10