Upload README.md

README.md

@@ -36,23 +36,25 @@ tags:
 - Model creator: [Jarrad Hope](https://huggingface.co/jarradh)
 - Original model: [Llama2 70B Chat Uncensored](https://huggingface.co/jarradh/llama2_70b_chat_uncensored)
 
+<!-- description start -->
 ## Description
 
 This repo contains GGUF format model files for [Jarrad Hope's Llama2 70B Chat Uncensored](https://huggingface.co/jarradh/llama2_70b_chat_uncensored).
 
+<!-- description end -->
 <!-- README_GGUF.md-about-gguf start -->
 ### About GGUF
 
-GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp. GGUF offers numerous advantages over GGML, such as better tokenisation, and support for special tokens. It is also supports metadata, and is designed to be extensible.
 
-The key benefit of GGUF is that it is a extensible, future-proof format which stores more information about the model as metadata. It also includes significantly improved tokenization code, including for the first time full support for special tokens. This should improve performance, especially with models that use new special tokens and implement custom prompt templates.
+Here is an incomplate list of clients and libraries that are known to support GGUF:
 
-Here are a list of clients and libraries that are known to support GGUF:
-* [llama.cpp](https://github.com/ggerganov/llama.cpp).
-* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions.
-* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with full GPU accel across multiple platforms and GPU architectures. Especially good for story telling.
-* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
+* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
+* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
+* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
 * [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.
 * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
@@ -79,12 +81,21 @@ Here are a list of clients and libraries that are known to support GGUF:
 ```
 
 <!-- prompt-template end -->
+<!-- licensing start -->
+## Licensing
+
+The creator of the source model has listed its license as `llama2`, and this quantization has therefore used that same license.
+
+As this model is based on Llama 2, it is also subject to the Meta Llama 2 license terms, and the license files for that are additionally included. It should therefore be considered as being claimed to be licensed under both licenses. I contacted Hugging Face for clarification on dual licensing but they do not yet have an official position. Should this change, or should Meta provide any feedback on this situation, I will update this section accordingly.
+
+In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [Jarrad Hope's Llama2 70B Chat Uncensored](https://huggingface.co/jarradh/llama2_70b_chat_uncensored).
+<!-- licensing end -->
 <!-- compatibility_gguf start -->
 ## Compatibility
 
-These quantised GGUF files are compatible with llama.cpp from August 21st 2023 onwards, as of commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9)
+These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
 
-They are now also compatible with many third party UIs and libraries - please see the list at the top of the README.
+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
 <details>
@@ -106,8 +117,9 @@ 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.Q8_0.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q8_0.gguf) | Q8_0 | 8 | 0.00 GB| 2.50 GB | very large, extremely low quality loss - not recommended |
 | [llama2_70b_chat_uncensored.Q6_K.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q6_K.gguf) | Q6_K | 6 | 0.00 GB| 2.50 GB | very large, extremely low quality loss |
+| [llama2_70b_chat_uncensored.Q8_0.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q8_0.gguf) | Q8_0 | 8 | 0.00 GB| 2.50 GB | very large, extremely low quality loss - not recommended |
+| [llama2_70b_chat_uncensored.Q5_K_M.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q5_K_M.gguf) | Q5_K_M | 5 | 1.86 GB| 4.36 GB | large, very low quality loss - recommended |
 | [llama2_70b_chat_uncensored.Q2_K.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q2_K.gguf) | Q2_K | 2 | 29.28 GB| 31.78 GB | smallest, significant quality loss - not recommended for most purposes |
 | [llama2_70b_chat_uncensored.Q3_K_S.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q3_K_S.gguf) | Q3_K_S | 3 | 29.92 GB| 32.42 GB | very small, high quality loss |
 | [llama2_70b_chat_uncensored.Q3_K_M.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q3_K_M.gguf) | Q3_K_M | 3 | 33.19 GB| 35.69 GB | very small, high quality loss |
@@ -115,7 +127,6 @@ Refer to the Provided Files table below to see what files use which methods, and
 | [llama2_70b_chat_uncensored.Q4_0.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q4_0.gguf) | Q4_0 | 4 | 38.87 GB| 41.37 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
 | [llama2_70b_chat_uncensored.Q4_K_S.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q4_K_S.gguf) | Q4_K_S | 4 | 39.07 GB| 41.57 GB | small, greater quality loss |
 | [llama2_70b_chat_uncensored.Q4_K_M.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q4_K_M.gguf) | Q4_K_M | 4 | 41.42 GB| 43.92 GB | medium, balanced quality - recommended |
-| [llama2_70b_chat_uncensored.Q5_K_M.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q5_K_M.gguf) | Q5_K_M | 5 | 44.56 GB| 47.06 GB | large, very low quality loss - recommended |
 | [llama2_70b_chat_uncensored.Q5_0.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q5_0.gguf) | Q5_0 | 5 | 47.46 GB| 49.96 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
 | [llama2_70b_chat_uncensored.Q5_K_S.gguf](https://huggingface.co/TheBloke/llama2_70b_chat_uncensored-GGUF/blob/main/llama2_70b_chat_uncensored.Q5_K_S.gguf) | Q5_K_S | 5 | 47.46 GB| 49.96 GB | large, low quality loss - recommended |
 
@@ -128,18 +139,15 @@ Refer to the Provided Files table below to see what files use which methods, and
 <!-- README_GGUF.md-how-to-run start -->
 ## Example `llama.cpp` command
 
-Make sure you are using `llama.cpp` from commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9) or later.
-
-For compatibility with older versions of llama.cpp, or for any third-party libraries or clients that haven't yet updated for GGUF, please use GGML files instead.
+Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
 
+```shell
+./main -ngl 32 -m llama2_70b_chat_uncensored.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### HUMAN:\n{prompt}\n\n### RESPONSE:"
 ```
-./main -t 10 -ngl 32 -m llama2_70b_chat_uncensored.q4_K_M.gguf --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`. If offloading all layers to GPU, set `-t 1`.
 
 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 this model. 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.
+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`
 
@@ -196,10 +204,12 @@ For further support, and discussions on these models and AI in general, join us
 
 [TheBloke AI's Discord server](https://discord.gg/theblokeai)
 
-## Thanks, and how to contribute.
+## Thanks, and how to contribute
 
 Thanks to the [chirper.ai](https://chirper.ai) team!
 
+Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
+
 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.