TheBloke commited on
Commit
02ef1a5
1 Parent(s): a0c033a

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +60 -8
README.md CHANGED
@@ -67,16 +67,11 @@ Here is an incomplate list of clients and libraries that are known to support GG
67
  <!-- repositories-available end -->
68
 
69
  <!-- prompt-template start -->
70
- ## Prompt template: Alpaca
71
 
72
  ```
73
- Below is an instruction that describes a task. Write a response that appropriately completes the request.
74
-
75
- ### Instruction:
76
  {prompt}
77
 
78
- ### Response:
79
-
80
  ```
81
 
82
  <!-- prompt-template end -->
@@ -135,13 +130,70 @@ Refer to the Provided Files table below to see what files use which methods, and
135
 
136
  <!-- README_GGUF.md-provided-files end -->
137
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
138
  <!-- README_GGUF.md-how-to-run start -->
139
  ## Example `llama.cpp` command
140
 
141
  Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
142
 
143
  ```shell
144
- ./main -ngl 32 -m marcoroni-7b.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:"
145
  ```
146
 
147
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
@@ -220,7 +272,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
220
 
221
  **Special thanks to**: Aemon Algiz.
222
 
223
- **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
224
 
225
 
226
  Thank you to all my generous patrons and donaters!
 
67
  <!-- repositories-available end -->
68
 
69
  <!-- prompt-template start -->
70
+ ## Prompt template: Unknown
71
 
72
  ```
 
 
 
73
  {prompt}
74
 
 
 
75
  ```
76
 
77
  <!-- prompt-template end -->
 
130
 
131
  <!-- README_GGUF.md-provided-files end -->
132
 
133
+ <!-- README_GGUF.md-how-to-download start -->
134
+ ## How to download GGUF files
135
+
136
+ **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.
137
+
138
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
139
+ - LM Studio
140
+ - LoLLMS Web UI
141
+ - Faraday.dev
142
+
143
+ ### In `text-generation-webui`
144
+
145
+ Under Download Model, you can enter the model repo: TheBloke/Marcoroni-7b-GGUF and below it, a specific filename to download, such as: marcoroni-7b.q4_K_M.gguf.
146
+
147
+ Then click Download.
148
+
149
+ ### On the command line, including multiple files at once
150
+
151
+ I recommend using the `huggingface-hub` Python library:
152
+
153
+ ```shell
154
+ pip3 install huggingface-hub>=0.17.1
155
+ ```
156
+
157
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
158
+
159
+ ```shell
160
+ huggingface-cli download TheBloke/Marcoroni-7b-GGUF marcoroni-7b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
161
+ ```
162
+
163
+ <details>
164
+ <summary>More advanced huggingface-cli download usage</summary>
165
+
166
+ You can also download multiple files at once with a pattern:
167
+
168
+ ```shell
169
+ huggingface-cli download TheBloke/Marcoroni-7b-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
170
+ ```
171
+
172
+ 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).
173
+
174
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
175
+
176
+ ```shell
177
+ pip3 install hf_transfer
178
+ ```
179
+
180
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
181
+
182
+ ```shell
183
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Marcoroni-7b-GGUF marcoroni-7b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
184
+ ```
185
+
186
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
187
+ </details>
188
+ <!-- README_GGUF.md-how-to-download end -->
189
+
190
  <!-- README_GGUF.md-how-to-run start -->
191
  ## Example `llama.cpp` command
192
 
193
  Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
194
 
195
  ```shell
196
+ ./main -ngl 32 -m marcoroni-7b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "{prompt}"
197
  ```
198
 
199
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
 
272
 
273
  **Special thanks to**: Aemon Algiz.
274
 
275
+ **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
276
 
277
 
278
  Thank you to all my generous patrons and donaters!