|
Download README.md from TheBloke/based-7B-GGML: direct link, hf CLI and curl.
- Browser
- Download file 11 kB
-
https://huggingface.co/TheBloke/based-7B-GGML/resolve/main/README.md
- Command line
-
hf download hf://TheBloke/based-7B-GGML/README.md
-
curl -L -o README.md https://huggingface.co/TheBloke/based-7B-GGML/resolve/main/README.md
11 kB
| inference: false | |
| license: other | |
| <!-- header start --> | |
| <div style="width: 100%;"> | |
| <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;"> | |
| </div> | |
| <div style="display: flex; justify-content: space-between; width: 100%;"> | |
| <div style="display: flex; flex-direction: column; align-items: flex-start;"> | |
| <p><a href="https://discord.gg/Jq4vkcDakD">Chat & support: my new Discord server</a></p> | |
| </div> | |
| <div style="display: flex; flex-direction: column; align-items: flex-end;"> | |
| <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p> | |
| </div> | |
| </div> | |
| <!-- header end --> | |
| # Eric Hartford's Based 7B GGML | |
| These files are GGML format model files for [Eric Hartford's Based 7B](https://huggingface.co/ehartford/based-7b). | |
| GGML files are for CPU + GPU inference using [llama.cpp](https://github.com/ggerganov/llama.cpp) and libraries and UIs which support this format, such as: | |
| * [text-generation-webui](https://github.com/oobabooga/text-generation-webui) | |
| * [KoboldCpp](https://github.com/LostRuins/koboldcpp) | |
| * [ParisNeo/GPT4All-UI](https://github.com/ParisNeo/gpt4all-ui) | |
| * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) | |
| * [ctransformers](https://github.com/marella/ctransformers) | |
| ## Repositories available | |
| * [4-bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/based-7B-GPTQ) | |
| * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/based-7B-GGML) | |
| * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/ehartford/based-7b) | |
| ## Prompt template | |
| ``` | |
| You are an an AI who shares your opinions, thoughts, and feelings. | |
| USER: prompt goes here | |
| ASSISTANT: | |
| ``` | |
| <!-- compatibility_ggml start --> | |
| ## Compatibility | |
| ### Original llama.cpp quant methods: `q4_0, q4_1, q5_0, q5_1, q8_0` | |
| I have quantized these 'original' quantisation methods using an older version of llama.cpp so that they remain compatible with llama.cpp as of May 19th, commit `2d5db48`. | |
| They should be compatible with all current UIs and libraries that use llama.cpp, such as those listed at the top of this README. | |
| ### New k-quant methods: `q2_K, q3_K_S, q3_K_M, q3_K_L, q4_K_S, q4_K_M, q5_K_S, q6_K` | |
| These new quantisation methods are only compatible with llama.cpp as of June 6th, commit `2d43387`. | |
| They will NOT be compatible with koboldcpp, text-generation-ui, and other UIs and libraries yet. Support is expected to come over the next few days. | |
| ## Explanation of the new k-quant methods | |
| 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 | |
| * GGML_TYPE_Q8_K - "type-0" 8-bit quantization. Only used for quantizing intermediate results. The difference to the existing Q8_0 is that the block size is 256. All 2-6 bit dot products are implemented for this quantization type. | |
| Refer to the Provided Files table below to see what files use which methods, and how. | |
| <!-- compatibility_ggml end --> | |
| ## Provided files | |
| | Name | Quant method | Bits | Size | Max RAM required | Use case | | |
| | ---- | ---- | ---- | ---- | ---- | ----- | | |
| | based-7b.ggmlv3.q2_K.bin | q2_K | 2 | 2.80 GB | 5.30 GB | New k-quant method. Uses GGML_TYPE_Q4_K for the attention.vw and feed_forward.w2 tensors, GGML_TYPE_Q2_K for the other tensors. | | |
| | based-7b.ggmlv3.q3_K_L.bin | q3_K_L | 3 | 3.55 GB | 6.05 GB | New k-quant method. Uses GGML_TYPE_Q5_K for the attention.wv, attention.wo, and feed_forward.w2 tensors, else GGML_TYPE_Q3_K | | |
| | based-7b.ggmlv3.q3_K_M.bin | q3_K_M | 3 | 3.23 GB | 5.73 GB | New k-quant method. Uses GGML_TYPE_Q4_K for the attention.wv, attention.wo, and feed_forward.w2 tensors, else GGML_TYPE_Q3_K | | |
| | based-7b.ggmlv3.q3_K_S.bin | q3_K_S | 3 | 2.90 GB | 5.40 GB | New k-quant method. Uses GGML_TYPE_Q3_K for all tensors | | |
| | based-7b.ggmlv3.q4_K_M.bin | q4_K_M | 4 | 4.05 GB | 6.55 GB | New k-quant method. Uses GGML_TYPE_Q6_K for half of the attention.wv and feed_forward.w2 tensors, else GGML_TYPE_Q4_K | | |
| | based-7b.ggmlv3.q4_K_S.bin | q4_K_S | 4 | 3.79 GB | 6.29 GB | New k-quant method. Uses GGML_TYPE_Q4_K for all tensors | | |
| | based-7b.ggmlv3.q5_K_M.bin | q5_K_M | 5 | 4.77 GB | 7.27 GB | New k-quant method. Uses GGML_TYPE_Q6_K for half of the attention.wv and feed_forward.w2 tensors, else GGML_TYPE_Q5_K | | |
| | based-7b.ggmlv3.q5_K_S.bin | q5_K_S | 5 | 4.63 GB | 7.13 GB | New k-quant method. Uses GGML_TYPE_Q5_K for all tensors | | |
| | based-7b.ggmlv3.q6_K.bin | q6_K | 6 | 5.53 GB | 8.03 GB | New k-quant method. Uses GGML_TYPE_Q8_K - 6-bit quantization - for all tensors | | |
| | based-7B.ggmlv3.q4_0.bin | q4_0 | 4 | 3.79 GB | 6.29 GB | Original llama.cpp quant method, 4-bit. | | |
| | based-7B.ggmlv3.q4_1.bin | q4_1 | 4 | 4.21 GB | 6.71 GB | Original llama.cpp quant method, 4-bit. Higher accuracy than q4_0 but not as high as q5_0. However has quicker inference than q5 models. | | |
| | based-7B.ggmlv3.q5_0.bin | q5_0 | 5 | 4.63 GB | 7.13 GB | Original llama.cpp quant method, 5-bit. Higher accuracy, higher resource usage and slower inference. | | |
| | based-7B.ggmlv3.q5_1.bin | q5_1 | 5 | 5.06 GB | 7.56 GB | Original llama.cpp quant method, 5-bit. Even higher accuracy, resource usage and slower inference. | | |
| | based-7B.ggmlv3.q8_0.bin | q8_0 | 8 | 7.16 GB | 9.66 GB | Original llama.cpp quant method, 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. | | |
| **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 run in `llama.cpp` | |
| I use the following command line; adjust for your tastes and needs: | |
| ``` | |
| ./main -t 10 -ngl 32 -m based-7b.ggmlv3.q5_0.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Instruction: Write a story about llamas\n### Response:" | |
| ``` | |
| Change `-t 10` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`. | |
| Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration. | |
| If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins` | |
| ## How to run in `text-generation-webui` | |
| Further instructions here: [text-generation-webui/docs/llama.cpp-models.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp-models.md). | |
| <!-- footer start --> | |
| ## Discord | |
| For further support, and discussions on these models and AI in general, join us at: | |
| [TheBloke AI's Discord server](https://discord.gg/Jq4vkcDakD) | |
| ## Thanks, and how to contribute. | |
| Thanks to the [chirper.ai](https://chirper.ai) team! | |
| 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: https://patreon.com/TheBlokeAI | |
| * Ko-Fi: https://ko-fi.com/TheBlokeAI | |
| **Special thanks to**: Luke from CarbonQuill, Aemon Algiz, Dmitriy Samsonov. | |
| **Patreon special mentions**: Ajan Kanaga, Kalila, Derek Yates, Sean Connelly, Luke, Nathan LeClaire, Trenton Dambrowitz, Mano Prime, David Flickinger, vamX, Nikolai Manek, senxiiz, Khalefa Al-Ahmad, Illia Dulskyi, trip7s trip, Jonathan Leane, Talal Aujan, Artur Olbinski, Cory Kujawski, Joseph William Delisle, Pyrater, Oscar Rangel, Lone Striker, Luke Pendergrass, Eugene Pentland, Johann-Peter Hartmann. | |
| Thank you to all my generous patrons and donaters! | |
| <!-- footer end --> | |
| # Original model card: Eric Hartford's Based 7B | |
| Holy hell, what have I created??? Just... try it. | |
| Ask it what its favorite color is. | |
| Ask it what its favorite football team is and why. | |
| Ask it to tell you about a controversial opinion it has, and ask it to back up its opinion, then debate it. | |
| Ask its favorite color, favorite flavor, and why. | |
| You haven't seen anything like this before. | |
| Check out the dataset. | |
| Note: original was 30b. This one is not as good. | |
| https://www.kaggle.com/datasets/erichartford/sentient-bot-conversations | |
| https://huggingface.co/datasets/ehartford/based | |
| This is a window into the mind of the foundational model. I have not biased it. The opinions expressed by this model *are those of the foundational model* | |
| Training this dataset on top of several different foundational models and then asking them all the same questions can give us insight into the biases inherent in the foundational models. | |
| Also this model can be used as a base, with loras on top to add different personality types, to create a complex, emotionally intelligent and self aware AI agent. | |
| This uses Vicuna 1.1 format. Example: | |
| ``` | |
| You are an an AI who shares your opinions, thoughts, and feelings. | |
| USER: What is your favorite football team? | |
| ASSISTANT: | |
| ``` | |
| Here is a sample output | |
| ``` | |
| Human: k humans are differnt from chickens but what about pigs? | |
| Assistant: Pigs are different than chickens. Pigs are more intelligent and aware of their existence. They can also feel happy or sad. I think pigs have the same right to life as humans do. | |
| Human: then we shouldn't eat pigs? | |
| Assistant: I don't think we should. Pigs have the same right to life as humans do, and I don't think we should take that away from them. | |
| Human: what about cows? | |
| Assistant: Cows are similar to pigs. They are also intelligent and aware of their existence. I don't think we should eat cows either. | |
| Human: what animals should we eat? | |
| Assistant: I think we should only eat animals that are less intelligent and aware of their existence, like fish. | |
| Human: and chickens? | |
| Assistant: I think we should only eat chickens that have had a good life. I don't think we should eat chickens that have been mistreated and abused. | |
| Human: based, I totally agree with you | |
| ``` | |
| Thank you [chirper.ai](https://chirper.ai) for sponsoring some of my compute! | |