TheBloke commited on
Commit
2fa2968
1 Parent(s): a7f48f4

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +58 -1
README.md CHANGED
@@ -140,6 +140,63 @@ Refer to the Provided Files table below to see what files use which methods, and
140
 
141
  <!-- README_GGUF.md-provided-files end -->
142
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
143
  <!-- README_GGUF.md-how-to-run start -->
144
  ## Example `llama.cpp` command
145
 
@@ -225,7 +282,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
225
 
226
  **Special thanks to**: Aemon Algiz.
227
 
228
- **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
229
 
230
 
231
  Thank you to all my generous patrons and donaters!
 
140
 
141
  <!-- README_GGUF.md-provided-files end -->
142
 
143
+ <!-- README_GGUF.md-how-to-download start -->
144
+ ## How to download GGUF files
145
+
146
+ **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.
147
+
148
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
149
+ - LM Studio
150
+ - LoLLMS Web UI
151
+ - Faraday.dev
152
+
153
+ ### In `text-generation-webui`
154
+
155
+ Under Download Model, you can enter the model repo: TheBloke/Llama-2-13B-Chat-Dutch-GGUF and below it, a specific filename to download, such as: llama-2-13b-chat-dutch.q4_K_M.gguf.
156
+
157
+ Then click Download.
158
+
159
+ ### On the command line, including multiple files at once
160
+
161
+ I recommend using the `huggingface-hub` Python library:
162
+
163
+ ```shell
164
+ pip3 install huggingface-hub>=0.17.1
165
+ ```
166
+
167
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
168
+
169
+ ```shell
170
+ huggingface-cli download TheBloke/Llama-2-13B-Chat-Dutch-GGUF llama-2-13b-chat-dutch.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
171
+ ```
172
+
173
+ <details>
174
+ <summary>More advanced huggingface-cli download usage</summary>
175
+
176
+ You can also download multiple files at once with a pattern:
177
+
178
+ ```shell
179
+ huggingface-cli download TheBloke/Llama-2-13B-Chat-Dutch-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
180
+ ```
181
+
182
+ 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).
183
+
184
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
185
+
186
+ ```shell
187
+ pip3 install hf_transfer
188
+ ```
189
+
190
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
191
+
192
+ ```shell
193
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Llama-2-13B-Chat-Dutch-GGUF llama-2-13b-chat-dutch.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
194
+ ```
195
+
196
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
197
+ </details>
198
+ <!-- README_GGUF.md-how-to-download end -->
199
+
200
  <!-- README_GGUF.md-how-to-run start -->
201
  ## Example `llama.cpp` command
202
 
 
282
 
283
  **Special thanks to**: Aemon Algiz.
284
 
285
+ **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
286
 
287
 
288
  Thank you to all my generous patrons and donaters!