TheBloke commited on
Commit
48cf2a7
1 Parent(s): 5e3624c

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +83 -20
README.md CHANGED
@@ -1,13 +1,16 @@
1
  ---
 
2
  inference: false
3
  language:
4
  - code
5
  license: llama2
6
  model_creator: Meta
7
- model_link: https://huggingface.co/codellama/CodeLlama-7b-hf
8
  model_name: CodeLlama 7B
9
  model_type: llama
10
  pipeline_tag: text-generation
 
 
 
11
  quantized_by: TheBloke
12
  tags:
13
  - llama-2
@@ -34,23 +37,25 @@ tags:
34
  - Model creator: [Meta](https://huggingface.co/meta-llama)
35
  - Original model: [CodeLlama 7B](https://huggingface.co/codellama/CodeLlama-7b-hf)
36
 
 
37
  ## Description
38
 
39
  This repo contains GGUF format model files for [Meta's CodeLlama 7B](https://huggingface.co/codellama/CodeLlama-7b-hf).
40
 
 
41
  <!-- README_GGUF.md-about-gguf start -->
42
  ### About GGUF
43
 
44
- 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.
45
 
46
- 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.
47
 
48
- Here are a list of clients and libraries that are known to support GGUF:
49
- * [llama.cpp](https://github.com/ggerganov/llama.cpp).
50
- * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions.
51
- * [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.
52
- * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
53
  * [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.
 
54
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
55
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
56
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
@@ -59,9 +64,9 @@ Here are a list of clients and libraries that are known to support GGUF:
59
  <!-- repositories-available start -->
60
  ## Repositories available
61
 
 
62
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/CodeLlama-7B-GPTQ)
63
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/CodeLlama-7B-GGUF)
64
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/CodeLlama-7B-GGML)
65
  * [Meta's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/codellama/CodeLlama-7b-hf)
66
  <!-- repositories-available end -->
67
 
@@ -74,12 +79,14 @@ Here are a list of clients and libraries that are known to support GGUF:
74
  ```
75
 
76
  <!-- prompt-template end -->
 
 
77
  <!-- compatibility_gguf start -->
78
  ## Compatibility
79
 
80
- 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)
81
 
82
- They are now also compatible with many third party UIs and libraries - please see the list at the top of the README.
83
 
84
  ## Explanation of quantisation methods
85
  <details>
@@ -120,21 +127,75 @@ Refer to the Provided Files table below to see what files use which methods, and
120
 
121
  <!-- README_GGUF.md-provided-files end -->
122
 
123
- <!-- README_GGUF.md-how-to-run start -->
124
- ## Example `llama.cpp` command
 
 
 
 
 
 
 
 
 
 
 
125
 
126
- Make sure you are using `llama.cpp` from commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9) or later.
127
 
128
- 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.
129
 
 
 
 
 
 
 
 
 
 
 
130
  ```
131
- ./main -t 10 -ngl 32 -m codellama-7b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "{prompt}"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
132
  ```
133
- 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`.
134
 
135
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
136
 
137
- 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.
138
 
139
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
140
 
@@ -191,10 +252,12 @@ For further support, and discussions on these models and AI in general, join us
191
 
192
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
193
 
194
- ## Thanks, and how to contribute.
195
 
196
  Thanks to the [chirper.ai](https://chirper.ai) team!
197
 
 
 
198
  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.
199
 
200
  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.
@@ -206,7 +269,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
206
 
207
  **Special thanks to**: Aemon Algiz.
208
 
209
- **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
210
 
211
 
212
  Thank you to all my generous patrons and donaters!
 
1
  ---
2
+ base_model: https://huggingface.co/codellama/CodeLlama-7b-hf
3
  inference: false
4
  language:
5
  - code
6
  license: llama2
7
  model_creator: Meta
 
8
  model_name: CodeLlama 7B
9
  model_type: llama
10
  pipeline_tag: text-generation
11
+ prompt_template: '{prompt}
12
+
13
+ '
14
  quantized_by: TheBloke
15
  tags:
16
  - llama-2
 
37
  - Model creator: [Meta](https://huggingface.co/meta-llama)
38
  - Original model: [CodeLlama 7B](https://huggingface.co/codellama/CodeLlama-7b-hf)
39
 
40
+ <!-- description start -->
41
  ## Description
42
 
43
  This repo contains GGUF format model files for [Meta's CodeLlama 7B](https://huggingface.co/codellama/CodeLlama-7b-hf).
44
 
45
+ <!-- description end -->
46
  <!-- README_GGUF.md-about-gguf start -->
47
  ### About GGUF
48
 
49
+ 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.
50
 
51
+ Here is an incomplate list of clients and libraries that are known to support GGUF:
52
 
53
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
54
+ * [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.
55
+ * [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.
56
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 
57
  * [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.
58
+ * [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.
59
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
60
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
61
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
 
64
  <!-- repositories-available start -->
65
  ## Repositories available
66
 
67
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/CodeLlama-7B-AWQ)
68
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/CodeLlama-7B-GPTQ)
69
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/CodeLlama-7B-GGUF)
 
70
  * [Meta's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/codellama/CodeLlama-7b-hf)
71
  <!-- repositories-available end -->
72
 
 
79
  ```
80
 
81
  <!-- prompt-template end -->
82
+
83
+
84
  <!-- compatibility_gguf start -->
85
  ## Compatibility
86
 
87
+ 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)
88
 
89
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
90
 
91
  ## Explanation of quantisation methods
92
  <details>
 
127
 
128
  <!-- README_GGUF.md-provided-files end -->
129
 
130
+ <!-- README_GGUF.md-how-to-download start -->
131
+ ## How to download GGUF files
132
+
133
+ **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.
134
+
135
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
136
+ - LM Studio
137
+ - LoLLMS Web UI
138
+ - Faraday.dev
139
+
140
+ ### In `text-generation-webui`
141
+
142
+ Under Download Model, you can enter the model repo: TheBloke/CodeLlama-7B-GGUF and below it, a specific filename to download, such as: codellama-7b.q4_K_M.gguf.
143
 
144
+ Then click Download.
145
 
146
+ ### On the command line, including multiple files at once
147
 
148
+ I recommend using the `huggingface-hub` Python library:
149
+
150
+ ```shell
151
+ pip3 install huggingface-hub>=0.17.1
152
+ ```
153
+
154
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
155
+
156
+ ```shell
157
+ huggingface-cli download TheBloke/CodeLlama-7B-GGUF codellama-7b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
158
  ```
159
+
160
+ <details>
161
+ <summary>More advanced huggingface-cli download usage</summary>
162
+
163
+ You can also download multiple files at once with a pattern:
164
+
165
+ ```shell
166
+ huggingface-cli download TheBloke/CodeLlama-7B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
167
+ ```
168
+
169
+ 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).
170
+
171
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
172
+
173
+ ```shell
174
+ pip3 install hf_transfer
175
+ ```
176
+
177
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
178
+
179
+ ```shell
180
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/CodeLlama-7B-GGUF codellama-7b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
181
+ ```
182
+
183
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
184
+ </details>
185
+ <!-- README_GGUF.md-how-to-download end -->
186
+
187
+ <!-- README_GGUF.md-how-to-run start -->
188
+ ## Example `llama.cpp` command
189
+
190
+ Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
191
+
192
+ ```shell
193
+ ./main -ngl 32 -m codellama-7b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "{prompt}"
194
  ```
 
195
 
196
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
197
 
198
+ 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.
199
 
200
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
201
 
 
252
 
253
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
254
 
255
+ ## Thanks, and how to contribute
256
 
257
  Thanks to the [chirper.ai](https://chirper.ai) team!
258
 
259
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
260
+
261
  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.
262
 
263
  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.
 
269
 
270
  **Special thanks to**: Aemon Algiz.
271
 
272
+ **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
273
 
274
 
275
  Thank you to all my generous patrons and donaters!