Upload README.md

README.md

@@ -2,7 +2,7 @@
 datasets:
 - ehartford/wizard_vicuna_70k_unfiltered
 inference: false
-license: other
+license: llama2
 model_creator: Jarrad Hope
 model_link: https://huggingface.co/jarradh/llama2_70b_chat_uncensored
 model_name: Llama2 70B Chat Uncensored
@@ -10,20 +10,26 @@ model_type: llama
 quantized_by: TheBloke
 tags:
 - uncensored
+- wizard
+- vicuna
+- llama
 ---
 
 <!-- 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;">
+<!-- 200823 -->
+<div style="width: auto; margin-left: auto; margin-right: auto">
+<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>
+        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's 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>
+        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
     </div>
 </div>
+<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
+<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
 <!-- header end -->
 
 # Llama2 70B Chat Uncensored - GGML
@@ -34,7 +40,15 @@ tags:
 
 This repo contains GGML format model files for [Jarrad Hope's Llama2 70B Chat Uncensored](https://huggingface.co/jarradh/llama2_70b_chat_uncensored).
 
-GPU acceleration is now available for Llama 2 70B GGML files, with both CUDA (NVidia) and Metal (macOS). The following clients/libraries are known to work with these files, including with CUDA GPU acceleration:
+### Important note regarding GGML files.
+
+The GGML format has now been superseded by GGUF. As of August 21st 2023, [llama.cpp](https://github.com/ggerganov/llama.cpp) no longer supports GGML models. Third party clients and libraries are expected to still support it for a time, but many may also drop support.
+
+Please use the GGUF models instead.
+
+### About GGML
+
+GPU acceleration is now available for Llama 2 70B GGML files, with both CUDA (NVidia) and Metal (macOS). The following clients/libraries are known to work with these files, including with GPU acceleration:
 * [llama.cpp](https://github.com/ggerganov/llama.cpp), commit `e76d630` and later.
 * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI.
 * [KoboldCpp](https://github.com/LostRuins/koboldcpp), version 1.37 and later. A powerful GGML web UI, especially good for story telling.
@@ -45,7 +59,8 @@ GPU acceleration is now available for Llama 2 70B GGML files, with both CUDA (NV
 ## Repositories available
 
 * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GPTQ)
-* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML)
+* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF)
+* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML)
 * [Jarrad Hope's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/jarradh/llama2_70b_chat_uncensored)
 
 ## Prompt template: Human-Response
@@ -55,12 +70,17 @@ GPU acceleration is now available for Llama 2 70B GGML files, with both CUDA (NV
 {prompt}
 
 ### RESPONSE:
+
 ```
 
 <!-- compatibility_ggml start -->
 ## Compatibility
 
-### Requires llama.cpp [commit `e76d630`](https://github.com/ggerganov/llama.cpp/commit/e76d630df17e235e6b9ef416c45996765d2e36fb) or later.
+### Works with llama.cpp [commit `e76d630`](https://github.com/ggerganov/llama.cpp/commit/e76d630df17e235e6b9ef416c45996765d2e36fb) until August 21st, 2023
+
+Will not work with `llama.cpp` after commit [dadbed99e65252d79f81101a392d0d6497b86caa](https://github.com/ggerganov/llama.cpp/commit/dadbed99e65252d79f81101a392d0d6497b86caa).
+
+For compatibility with latest llama.cpp, please use GGUF files instead.
 
 Or one of the other tools and libraries listed above.
 
@@ -89,39 +109,48 @@ Refer to the Provided Files table below to see what files use which methods, and
 | Name | Quant method | Bits | Size | Max RAM required | Use case |
 | ---- | ---- | ---- | ---- | ---- | ----- |
 | [llama2_70b_chat_uncensored.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q2_K.bin) | q2_K | 2 | 28.59 GB| 31.09 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. |
-| [llama2_70b_chat_uncensored.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q3_K_L.bin) | q3_K_L | 3 | 36.15 GB| 38.65 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 |
-| [llama2_70b_chat_uncensored.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q3_K_M.bin) | q3_K_M | 3 | 33.04 GB| 35.54 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 |
 | [llama2_70b_chat_uncensored.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q3_K_S.bin) | q3_K_S | 3 | 29.75 GB| 32.25 GB | New k-quant method. Uses GGML_TYPE_Q3_K for all tensors |
+| [llama2_70b_chat_uncensored.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q3_K_M.bin) | q3_K_M | 3 | 33.04 GB| 35.54 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 |
+| [llama2_70b_chat_uncensored.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q3_K_L.bin) | q3_K_L | 3 | 36.15 GB| 38.65 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 |
 | [llama2_70b_chat_uncensored.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q4_0.bin) | q4_0 | 4 | 38.87 GB| 41.37 GB | Original quant method, 4-bit. |
-| [llama2_70b_chat_uncensored.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q4_1.bin) | q4_1 | 4 | 43.17 GB| 45.67 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. |
-| [llama2_70b_chat_uncensored.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q4_K_M.bin) | q4_K_M | 4 | 41.38 GB| 43.88 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 |
 | [llama2_70b_chat_uncensored.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q4_K_S.bin) | q4_K_S | 4 | 38.87 GB| 41.37 GB | New k-quant method. Uses GGML_TYPE_Q4_K for all tensors |
+| [llama2_70b_chat_uncensored.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q4_K_M.bin) | q4_K_M | 4 | 41.38 GB| 43.88 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 |
+| [llama2_70b_chat_uncensored.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q4_1.bin) | q4_1 | 4 | 43.17 GB| 45.67 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. |
 | [llama2_70b_chat_uncensored.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q5_0.bin) | q5_0 | 5 | 47.46 GB| 49.96 GB | Original quant method, 5-bit. Higher accuracy, higher resource usage and slower inference. |
-| [llama2_70b_chat_uncensored.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q5_K_M.bin) | q5_K_M | 5 | 48.75 GB| 51.25 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 |
 | [llama2_70b_chat_uncensored.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q5_K_S.bin) | q5_K_S | 5 | 47.46 GB| 49.96 GB | New k-quant method. Uses GGML_TYPE_Q5_K for all tensors |
+| [llama2_70b_chat_uncensored.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML/blob/main/llama2_70b_chat_uncensored.ggmlv3.q5_K_M.bin) | q5_K_M | 5 | 48.75 GB| 51.25 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 |
 
 **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`
 
+Make sure you are using `llama.cpp` from commit [dadbed99e65252d79f81101a392d0d6497b86caa](https://github.com/ggerganov/llama.cpp/commit/dadbed99e65252d79f81101a392d0d6497b86caa) or earlier.
+
+For compatibility with latest llama.cpp, please use GGUF files instead.
+
 I use the following command line; adjust for your tastes and needs:
 
 ```
-./main -t 10 -ngl 40 -gqa 8 -m llama2_70b_chat_uncensored.ggmlv3.q4_K_M.bin --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### HUMAN:\nWrite a story about llamas\n\n### RESPONSE:"
+./main -t 10 -ngl 40 -gqa 8 -m llama2_70b_chat_uncensored.ggmlv3.q4_K_M.bin --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### HUMAN:\n{prompt}\n\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 `-t 10` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`. If you are fully offloading the model to GPU, use `-t 1`
 
-Change -ngl 40 to the number of GPU layers you have VRAM for. Use -ngl 100 to offload all layers to VRAM, if you have a 48GB card, or 2 x 24GB, or similar.  Otherwise you can partially offload as many as you have VRAM for, on one or more GPUs.
+Change `-ngl 40` to the number of GPU layers you have VRAM for. Use `-ngl 100` to offload all layers to VRAM - if you have a 48GB card, or 2 x 24GB, or similar.  Otherwise you can partially offload as many as you have VRAM for, on one or more GPUs.
+
+If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
 
 Remember the `-gqa 8` argument, required for Llama 70B models.
 
-If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
+Change `-c 4096` to the desired sequence length for this 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.
+
+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 -->
+<!-- 200823 -->
 ## Discord
 
 For further support, and discussions on these models and AI in general, join us at:
@@ -141,13 +170,15 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
 * Patreon: https://patreon.com/TheBlokeAI
 * Ko-Fi: https://ko-fi.com/TheBlokeAI
 
-**Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
+**Special thanks to**: 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
+**Patreon special mentions**: Russ Johnson, J, alfie_i, Alex, NimbleBox.ai, Chadd, Mandus, Nikolai Manek, Ken Nordquist, ya boyyy, Illia Dulskyi, Viktor Bowallius, vamX, Iucharbius, zynix, Magnesian, Clay Pascal, Pierre Kircher, Enrico Ros, Tony Hughes, Elle, Andrey, knownsqashed, Deep Realms, Jerry Meng, Lone Striker, Derek Yates, Pyrater, Mesiah Bishop, James Bentley, Femi Adebogun, Brandon Frisco, SuperWojo, Alps Aficionado, Michael Dempsey, Vitor Caleffi, Will Dee, Edmond Seymore, usrbinkat, LangChain4j, Kacper Wikieł, Luke Pendergrass, John Detwiler, theTransient, Nathan LeClaire, Tiffany J. Kim, biorpg, Eugene Pentland, Stanislav Ovsiannikov, Fred von Graf, terasurfer, Kalila, Dan Guido, Nitin Borwankar, 阿明, Ai Maven, John Villwock, Gabriel Puliatti, Stephen Murray, Asp the Wyvern, danny, Chris Smitley, ReadyPlayerEmma, S_X, Daniel P. Andersen, Olakabola, Jeffrey Morgan, Imad Khwaja, Caitlyn Gatomon, webtim, Alicia Loh, Trenton Dambrowitz, Swaroop Kallakuri, Erik Bjäreholt, Leonard Tan, Spiking Neurons AB, Luke @flexchar, Ajan Kanaga, Thomas Belote, Deo Leter, RoA, Willem Michiel, transmissions 11, subjectnull, Matthew Berman, Joseph William Delisle, David Ziegler, Michael Davis, Johann-Peter Hartmann, Talal Aujan, senxiiz, Artur Olbinski, Rainer Wilmers, Spencer Kim, Fen Risland, Cap'n Zoog, Rishabh Srivastava, Michael Levine, Geoffrey Montalvo, Sean Connelly, Alexandros Triantafyllidis, Pieter, Gabriel Tamborski, Sam, Subspace Studios, Junyu Yang, Pedro Madruga, Vadim, Cory Kujawski, K, Raven Klaugh, Randy H, Mano Prime, Sebastain Graf, Space Cruiser
 
 
 Thank you to all my generous patrons and donaters!
 
+And thank you again to a16z for their generous grant.
+
 <!-- footer end -->
 
 # Original model card: Jarrad Hope's Llama2 70B Chat Uncensored
@@ -157,6 +188,9 @@ Thank you to all my generous patrons and donaters!
 Fine-tuned [Llama-2 70B](https://huggingface.co/TheBloke/Llama-2-70B-fp16) with an uncensored/unfiltered Wizard-Vicuna conversation dataset [ehartford/wizard_vicuna_70k_unfiltered](https://huggingface.co/datasets/ehartford/wizard_vicuna_70k_unfiltered).
 [QLoRA](https://arxiv.org/abs/2305.14314) was used for fine-tuning. The model was trained for three epochs on a single NVIDIA A100 80GB GPU instance, taking ~1 week to train.
 
+Please note that LLama 2 Base model has its inherit biases.  
+Uncensored refers to the [ehartford/wizard_vicuna_70k_unfiltered](https://huggingface.co/datasets/ehartford/wizard_vicuna_70k_unfiltered) dataset.
+
 Special thanks to [George Sung](https://huggingface.co/georgesung) for creating [llama2_7b_chat_uncensored](https://huggingface.co/georgesung/llama2_7b_chat_uncensored), and to [Eric Hartford](https://huggingface.co/ehartford/) for creating [ehartford/wizard_vicuna_70k_unfiltered](https://huggingface.co/datasets/ehartford/wizard_vicuna_70k_unfiltered)
 
 The version here is the fp16 HuggingFace model.
@@ -166,7 +200,9 @@ In 4 bit mode, the model fits into 51% of A100 80GB (40.8GB) 41559MiB
 500gb of RAM/Swap was required to merge the model.  
 
 ## GGML & GPTQ versions
-TODO
+Thanks to [TheBloke](https://huggingface.co/TheBloke), he has created the GGML and GPTQ versions:
+* https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGML
+* https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GPTQ
 
 # Prompt style
 The model was trained with the following prompt style: