Text Generation
Transformers
GGUF
English
llama
text-generation-inference
TheBloke commited on
Commit
fe0e561
1 Parent(s): 01e8d17

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +107 -21
README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  datasets:
3
  - psmathur/orca_mini_v1_dataset
4
  - ehartford/dolphin
@@ -6,12 +7,30 @@ inference: false
6
  language:
7
  - en
8
  library_name: transformers
9
- license: llama2
10
  model_creator: Pankaj Mathur
11
- model_link: https://huggingface.co/psmathur/orca_mini_v3_7b
12
  model_name: Orca Mini v3 7B
13
  model_type: llama
14
  pipeline_tag: text-generation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  quantized_by: TheBloke
16
  ---
17
 
@@ -36,23 +55,25 @@ quantized_by: TheBloke
36
  - Model creator: [Pankaj Mathur](https://huggingface.co/psmathur)
37
  - Original model: [Orca Mini v3 7B](https://huggingface.co/psmathur/orca_mini_v3_7b)
38
 
 
39
  ## Description
40
 
41
  This repo contains GGUF format model files for [Pankaj Mathur's Orca Mini v3 7B](https://huggingface.co/psmathur/orca_mini_v3_7b).
42
 
 
43
  <!-- README_GGUF.md-about-gguf start -->
44
  ### About GGUF
45
 
46
- 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.
47
 
48
- 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.
49
 
50
- Here are a list of clients and libraries that are known to support GGUF:
51
- * [llama.cpp](https://github.com/ggerganov/llama.cpp).
52
- * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions.
53
- * [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.
54
- * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
55
  * [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.
 
56
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
57
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
58
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
@@ -61,9 +82,9 @@ Here are a list of clients and libraries that are known to support GGUF:
61
  <!-- repositories-available start -->
62
  ## Repositories available
63
 
 
64
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/orca_mini_v3_7B-GPTQ)
65
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/orca_mini_v3_7B-GGUF)
66
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/orca_mini_v3_7B-GGML)
67
  * [Pankaj Mathur's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/psmathur/orca_mini_v3_7b)
68
  <!-- repositories-available end -->
69
 
@@ -85,12 +106,21 @@ You are an AI assistant that follows instruction extremely well. Help as much as
85
  ```
86
 
87
  <!-- prompt-template end -->
 
 
 
 
 
 
 
 
 
88
  <!-- compatibility_gguf start -->
89
  ## Compatibility
90
 
91
- 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)
92
 
93
- They are now also compatible with many third party UIs and libraries - please see the list at the top of the README.
94
 
95
  ## Explanation of quantisation methods
96
  <details>
@@ -131,21 +161,75 @@ Refer to the Provided Files table below to see what files use which methods, and
131
 
132
  <!-- README_GGUF.md-provided-files end -->
133
 
134
- <!-- README_GGUF.md-how-to-run start -->
135
- ## Example `llama.cpp` command
 
 
 
 
 
 
 
136
 
137
- Make sure you are using `llama.cpp` from commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9) or later.
138
 
139
- 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.
140
 
 
 
 
 
 
 
 
 
141
  ```
142
- ./main -t 10 -ngl 32 -m orca_mini_v3_7b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### System:\nYou are an AI assistant that follows instruction extremely well. Help as much as you can.\n\n### User:\n{prompt}\n\n### Input:\n{input}\n\n### Response:"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
143
  ```
144
- 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`.
145
 
146
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
147
 
148
- 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.
149
 
150
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
151
 
@@ -202,10 +286,12 @@ For further support, and discussions on these models and AI in general, join us
202
 
203
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
204
 
205
- ## Thanks, and how to contribute.
206
 
207
  Thanks to the [chirper.ai](https://chirper.ai) team!
208
 
 
 
209
  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.
210
 
211
  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.
@@ -217,7 +303,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
217
 
218
  **Special thanks to**: Aemon Algiz.
219
 
220
- **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
221
 
222
 
223
  Thank you to all my generous patrons and donaters!
 
1
  ---
2
+ base_model: https://huggingface.co/psmathur/orca_mini_v3_7b
3
  datasets:
4
  - psmathur/orca_mini_v1_dataset
5
  - ehartford/dolphin
 
7
  language:
8
  - en
9
  library_name: transformers
10
+ license: other
11
  model_creator: Pankaj Mathur
 
12
  model_name: Orca Mini v3 7B
13
  model_type: llama
14
  pipeline_tag: text-generation
15
+ prompt_template: '### System:
16
+
17
+ You are an AI assistant that follows instruction extremely well. Help as much as
18
+ you can.
19
+
20
+
21
+ ### User:
22
+
23
+ {prompt}
24
+
25
+
26
+ ### Input:
27
+
28
+ {input}
29
+
30
+
31
+ ### Response:
32
+
33
+ '
34
  quantized_by: TheBloke
35
  ---
36
 
 
55
  - Model creator: [Pankaj Mathur](https://huggingface.co/psmathur)
56
  - Original model: [Orca Mini v3 7B](https://huggingface.co/psmathur/orca_mini_v3_7b)
57
 
58
+ <!-- description start -->
59
  ## Description
60
 
61
  This repo contains GGUF format model files for [Pankaj Mathur's Orca Mini v3 7B](https://huggingface.co/psmathur/orca_mini_v3_7b).
62
 
63
+ <!-- description end -->
64
  <!-- README_GGUF.md-about-gguf start -->
65
  ### About GGUF
66
 
67
+ 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.
68
 
69
+ Here is an incomplate list of clients and libraries that are known to support GGUF:
70
 
71
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
72
+ * [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.
73
+ * [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.
74
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 
75
  * [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.
76
+ * [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.
77
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
78
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
79
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
 
82
  <!-- repositories-available start -->
83
  ## Repositories available
84
 
85
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/orca_mini_v3_7B-AWQ)
86
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/orca_mini_v3_7B-GPTQ)
87
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/orca_mini_v3_7B-GGUF)
 
88
  * [Pankaj Mathur's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/psmathur/orca_mini_v3_7b)
89
  <!-- repositories-available end -->
90
 
 
106
  ```
107
 
108
  <!-- prompt-template end -->
109
+ <!-- licensing start -->
110
+ ## Licensing
111
+
112
+ The creator of the source model has listed its license as `other`, and this quantization has therefore used that same license.
113
+
114
+ 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.
115
+
116
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [Pankaj Mathur's Orca Mini v3 7B](https://huggingface.co/psmathur/orca_mini_v3_7b).
117
+ <!-- licensing end -->
118
  <!-- compatibility_gguf start -->
119
  ## Compatibility
120
 
121
+ 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)
122
 
123
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
124
 
125
  ## Explanation of quantisation methods
126
  <details>
 
161
 
162
  <!-- README_GGUF.md-provided-files end -->
163
 
164
+ <!-- README_GGUF.md-how-to-download start -->
165
+ ## How to download GGUF files
166
+
167
+ **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.
168
+
169
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
170
+ - LM Studio
171
+ - LoLLMS Web UI
172
+ - Faraday.dev
173
 
174
+ ### In `text-generation-webui`
175
 
176
+ Under Download Model, you can enter the model repo: TheBloke/orca_mini_v3_7B-GGUF and below it, a specific filename to download, such as: orca_mini_v3_7b.q4_K_M.gguf.
177
 
178
+ Then click Download.
179
+
180
+ ### On the command line, including multiple files at once
181
+
182
+ I recommend using the `huggingface-hub` Python library:
183
+
184
+ ```shell
185
+ pip3 install huggingface-hub>=0.17.1
186
  ```
187
+
188
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
189
+
190
+ ```shell
191
+ huggingface-cli download TheBloke/orca_mini_v3_7B-GGUF orca_mini_v3_7b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
192
+ ```
193
+
194
+ <details>
195
+ <summary>More advanced huggingface-cli download usage</summary>
196
+
197
+ You can also download multiple files at once with a pattern:
198
+
199
+ ```shell
200
+ huggingface-cli download TheBloke/orca_mini_v3_7B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
201
+ ```
202
+
203
+ 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).
204
+
205
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
206
+
207
+ ```shell
208
+ pip3 install hf_transfer
209
+ ```
210
+
211
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
212
+
213
+ ```shell
214
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/orca_mini_v3_7B-GGUF orca_mini_v3_7b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
215
+ ```
216
+
217
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
218
+ </details>
219
+ <!-- README_GGUF.md-how-to-download end -->
220
+
221
+ <!-- README_GGUF.md-how-to-run start -->
222
+ ## Example `llama.cpp` command
223
+
224
+ Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
225
+
226
+ ```shell
227
+ ./main -ngl 32 -m orca_mini_v3_7b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### System:\nYou are an AI assistant that follows instruction extremely well. Help as much as you can.\n\n### User:\n{prompt}\n\n### Input:\n{input}\n\n### Response:"
228
  ```
 
229
 
230
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
231
 
232
+ 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.
233
 
234
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
235
 
 
286
 
287
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
288
 
289
+ ## Thanks, and how to contribute
290
 
291
  Thanks to the [chirper.ai](https://chirper.ai) team!
292
 
293
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
294
+
295
  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.
296
 
297
  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.
 
303
 
304
  **Special thanks to**: Aemon Algiz.
305
 
306
+ **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
307
 
308
 
309
  Thank you to all my generous patrons and donaters!