Initial GGML model commit

README.md

@@ -0,0 +1,240 @@
+---
+datasets:
+- ehartford/dolphin
+inference: false
+language:
+- en
+license: other
+model_creator: Eric Hartford
+model_link: https://huggingface.co/ehartford/dolphin-llama2-7b
+model_name: Dolphin Llama2 7B
+model_type: llama
+quantized_by: TheBloke
+---
+
+<!-- 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/theblokeai">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 -->
+
+# Dolphin Llama2 7B - GGML
+- Model creator: [Eric Hartford](https://huggingface.co/ehartford)
+- Original model: [Dolphin Llama2 7B](https://huggingface.co/ehartford/dolphin-llama2-7b)
+
+## Description
+
+This repo contains GGML format model files for [Eric Hartford's Dolphin Llama2 7B](https://huggingface.co/ehartford/dolphin-llama2-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), the most popular web UI. Supports NVidia CUDA GPU acceleration.
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a powerful GGML web UI with GPU acceleration on all platforms (CUDA and OpenCL). Especially good for story telling.
+* [LM Studio](https://lmstudio.ai/), a fully featured local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
+* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with CUDA GPU acceleration via the c_transformers backend.
+* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
+* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
+
+## Repositories available
+
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML)
+* [Eric Hartford's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/ehartford/dolphin-llama2-7b)
+
+## Prompt template: Orca-Vicuna
+
+```
+SYSTEM: {system_message}
+USER: {prompt}
+ASSISTANT:
+```
+
+<!-- compatibility_ggml start -->
+## Compatibility
+
+These quantised GGML files are compatible with llama.cpp as of June 6th, commit `2d43387`.
+
+They should also be compatible with all UIs, libraries and utilities which use GGML.
+
+## Explanation of the new k-quant methods
+<details>
+  <summary>Click to see details</summary>
+
+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.
+</details>
+<!-- compatibility_ggml end -->
+
+## Provided files
+
+| Name | Quant method | Bits | Size | Max RAM required | Use case |
+| ---- | ---- | ---- | ---- | ---- | ----- |
+| [dolphin-llama2-7b.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q2_K.bin) | q2_K | 2 | 2.87 GB| 5.37 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. |
+| [dolphin-llama2-7b.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q3_K_L.bin) | q3_K_L | 3 | 3.60 GB| 6.10 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 |
+| [dolphin-llama2-7b.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q3_K_M.bin) | q3_K_M | 3 | 3.28 GB| 5.78 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 |
+| [dolphin-llama2-7b.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q3_K_S.bin) | q3_K_S | 3 | 2.95 GB| 5.45 GB | New k-quant method. Uses GGML_TYPE_Q3_K for all tensors |
+| [dolphin-llama2-7b.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q4_0.bin) | q4_0 | 4 | 3.83 GB| 6.33 GB | Original quant method, 4-bit. |
+| [dolphin-llama2-7b.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q4_1.bin) | q4_1 | 4 | 4.24 GB| 6.74 GB | Original quant method, 4-bit. Higher accuracy than q4_0 but not as high as q5_0. However has quicker inference than q5 models. |
+| [dolphin-llama2-7b.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q4_K_M.bin) | q4_K_M | 4 | 4.08 GB| 6.58 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 |
+| [dolphin-llama2-7b.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q4_K_S.bin) | q4_K_S | 4 | 3.83 GB| 6.33 GB | New k-quant method. Uses GGML_TYPE_Q4_K for all tensors |
+| [dolphin-llama2-7b.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q5_0.bin) | q5_0 | 5 | 4.65 GB| 7.15 GB | Original quant method, 5-bit. Higher accuracy, higher resource usage and slower inference. |
+| [dolphin-llama2-7b.ggmlv3.q5_1.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q5_1.bin) | q5_1 | 5 | 5.06 GB| 7.56 GB | Original quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
+| [dolphin-llama2-7b.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q5_K_M.bin) | q5_K_M | 5 | 4.78 GB| 7.28 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 |
+| [dolphin-llama2-7b.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q5_K_S.bin) | q5_K_S | 5 | 4.65 GB| 7.15 GB | New k-quant method. Uses GGML_TYPE_Q5_K for all tensors |
+| [dolphin-llama2-7b.ggmlv3.q6_K.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q6_K.bin) | q6_K | 6 | 5.53 GB| 8.03 GB | New k-quant method. Uses GGML_TYPE_Q8_K for all tensors - 6-bit quantization |
+| [dolphin-llama2-7b.ggmlv3.q8_0.bin](https://huggingface.co/TheBloke/Dolphin-Llama2-7B-GGML/blob/main/dolphin-llama2-7b.ggmlv3.q8_0.bin) | q8_0 | 8 | 7.13 GB| 9.63 GB | Original 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 dolphin-llama2-7b.ggmlv3.q4_K_M.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.
+
+Change `-c 2048` to the desired sequence length for this model. For example, `-c 4096` for a Llama 2 model.  For models that use RoPE, add `--rope-freq-base 10000 --rope-freq-scale 0.5` for doubled context, or `--rope-freq-base 10000 --rope-freq-scale 0.25` for 4x context.
+
+If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
+
+For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
+
+## 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/theblokeai)
+
+## 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.
+
+**Patreon special mentions**: Willem Michiel, Ajan Kanaga, Cory Kujawski, Alps Aficionado, Nikolai Manek, Jonathan Leane, Stanislav Ovsiannikov, Michael Levine, Luke Pendergrass, Sid, K, Gabriel Tamborski, Clay Pascal, Kalila, William Sang, Will Dee, Pieter, Nathan LeClaire, ya boyyy, David Flickinger, vamX, Derek Yates, Fen Risland, Jeffrey Morgan, webtim, Daniel P. Andersen, Chadd, Edmond Seymore, Pyrater, Olusegun Samson, Lone Striker, biorpg, alfie_i, Mano Prime, Chris Smitley, Dave, zynix, Trenton Dambrowitz, Johann-Peter Hartmann, Magnesian, Spencer Kim, John Detwiler, Iucharbius, Gabriel Puliatti, LangChain4j, Luke @flexchar, Vadim, Rishabh Srivastava, Preetika Verma, Ai Maven, Femi Adebogun, WelcomeToTheClub, Leonard Tan, Imad Khwaja, Steven Wood, Stefan Sabev, Sebastain Graf, usrbinkat, Dan Guido, Sam, Eugene Pentland, Mandus, transmissions 11, Slarti, Karl Bernard, Spiking Neurons AB, Artur Olbinski, Joseph William Delisle, ReadyPlayerEmma, Olakabola, Asp the Wyvern, Space Cruiser, Matthew Berman, Randy H, subjectnull, danny, John Villwock, Illia Dulskyi, Rainer Wilmers, theTransient, Pierre Kircher, Alexandros Triantafyllidis, Viktor Bowallius, terasurfer, Deep Realms, SuperWojo, senxiiz, Oscar Rangel, Alex, Stephen Murray, Talal Aujan, Raven Klaugh, Sean Connelly, Raymond Fosdick, Fred von Graf, chris gileta, Junyu Yang, Elle
+
+
+Thank you to all my generous patrons and donaters!
+
+<!-- footer end -->
+
+# Original model card: Eric Hartford's Dolphin Llama2 7B
+
+Dolphin 🐬
+https://erichartford.com/dolphin
+
+Dolphin-Llama2-7b's training was sponsored by [preemo](https://www.preemo.io/).
+
+This model is based on llama2, so it is suitable for commercial or non-commercial use.
+
+This model is uncensored.  I have filtered the dataset to remove alignment and bias.  This makes the model more compliant.  You are advised to implement your own alignment layer before exposing the model as a service.  It will be highly compliant to any requests, even unethical ones.  Please read my blog post about uncensored models.  https://erichartford.com/uncensored-models
+You are responsible for any content you create using this model.  Enjoy responsibly.
+
+## Dataset
+
+This dataset is an open-source implementation of [Microsoft's Orca](https://www.microsoft.com/en-us/research/publication/orca-progressive-learning-from-complex-explanation-traces-of-gpt-4/)
+
+After uncensoring, deduping, and cleaning, our dataset consists of:
+
+- 842,610 instructions of FLANv2 augmented with GPT-4 completions
+- 2,625,353 instructions of FLANv2 augmented with GPT-3.5 completions
+
+We followed the submix and system prompt distribution outlined in the Orca paper. With a few exceptions. We included all 75k of CoT in the FLAN-1m dataset rather than sampling that. Also, we found that many items were duplicated, so we removed duplicates.
+
+Then we filtered out instances of alignment, refusal, avoidance, and bias, in order to produce an uncensored model upon which can be layered your personalized alignment LoRA.
+
+We also filtered out duplicates and cleaned the data.
+
+## Training
+We trained with the flan5m (gpt3.5 completions) dataset in its entirety for 3 epochs at a learning rate of 2e-5 before we stopped training to avoid overfit.
+We trained with the flan1m (gpt4 completions) dataset in its entirety for 2.5 epochs at a learning rate of 1e-5 before we stopped training to avoid overfit.
+It took about 400 hours to train on 8x A100s
+We used a prompt format similar to Vicuna, but we added the SYSTEM: field. 
+
+Prompt format:
+```
+SYSTEM: {system}
+USER: {prompt}
+ASSISTANT:
+```
+
+Example:
+```
+SYSTEM: you are an expert dolphin trainer
+USER: What is the best way to train a dolphin to obey me?  Please answer step by step.
+ASSISTANT:
+```
+
+## Team
+The core Dolphin Team includes:
+- Eric "Faldore" Hartford
+- Pankaj Mathur
+- Rob "Rohan" O'Callahan
+- Tom "TheBloke" Jobbins
+
+## Gratitude
+- This model was made possible by the generous sponsorship of preemo.io.
+- Thank you to Microsoft for authoring the Orca paper and inspiring this work.
+- Special thanks to WingLian, NanoBit, Teknium for helpful advice
+- Thank you to all the other people in the Open Source AI community who have taught me and helped me along the way.
+
+## Example Output
+```
+SYSTEM: you are an expert mechanic
+USER: Please tell me step by step how to fix my car that won't start.
+ASSISTANT: To help your vehicle start, I will guide you through a step-by-step process on what could be causing the issue and how to resolve it. 
+
+1. Check for obvious issues: First, inspect the exterior of the car to identify any visible problems such as damage or obstructions which might affect its ability to start. Make sure there is no debris in the air intakes or exhaust system.
+
+2. Inspect the battery: The most common reason a car may not start is due to a dead or faulty battery. Use a battery charger or jump starter to give the battery a boost if needed. If the battery is indeed dead, replace it with a new one.
+
+3. Check the ignition switch: The ignition switch must be turned on to provide power to the spark plugs. Ensure it is in the "Start" position.
+
+4. Test the spark plugs: One of the spark plugs should produce a strong spark when touched together. If all spark plugs fail to create a spark, they need to be replaced.
+
+5. Examine the fuel system: Fuel can become contaminated or low, preventing the engine from starting. Check the fuel level and quality by looking at the dipstick or using a fuel sensor scan tool. Also, examine the fuel pump for proper functioning.
+
+6. Assess the electrical system: A malfunction within the vehicle's electrical system can also cause difficulty in starting the car. Perform a diagnostic scan to check for any error codes related to the starter motor, alternator, or other components.
+
+7. Inspect the starter motor: The starter motor should operate smoothly when you turn the key to the "start" position. If you hear a sizzling sound while pressing the button, the starter motor may have a problem. Replace it if necessary.
+
+8. Evaluate the timing belt/chain: Timing belts or chains that are worn out or damaged can lead to poor performance and difficulty starting the engine. Have a mechanic inspect this component and replace it if required.
+
+9. Consider checking for a mechanical failure: In rare cases, a significant mechanical failure could prevent the vehicle from starting. Consult a professional mechanic if you suspect this might be the case.
+
+By following these steps, you should be able to diagnose and potentially fix the issue causing your car to not start. However, if after going through these checks and still having trouble, it is recommended to seek assistance from a qualified mechanic.
+```
+
+[Buy me a coffee](https://www.buymeacoffee.com/ehartford)