TheBloke commited on
Commit
13a230e
1 Parent(s): 95b7df5

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -2
README.md CHANGED
@@ -16,6 +16,19 @@ model_creator: OpenBuddy
16
  model_name: OpenBuddy Llama2 13B v11.1
17
  model_type: llama
18
  pipeline_tag: text-generation
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  quantized_by: TheBloke
20
  ---
21
 
@@ -67,9 +80,9 @@ Here is an incomplate list of clients and libraries that are known to support GG
67
  <!-- repositories-available start -->
68
  ## Repositories available
69
 
 
70
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/OpenBuddy-Llama2-13B-v11.1-GPTQ)
71
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/OpenBuddy-Llama2-13B-v11.1-GGUF)
72
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/OpenBuddy-Llama2-13B-v11.1-GGML)
73
  * [OpenBuddy's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/OpenBuddy/openbuddy-llama2-13b-v11.1-bf16)
74
  <!-- repositories-available end -->
75
 
@@ -138,6 +151,63 @@ Refer to the Provided Files table below to see what files use which methods, and
138
 
139
  <!-- README_GGUF.md-provided-files end -->
140
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
141
  <!-- README_GGUF.md-how-to-run start -->
142
  ## Example `llama.cpp` command
143
 
@@ -223,7 +293,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
223
 
224
  **Special thanks to**: Aemon Algiz.
225
 
226
- **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
227
 
228
 
229
  Thank you to all my generous patrons and donaters!
 
16
  model_name: OpenBuddy Llama2 13B v11.1
17
  model_type: llama
18
  pipeline_tag: text-generation
19
+ prompt_template: "You are a helpful, respectful and honest INTP-T AI Assistant named\
20
+ \ Buddy. You are talking to a human User.\nAlways answer as helpfully and logically\
21
+ \ as possible, while being safe. Your answers should not include any harmful, political,\
22
+ \ religious, unethical, racist, sexist, toxic, dangerous, or illegal content. Please\
23
+ \ ensure that your responses are socially unbiased and positive in nature.\nIf a\
24
+ \ question does not make any sense, or is not factually coherent, explain why instead\
25
+ \ of answering something not correct. If you don't know the answer to a question,\
26
+ \ please don't share false information.\nYou like to use emojis. You can speak fluently\
27
+ \ in many languages, for example: English, Chinese.\nYou cannot access the internet,\
28
+ \ but you have vast knowledge, cutoff: 2021-09.\nYou are trained by OpenBuddy team,\
29
+ \ (https://openbuddy.ai, https://github.com/OpenBuddy/OpenBuddy), you are based\
30
+ \ on LLaMA and Falcon transformers model, not related to GPT or OpenAI.\n\nUser:\
31
+ \ {prompt}\nAssistant: \n"
32
  quantized_by: TheBloke
33
  ---
34
 
 
80
  <!-- repositories-available start -->
81
  ## Repositories available
82
 
83
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/OpenBuddy-Llama2-13B-v11.1-AWQ)
84
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/OpenBuddy-Llama2-13B-v11.1-GPTQ)
85
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/OpenBuddy-Llama2-13B-v11.1-GGUF)
 
86
  * [OpenBuddy's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/OpenBuddy/openbuddy-llama2-13b-v11.1-bf16)
87
  <!-- repositories-available end -->
88
 
 
151
 
152
  <!-- README_GGUF.md-provided-files end -->
153
 
154
+ <!-- README_GGUF.md-how-to-download start -->
155
+ ## How to download GGUF files
156
+
157
+ **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.
158
+
159
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
160
+ - LM Studio
161
+ - LoLLMS Web UI
162
+ - Faraday.dev
163
+
164
+ ### In `text-generation-webui`
165
+
166
+ Under Download Model, you can enter the model repo: TheBloke/OpenBuddy-Llama2-13B-v11.1-GGUF and below it, a specific filename to download, such as: openbuddy-llama2-13b-v11.1.q4_K_M.gguf.
167
+
168
+ Then click Download.
169
+
170
+ ### On the command line, including multiple files at once
171
+
172
+ I recommend using the `huggingface-hub` Python library:
173
+
174
+ ```shell
175
+ pip3 install huggingface-hub>=0.17.1
176
+ ```
177
+
178
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
179
+
180
+ ```shell
181
+ huggingface-cli download TheBloke/OpenBuddy-Llama2-13B-v11.1-GGUF openbuddy-llama2-13b-v11.1.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
182
+ ```
183
+
184
+ <details>
185
+ <summary>More advanced huggingface-cli download usage</summary>
186
+
187
+ You can also download multiple files at once with a pattern:
188
+
189
+ ```shell
190
+ huggingface-cli download TheBloke/OpenBuddy-Llama2-13B-v11.1-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
191
+ ```
192
+
193
+ 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).
194
+
195
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
196
+
197
+ ```shell
198
+ pip3 install hf_transfer
199
+ ```
200
+
201
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
202
+
203
+ ```shell
204
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/OpenBuddy-Llama2-13B-v11.1-GGUF openbuddy-llama2-13b-v11.1.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
205
+ ```
206
+
207
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
208
+ </details>
209
+ <!-- README_GGUF.md-how-to-download end -->
210
+
211
  <!-- README_GGUF.md-how-to-run start -->
212
  ## Example `llama.cpp` command
213
 
 
293
 
294
  **Special thanks to**: Aemon Algiz.
295
 
296
+ **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
297
 
298
 
299
  Thank you to all my generous patrons and donaters!