These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit d0cee0d
They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
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
Refer to the Provided Files table below to see what files use which methods, and how.
very large, extremely low quality loss - not recommended
Note: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
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:
LM Studio
LoLLMS Web UI
Faraday.dev
In text-generation-webui
Under Download Model, you can enter the model repo: TheBloke/firefly-llama2-7B-chat-GGUF and below it, a specific filename to download, such as: firefly-llama2-7b-chat.Q4_K_M.gguf.
Then click Download.
On the command line, including multiple files at once
I recommend using the huggingface-hub Python library:
pip3 install huggingface-hub
Then you can download any individual model file to the current directory, at high speed, with a command like this:
Change -ngl 32 to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
Change -c 4096 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.
If you want to have a chat-style conversation, replace the -p <PROMPT> argument with -i -ins
How to load this model in Python code, using ctransformers
First install the package
Run one of the following commands, according to your system:
shell
1# Base ctransformers with no GPU acceleration2pip install ctransformers
3# Or with CUDA GPU acceleration4pip install ctransformers[cuda]5# Or with AMD ROCm GPU acceleration (Linux only)6CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
7# Or with Metal GPU acceleration for macOS systems only8CT_METAL=1 pip install ctransformers --no-binary ctransformers
Simple ctransformers example code
python
1from ctransformers import AutoModelForCausalLM
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 = AutoModelForCausalLM.from_pretrained("TheBloke/firefly-llama2-7B-chat-GGUF", model_file="firefly-llama2-7b-chat.Q4_K_M.gguf", model_type="llama", gpu_layers=50)56print(llm("AI is going to"))
How to use with LangChain
Here are guides on using llama-cpp-python and ctransformers with LangChain:
I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
Patreon special mentions: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
Thank you to all my generous patrons and donaters!
And thank you again to a16z for their generous grant.
Original model card: YeungNLP's Firefly Llama2 7B Chat
1Instruction：
2```
3夕阳西下时分，天空渐渐染上了一层橘红色。远处的山峦被映照得金光闪烁，仿佛是一幅绚烂多彩的水彩画。在山脚下的村庄里，炊烟袅袅升起，伴随着人们的欢声笑语和犬吠鸟鸣，构成一幅和谐而美好的画面。
45此时此刻，太阳已经落到了地平线以下，但它的余晖仍然洒满了大地。微风拂过树梢，带来阵阵清凉的风感；阳光透过云朵照射下来，形成一道道美丽的彩虹。在这片宁静祥和的氛围中，人们开始享受这美妙的时刻，欣赏着这片美丽的天空和大地的奇妙组合。
67当夜幕降临的时候，整个世界都变得安静了起来。月亮高高地挂在天空中，月光如水般温柔地倾泻而下，给大地带来了无限的光明与温暖。这时，你可以听到虫儿们发出的细碎的声音，感受到大自然的神奇魅力。在这个时候，你会感到自己与大自然融为一体，感受生命的真谛。
8```
910把上面的中文翻译成英文。
1112Output：
13As the sun sets in the west, the sky gradually turns a shade of orange. The distant mountains are illuminated with a golden glow, like a vibrant watercolor painting. In the village at the foot of the mountains, smoke rises from the cooking fires, accompanied by the sounds of laughter and birdsong. This creates a harmonious and beautiful scene.
1415At this moment, the sun has already set below the horizon, but its rays still illuminate the earth. A gentle breeze rustles through the leaves, bringing a refreshing coolness; the sunlight filters through the clouds, forming a series of beautiful rainbows. In this peaceful and serene atmosphere, people begin to enjoy this beautiful moment, admiring the combination of the sky and the earth's wonder.
1617As night falls, the world becomes quiet. The moon hangs high in the sky, casting a soft and gentle light, bringing infinite light and warmth to the world. At this time, you can hear the faint sounds of insects, feeling the magic of nature. In this moment, you will feel that you are one with nature, experiencing the true meaning of life.
181920Instruction:
21```
22寻寻觅觅，冷冷清清，凄凄惨惨戚戚。
23乍暖还寒时候，最难将息。
24三杯两盏淡酒，怎敌他、晚来风急！
25雁过也，正伤心，却是旧时相识。
26满地黄花堆积，憔悴损，如今有谁堪摘？
27守着窗儿，独自怎生得黑！
28梧桐更兼细雨，到黄昏、点点滴滴。
29这次第，怎一个愁字了得！
30```
3132把上面的诗词翻译成英文
3334Output:
35Wandering, cold, and lonely,
36It's hard to find a place to rest.
37Three cups of wine, two lamps,
38How can I resist the wind that's blowing?
3940The swallows are flying by,
41And it's a sad reminder of old friends.
42Yellow flowers are scattered everywhere,
43Withered and damaged, who can pick them up?
4445I'm standing by the window,
46Watching the rain fall, one drop at a time.
47This time, it's a heavy burden,
48Full of sorrow and regret.
