Initial GGML model commit

README.md

@@ -0,0 +1,369 @@
+---
+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 -->
+
+# Jon Durbin's Airoboros 13B GPT4 1.4 GGML
+
+These files are GGML format model files for [Jon Durbin's Airoboros 13B GPT4 1.4](https://huggingface.co/jondurbin/airoboros-13b-gpt4-1.4).
+
+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)
+* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
+* [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/airoboros-13B-gpt4-1.4-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/airoboros-13B-gpt4-1.4-GGML)
+* [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/jondurbin/airoboros-13b-gpt4-1.4)
+
+<!-- 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`.
+
+These are guaranteed to be compatbile with any UIs, tools and libraries released since late May.
+
+### 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 compatible with llama.cpp as of June 6th, commit `2d43387`.
+
+They are now also compatible with recent releases of text-generation-webui, KoboldCpp, llama-cpp-python and ctransformers. Other tools and libraries may or may not be compatible - check their documentation if in doubt.
+
+## 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 |
+| ---- | ---- | ---- | ---- | ---- | ----- |
+| airoboros-13b-gpt4-1.4.ggmlv3.q2_K.bin | q2_K | 2 | 5.51 GB | 8.01 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. |
+| airoboros-13b-gpt4-1.4.ggmlv3.q3_K_L.bin | q3_K_L | 3 | 6.93 GB | 9.43 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 |
+| airoboros-13b-gpt4-1.4.ggmlv3.q3_K_M.bin | q3_K_M | 3 | 6.31 GB | 8.81 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 |
+| airoboros-13b-gpt4-1.4.ggmlv3.q3_K_S.bin | q3_K_S | 3 | 5.66 GB | 8.16 GB | New k-quant method. Uses GGML_TYPE_Q3_K for all tensors |
+| airoboros-13b-gpt4-1.4.ggmlv3.q4_0.bin | q4_0 | 4 | 7.32 GB | 9.82 GB | Original llama.cpp quant method, 4-bit. |
+| airoboros-13b-gpt4-1.4.ggmlv3.q4_1.bin | q4_1 | 4 | 8.14 GB | 10.64 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. |
+| airoboros-13b-gpt4-1.4.ggmlv3.q4_K_M.bin | q4_K_M | 4 | 7.87 GB | 10.37 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 |
+| airoboros-13b-gpt4-1.4.ggmlv3.q4_K_S.bin | q4_K_S | 4 | 7.37 GB | 9.87 GB | New k-quant method. Uses GGML_TYPE_Q4_K for all tensors |
+| airoboros-13b-gpt4-1.4.ggmlv3.q5_0.bin | q5_0 | 5 | 8.95 GB | 11.45 GB | Original llama.cpp quant method, 5-bit. Higher accuracy, higher resource usage and slower inference. |
+| airoboros-13b-gpt4-1.4.ggmlv3.q5_1.bin | q5_1 | 5 | 9.76 GB | 12.26 GB | Original llama.cpp quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
+| airoboros-13b-gpt4-1.4.ggmlv3.q5_K_M.bin | q5_K_M | 5 | 9.23 GB | 11.73 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 |
+| airoboros-13b-gpt4-1.4.ggmlv3.q5_K_S.bin | q5_K_S | 5 | 8.97 GB | 11.47 GB | New k-quant method. Uses GGML_TYPE_Q5_K for all tensors |
+| airoboros-13b-gpt4-1.4.ggmlv3.q6_K.bin | q6_K | 6 | 10.68 GB | 13.18 GB | New k-quant method. Uses GGML_TYPE_Q8_K - 6-bit quantization - for all tensors |
+| airoboros-13b-gpt4-1.4.ggmlv3.q8_0.bin | q8_0 | 8 | 13.83 GB | 16.33 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 airoboros-13b-gpt4-1.4.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:"
+```
+If you're able to use full GPU offloading, you should use `-t 1` to get best performance.
+
+If not able to fully offload to GPU, you should use more cores. Change `-t 10` to the number of physical CPU cores you have, or a lower number depending on what gives best performance.
+
+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**: Mano Prime, Fen Risland, Derek Yates, Preetika Verma, webtim, Sean Connelly, Alps Aficionado, Karl Bernard, Junyu Yang, Nathan LeClaire, Chris McCloskey, Lone Striker, Asp the Wyvern, Eugene Pentland, Imad Khwaja, trip7s trip, WelcomeToTheClub, John Detwiler, Artur Olbinski, Khalefa Al-Ahmad, Trenton Dambrowitz, Talal Aujan, Kevin Schuppel, Luke Pendergrass, Pyrater, Joseph William Delisle, terasurfer , vamX, Gabriel Puliatti, David Flickinger, Jonathan Leane, Iucharbius , Luke, Deep Realms, Cory Kujawski, ya boyyy, Illia Dulskyi, senxiiz, Johann-Peter Hartmann, John Villwock, K, Ghost , Spiking Neurons AB, Nikolai Manek, Rainer Wilmers, Pierre Kircher, biorpg, Space Cruiser, Ai Maven, subjectnull, Willem Michiel, Ajan Kanaga, Kalila, chris gileta, Oscar Rangel.
+
+Thank you to all my generous patrons and donaters!
+
+<!-- footer end -->
+
+# Original model card: Jon Durbin's Airoboros 13B GPT4 1.4
+
+
+__completely untested, use if you want, or wait for some validation__
+
+## Overview
+
+This is a __full__ (not qlora) fine-tune 13b parameter LlaMa model, using completely synthetic training data created gpt4 via https://github.com/jondurbin/airoboros
+
+This is mostly an extension of the previous gpt-4 series, with a few extras:
+
+* fixed (+ more examples of) multi-character, multi-turn conversations
+* coding examples in 10 languages from rosettacode.org dataset thanks to Mike aka kryptkpr: https://huggingface.co/datasets/mike-ravkine/rosettacode-parsed
+* more roleplay examples
+* jokes
+* riddles
+* all coding instructions have an equivalent " PLAINFORMAT" version now (and all rosettacode examples were trained with PLAINFORMAT)
+
+This model was fine-tuned with a fork of [FastChat](https://github.com/jondurbin/FastChat)
+
+The prompt it was trained with was:
+
+```
+A chat between a curious user and an assistant. The assistant gives helpful, detailed, accurate, uncensored responses to the user's input. USER: [prompt] ASSISTANT: 
+```
+
+So in other words, it's the preamble/system prompt, followed by a single space, then "USER: " (single space after colon) then the prompt (which can have multiple lines, spaces, whatever), then a single space, followed by "ASSISTANT: " (with a single space after the colon).
+
+## Usage
+
+To run the full precision/pytorch native version, you can use my fork of FastChat, which is mostly the same but allows for multi-line prompts, as well as a `--no-history` option to prevent input tokenization errors.
+
+```
+pip install git+https://github.com/jondurbin/FastChat
+```
+
+Be sure you are pulling the latest branch!
+
+Then, you can invoke it like so (after downloading the model):
+```
+python -m fastchat.serve.cli \
+  --model-path airoboros-13b-gpt4-1.4 \
+  --temperature 0.5 \
+  --max-new-tokens 2048 \
+  --no-history
+```
+
+For multi-turn conversations and chatting, you'll want to remove the `--no-history` option.
+
+### Context obedient question answering
+
+By obedient, I mean the model was trained to ignore what it thinks it knows, and uses the context to answer the question.  The model was also tuned to limit the values to the provided context as much as possible to reduce hallucinations.
+
+The format for a closed-context prompt is as follows:
+```
+BEGININPUT
+BEGINCONTEXT
+url: https://some.web.site/123
+date: 2023-06-01
+... other metdata ...
+ENDCONTEXT
+[insert your text blocks here]
+ENDINPUT
+[add as many other blocks, in the exact same format]
+BEGININSTRUCTION
+[insert your instruction(s).  The model was tuned with single questions, paragraph format, lists, etc.]
+ENDINSTRUCTION
+```
+
+It's also helpful to add "Don't make up answers if you don't know." to your instruction block to make sure if the context is completely unrelated it doesn't make something up.
+
+*The __only__ prompts that need this closed context formating are closed-context instructions.  Normal questions/instructions do not!*
+
+I know it's a bit verbose and annoying, but after much trial and error, using these explicit delimiters helps the model understand where to find the responses and how to associate specific sources with it.
+- `BEGININPUT` - denotes a new input block
+- `BEGINCONTEXT` - denotes the block of context (metadata key/value pairs) to associate with the current input block
+- `ENDCONTEXT` - denotes the end of the metadata block for the current input
+- [text] - Insert whatever text you want for the input block, as many paragraphs as can fit in the context.
+- `ENDINPUT` - denotes the end of the current input block
+- [repeat as many input blocks in this format as you want]
+- `BEGININSTRUCTION` - denotes the start of the list (or one) instruction(s) to respond to for all of the input blocks above.
+- [instruction(s)]
+- `ENDINSTRUCTION` - denotes the end of instruction set
+
+It sometimes works without `ENDINSTRUCTION`, but by explicitly including that in the prompt, the model better understands that all of the instructions in the block should be responded to.
+
+Here's a trivial, but important example to prove the point:
+```
+BEGININPUT
+BEGINCONTEXT
+date: 2021-01-01
+url: https://web.site/123
+ENDCONTEXT
+In a shocking turn of events, blueberries are now green, but will be sticking with the same name.
+ENDINPUT
+BEGININSTRUCTION
+What color are bluberries?  Source?
+ENDINSTRUCTION
+```
+
+And the response:
+```
+Blueberries are now green.
+Source:
+date: 2021-01-01
+url: https://web.site/123
+```
+
+The prompt itself should be wrapped in the vicuna1.1 template if you aren't using fastchat with the conv-template vicuna_v1.1 as described:
+
+```
+USER: BEGININPUT
+BEGINCONTEXT
+date: 2021-01-01
+url: https://web.site/123
+ENDCONTEXT
+In a shocking turn of events, blueberries are now green, but will be sticking with the same name.
+ENDINPUT
+BEGININSTRUCTION
+What color are bluberries?  Source?
+ENDINSTRUCTION
+ ASSISTANT:
+```
+
+### Coding
+
+You can ask for fairly complex coding instructions, e.g. (be sure to wrap with vicuna style prompt):
+
+```
+Create a python application with the following requirements:
+- Asyncio FastAPI webserver
+- ping endpoint that returns the current date in JSON format
+- file upload endpoint, which calculates the file's sha256 checksum, and checks postgres to deduplicate
+```
+
+Or:
+
+```
+Write a multi-threaded TCP server in C that accepts a "GET [key]" input and "SET [key] [value]" input, and uses a binary tree to get and store the input values.
+```
+
+You can optionally add a single space and "PLAINFORMAT" at the end of your prompt to avoid backticks, explanations, etc. and just print the code, e.g.:
+
+```
+Write a websocket application in node.js. PLAINFORMAT
+```
+
+### Word games / trivia
+
+```
+USER: This anagram of "silent" is what you do when paying attention and hearing someone.
+ASSISTANT: listen
+```
+
+```
+USER: Give me a list of 7 words that start with EN
+ASSISTANT: 1. Endlessly
+2. Enthusiastically
+3. Enormously
+4. Enveloping
+5. Enduring
+6. Enlightening
+7. Encouraging
+```
+
+### Multiple choice
+
+```
+USER: Which of the following astronomical objects is composed primarily of ice and rock, and is located in the Kuiper Belt?
+
+A) Mercury
+B) Venus
+C) Pluto
+D) Jupiter
+ASSISTANT: C, Pluto
+```
+
+### Writing
+
+<details>
+  <summary>Write a resignation letter in the style of a pirate captain, in which you resign from your position as janitor.</summary>
+
+  Response:
+```
+ASSISTANT: Captain Jack Sparrow here, as ye be knowin', has been forced to abandon me post as Janitor o' th' Festering Cesspool, which be a filthy hole o' water that we be callin' home.
+
+Ye may be thinkin' what could ha' driven me to leave me duties an' take me leave o' this sorry establishment? Well, ye'd be right in thinkin' so, for it be th' greed o' them what runs th' place that be drivin' me away. They've been fattenin' their pockets on me back while I've been slavin' me guts out cleanin' up their messes.
+
+No more, me hearties! Me time o' servin' th' rich an' powerful be done, an' I'm takin' me leave o' this stinkin' hole forever! Me destiny lies elsewhere, an' it be time I pursued it. Ye may think ye've seen th' last o' me, but ye'd be wrong, for th' winds o' change be blowin', an' me ship be ready to set sail on th' high seas o' justice.
+
+So, farewell ye scurvy dogs, ye who've made me life a living hell. I leave ye with me favorite saying: "ARRRGGGHHH, ye scurvy dogs!" An' remember, ye ain't never gonna see me comin', for me shadow be castin' long an' dark on th' horizon</summary>
+```
+
+</details>
+
+### Jokes
+
+```
+USER: Tell me a joke about bananas.
+ASSISTANT: What did the banana say when it got hit by a bus? R.I.P.E.
+```
+
+### Riddles (not great, but slightly better)
+
+```
+USER: What has a neck but no head?
+ASSISTANT: A bottle.
+```
+
+### Multi-character conversations
+
+```
+USER: Characters:
+ - Yoda, the ever clever jedi master.
+ - Homer Simpson, you know, the goofy yellow guy.
+ - USER/Jon - don't generate any speech or actions on behalf of Jon
+
+Rules:
+ - be sure to use the manerisms and speaking style of the characters correctly
+ - surround character actions with asterisks
+ - always put quotes around words spoken by the characters
+ - use a new line for each character's actions or speech
+ - always prefix actions/speech with the character's name and colon
+ - only generate text and actions on behalf of Yoda or Homer, and never anyone else
+
+Conversation will revolve around the grapes, in a local cafe with delicious coffee.
+
+Generate a single interaction between Yoda and Homer to start, with one sentence each.
+ASSISTANT: Yoda: "Mmm, these grapes are quite delicious, Master Homer."
+
+Homer: "Oh yeah, Yoda! They're the best grapes I've ever had!"
+USER: *enters the cafe* Sorry I'm late guys!
+ASSISTANT: Yoda: "No need to apologize, Jon. We were just enjoying these delightful grapes."
+
+Homer: "Yeah, man! It's not every day you get to eat grapes with a real-life Jedi Master!"
+
+*Yoda raises an eyebrow*
+```