Transformers
GGUF
English
llama
TheBloke commited on
Commit
3abe183
1 Parent(s): 4e956b5

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +100 -21
README.md CHANGED
@@ -1,14 +1,26 @@
1
  ---
 
2
  datasets:
3
  - garage-bAInd/Open-Platypus
4
  inference: false
5
  language:
6
  - en
7
- license: llama2
8
  model_creator: garage-bAInd
9
- model_link: https://huggingface.co/garage-bAInd/Platypus2-13B
10
  model_name: Platypus2
11
  model_type: llama
 
 
 
 
 
 
 
 
 
 
 
 
12
  quantized_by: TheBloke
13
  ---
14
 
@@ -33,23 +45,25 @@ quantized_by: TheBloke
33
  - Model creator: [garage-bAInd](https://huggingface.co/garage-bAInd)
34
  - Original model: [Platypus2](https://huggingface.co/garage-bAInd/Platypus2-13B)
35
 
 
36
  ## Description
37
 
38
  This repo contains GGUF format model files for [garage-bAInd's Platypus2](https://huggingface.co/garage-bAInd/Platypus2-13B).
39
 
 
40
  <!-- README_GGUF.md-about-gguf start -->
41
  ### About GGUF
42
 
43
- 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.
44
 
45
- 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.
46
 
47
- Here are a list of clients and libraries that are known to support GGUF:
48
- * [llama.cpp](https://github.com/ggerganov/llama.cpp).
49
- * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions.
50
- * [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.
51
- * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
52
  * [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.
 
53
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
54
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
55
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
@@ -58,9 +72,9 @@ Here are a list of clients and libraries that are known to support GGUF:
58
  <!-- repositories-available start -->
59
  ## Repositories available
60
 
 
61
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Platypus2-13B-GPTQ)
62
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Platypus2-13B-GGUF)
63
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/Platypus2-13B-GGML)
64
  * [garage-bAInd's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/garage-bAInd/Platypus2-13B)
65
  <!-- repositories-available end -->
66
 
@@ -78,12 +92,21 @@ Below is an instruction that describes a task. Write a response that appropriate
78
  ```
79
 
80
  <!-- prompt-template end -->
 
 
 
 
 
 
 
 
 
81
  <!-- compatibility_gguf start -->
82
  ## Compatibility
83
 
84
- 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)
85
 
86
- They are now also compatible with many third party UIs and libraries - please see the list at the top of the README.
87
 
88
  ## Explanation of quantisation methods
89
  <details>
@@ -124,21 +147,75 @@ Refer to the Provided Files table below to see what files use which methods, and
124
 
125
  <!-- README_GGUF.md-provided-files end -->
126
 
127
- <!-- README_GGUF.md-how-to-run start -->
128
- ## Example `llama.cpp` command
 
 
 
 
 
 
 
 
 
 
 
129
 
130
- Make sure you are using `llama.cpp` from commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9) or later.
131
 
132
- 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.
133
 
 
 
 
 
134
  ```
135
- ./main -t 10 -ngl 32 -m platypus2-13b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
136
  ```
137
- 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`.
138
 
139
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
140
 
141
- 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.
142
 
143
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
144
 
@@ -195,10 +272,12 @@ For further support, and discussions on these models and AI in general, join us
195
 
196
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
197
 
198
- ## Thanks, and how to contribute.
199
 
200
  Thanks to the [chirper.ai](https://chirper.ai) team!
201
 
 
 
202
  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.
203
 
204
  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.
@@ -210,7 +289,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
210
 
211
  **Special thanks to**: Aemon Algiz.
212
 
213
- **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
214
 
215
 
216
  Thank you to all my generous patrons and donaters!
 
1
  ---
2
+ base_model: https://huggingface.co/garage-bAInd/Platypus2-13B
3
  datasets:
4
  - garage-bAInd/Open-Platypus
5
  inference: false
6
  language:
7
  - en
8
+ license: cc-by-nc-sa-4.0
9
  model_creator: garage-bAInd
 
10
  model_name: Platypus2
11
  model_type: llama
12
+ prompt_template: 'Below is an instruction that describes a task. Write a response
13
+ that appropriately completes the request.
14
+
15
+
16
+ ### Instruction:
17
+
18
+ {prompt}
19
+
20
+
21
+ ### Response:
22
+
23
+ '
24
  quantized_by: TheBloke
25
  ---
26
 
 
45
  - Model creator: [garage-bAInd](https://huggingface.co/garage-bAInd)
46
  - Original model: [Platypus2](https://huggingface.co/garage-bAInd/Platypus2-13B)
47
 
48
+ <!-- description start -->
49
  ## Description
50
 
51
  This repo contains GGUF format model files for [garage-bAInd's Platypus2](https://huggingface.co/garage-bAInd/Platypus2-13B).
52
 
53
+ <!-- description end -->
54
  <!-- README_GGUF.md-about-gguf start -->
55
  ### About GGUF
56
 
57
+ 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.
58
 
59
+ Here is an incomplate list of clients and libraries that are known to support GGUF:
60
 
61
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
62
+ * [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.
63
+ * [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.
64
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 
65
  * [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.
66
+ * [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.
67
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
68
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
69
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
 
72
  <!-- repositories-available start -->
73
  ## Repositories available
74
 
75
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Platypus2-13B-AWQ)
76
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Platypus2-13B-GPTQ)
77
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Platypus2-13B-GGUF)
 
78
  * [garage-bAInd's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/garage-bAInd/Platypus2-13B)
79
  <!-- repositories-available end -->
80
 
 
92
  ```
93
 
94
  <!-- prompt-template end -->
95
+ <!-- licensing start -->
96
+ ## Licensing
97
+
98
+ The creator of the source model has listed its license as `cc-by-nc-sa-4.0`, and this quantization has therefore used that same license.
99
+
100
+ 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.
101
+
102
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [garage-bAInd's Platypus2](https://huggingface.co/garage-bAInd/Platypus2-13B).
103
+ <!-- licensing end -->
104
  <!-- compatibility_gguf start -->
105
  ## Compatibility
106
 
107
+ 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)
108
 
109
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
110
 
111
  ## Explanation of quantisation methods
112
  <details>
 
147
 
148
  <!-- README_GGUF.md-provided-files end -->
149
 
150
+ <!-- README_GGUF.md-how-to-download start -->
151
+ ## How to download GGUF files
152
+
153
+ **Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
154
+
155
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
156
+ - LM Studio
157
+ - LoLLMS Web UI
158
+ - Faraday.dev
159
+
160
+ ### In `text-generation-webui`
161
+
162
+ Under Download Model, you can enter the model repo: TheBloke/Platypus2-13B-GGUF and below it, a specific filename to download, such as: platypus2-13b.q4_K_M.gguf.
163
 
164
+ Then click Download.
165
 
166
+ ### On the command line, including multiple files at once
167
 
168
+ I recommend using the `huggingface-hub` Python library:
169
+
170
+ ```shell
171
+ pip3 install huggingface-hub>=0.17.1
172
  ```
173
+
174
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
175
+
176
+ ```shell
177
+ huggingface-cli download TheBloke/Platypus2-13B-GGUF platypus2-13b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
178
+ ```
179
+
180
+ <details>
181
+ <summary>More advanced huggingface-cli download usage</summary>
182
+
183
+ You can also download multiple files at once with a pattern:
184
+
185
+ ```shell
186
+ huggingface-cli download TheBloke/Platypus2-13B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
187
+ ```
188
+
189
+ For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
190
+
191
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
192
+
193
+ ```shell
194
+ pip3 install hf_transfer
195
+ ```
196
+
197
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
198
+
199
+ ```shell
200
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Platypus2-13B-GGUF platypus2-13b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
201
+ ```
202
+
203
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
204
+ </details>
205
+ <!-- README_GGUF.md-how-to-download end -->
206
+
207
+ <!-- README_GGUF.md-how-to-run start -->
208
+ ## Example `llama.cpp` command
209
+
210
+ Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
211
+
212
+ ```shell
213
+ ./main -ngl 32 -m platypus2-13b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:"
214
  ```
 
215
 
216
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
217
 
218
+ 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.
219
 
220
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
221
 
 
272
 
273
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
274
 
275
+ ## Thanks, and how to contribute
276
 
277
  Thanks to the [chirper.ai](https://chirper.ai) team!
278
 
279
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
280
+
281
  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.
282
 
283
  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.
 
289
 
290
  **Special thanks to**: Aemon Algiz.
291
 
292
+ **Patreon special mentions**: Alicia Loh, Stephen Murray, K, Ajan Kanaga, RoA, Magnesian, Deo Leter, Olakabola, Eugene Pentland, zynix, Deep Realms, Raymond Fosdick, Elijah Stavena, Iucharbius, Erik Bjäreholt, Luis Javier Navarrete Lozano, Nicholas, theTransient, John Detwiler, alfie_i, knownsqashed, Mano Prime, Willem Michiel, Enrico Ros, LangChain4j, OG, Michael Dempsey, Pierre Kircher, Pedro Madruga, James Bentley, Thomas Belote, Luke @flexchar, Leonard Tan, Johann-Peter Hartmann, Illia Dulskyi, Fen Risland, Chadd, S_X, Jeff Scroggin, Ken Nordquist, Sean Connelly, Artur Olbinski, Swaroop Kallakuri, Jack West, Ai Maven, David Ziegler, Russ Johnson, transmissions 11, John Villwock, Alps Aficionado, Clay Pascal, Viktor Bowallius, Subspace Studios, Rainer Wilmers, Trenton Dambrowitz, vamX, Michael Levine, 준교 김, Brandon Frisco, Kalila, Trailburnt, Randy H, Talal Aujan, Nathan Dryer, Vadim, 阿明, ReadyPlayerEmma, Tiffany J. Kim, George Stoitzev, Spencer Kim, Jerry Meng, Gabriel Tamborski, Cory Kujawski, Jeffrey Morgan, Spiking Neurons AB, Edmond Seymore, Alexandros Triantafyllidis, Lone Striker, Cap'n Zoog, Nikolai Manek, danny, ya boyyy, Derek Yates, usrbinkat, Mandus, TL, Nathan LeClaire, subjectnull, Imad Khwaja, webtim, Raven Klaugh, Asp the Wyvern, Gabriel Puliatti, Caitlyn Gatomon, Joseph William Delisle, Jonathan Leane, Luke Pendergrass, SuperWojo, Sebastain Graf, Will Dee, Fred von Graf, Andrey, Dan Guido, Daniel P. Andersen, Nitin Borwankar, Elle, Vitor Caleffi, biorpg, jjj, NimbleBox.ai, Pieter, Matthew Berman, terasurfer, Michael Davis, Alex, Stanislav Ovsiannikov
293
 
294
 
295
  Thank you to all my generous patrons and donaters!