TheBloke commited on
Commit
b51c35c
1 Parent(s): 8d73ac7

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +585 -0
README.md ADDED
@@ -0,0 +1,585 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: WizardLM/WizardCoder-33B-V1.1
3
+ inference: false
4
+ library_name: transformers
5
+ metrics:
6
+ - code_eval
7
+ model-index:
8
+ - name: WizardCoder
9
+ results:
10
+ - dataset:
11
+ name: HumanEval
12
+ type: openai_humaneval
13
+ metrics:
14
+ - name: pass@1
15
+ type: pass@1
16
+ value: 0.799
17
+ verified: false
18
+ task:
19
+ type: text-generation
20
+ model_creator: WizardLM
21
+ model_name: Wizardcoder 33B V1.1
22
+ model_type: deepseek
23
+ prompt_template: 'Below is an instruction that describes a task. Write a response
24
+ that appropriately completes the request.
25
+
26
+
27
+ ### Instruction:
28
+
29
+ {prompt}
30
+
31
+
32
+ ### Response:
33
+
34
+ '
35
+ quantized_by: TheBloke
36
+ tags:
37
+ - code
38
+ ---
39
+ <!-- markdownlint-disable MD041 -->
40
+
41
+ <!-- header start -->
42
+ <!-- 200823 -->
43
+ <div style="width: auto; margin-left: auto; margin-right: auto">
44
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
45
+ </div>
46
+ <div style="display: flex; justify-content: space-between; width: 100%;">
47
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
48
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
49
+ </div>
50
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
51
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
52
+ </div>
53
+ </div>
54
+ <div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
55
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
56
+ <!-- header end -->
57
+
58
+ # Wizardcoder 33B V1.1 - GGUF
59
+ - Model creator: [WizardLM](https://huggingface.co/WizardLM)
60
+ - Original model: [Wizardcoder 33B V1.1](https://huggingface.co/WizardLM/WizardCoder-33B-V1.1)
61
+
62
+ <!-- description start -->
63
+ ## Description
64
+
65
+ This repo contains GGUF format model files for [WizardLM's Wizardcoder 33B V1.1](https://huggingface.co/WizardLM/WizardCoder-33B-V1.1).
66
+
67
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
68
+
69
+ <!-- description end -->
70
+ <!-- README_GGUF.md-about-gguf start -->
71
+ ### About GGUF
72
+
73
+ 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.
74
+
75
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
76
+
77
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
78
+ * [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.
79
+ * [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.
80
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
81
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
82
+ * [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.
83
+ * [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.
84
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
85
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
86
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
87
+
88
+ <!-- README_GGUF.md-about-gguf end -->
89
+ <!-- repositories-available start -->
90
+ ## Repositories available
91
+
92
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-AWQ)
93
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GPTQ)
94
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF)
95
+ * [WizardLM's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/WizardLM/WizardCoder-33B-V1.1)
96
+ <!-- repositories-available end -->
97
+
98
+ <!-- prompt-template start -->
99
+ ## Prompt template: Alpaca
100
+
101
+ ```
102
+ Below is an instruction that describes a task. Write a response that appropriately completes the request.
103
+
104
+ ### Instruction:
105
+ {prompt}
106
+
107
+ ### Response:
108
+
109
+ ```
110
+
111
+ <!-- prompt-template end -->
112
+
113
+
114
+ <!-- compatibility_gguf start -->
115
+ ## Compatibility
116
+
117
+ These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
118
+
119
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
120
+
121
+ ## Explanation of quantisation methods
122
+
123
+ <details>
124
+ <summary>Click to see details</summary>
125
+
126
+ The new methods available are:
127
+
128
+ * GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
129
+ * GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
130
+ * GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
131
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
132
+ * GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
133
+
134
+ Refer to the Provided Files table below to see what files use which methods, and how.
135
+ </details>
136
+ <!-- compatibility_gguf end -->
137
+
138
+ <!-- README_GGUF.md-provided-files start -->
139
+ ## Provided files
140
+
141
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
142
+ | ---- | ---- | ---- | ---- | ---- | ----- |
143
+ | [wizardcoder-33b-v1.1.Q2_K.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q2_K.gguf) | Q2_K | 2 | 14.03 GB| 16.53 GB | smallest, significant quality loss - not recommended for most purposes |
144
+ | [wizardcoder-33b-v1.1.Q3_K_S.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q3_K_S.gguf) | Q3_K_S | 3 | 14.42 GB| 16.92 GB | very small, high quality loss |
145
+ | [wizardcoder-33b-v1.1.Q3_K_M.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q3_K_M.gguf) | Q3_K_M | 3 | 16.07 GB| 18.57 GB | very small, high quality loss |
146
+ | [wizardcoder-33b-v1.1.Q3_K_L.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q3_K_L.gguf) | Q3_K_L | 3 | 17.56 GB| 20.06 GB | small, substantial quality loss |
147
+ | [wizardcoder-33b-v1.1.Q4_0.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q4_0.gguf) | Q4_0 | 4 | 18.82 GB| 21.32 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
148
+ | [wizardcoder-33b-v1.1.Q4_K_S.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q4_K_S.gguf) | Q4_K_S | 4 | 18.89 GB| 21.39 GB | small, greater quality loss |
149
+ | [wizardcoder-33b-v1.1.Q4_K_M.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q4_K_M.gguf) | Q4_K_M | 4 | 19.94 GB| 22.44 GB | medium, balanced quality - recommended |
150
+ | [wizardcoder-33b-v1.1.Q5_0.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q5_0.gguf) | Q5_0 | 5 | 22.96 GB| 25.46 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
151
+ | [wizardcoder-33b-v1.1.Q5_K_S.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q5_K_S.gguf) | Q5_K_S | 5 | 22.96 GB| 25.46 GB | large, low quality loss - recommended |
152
+ | [wizardcoder-33b-v1.1.Q5_K_M.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q5_K_M.gguf) | Q5_K_M | 5 | 23.54 GB| 26.04 GB | large, very low quality loss - recommended |
153
+ | [wizardcoder-33b-v1.1.Q6_K.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q6_K.gguf) | Q6_K | 6 | 27.36 GB| 29.86 GB | very large, extremely low quality loss |
154
+ | [wizardcoder-33b-v1.1.Q8_0.gguf](https://huggingface.co/TheBloke/WizardCoder-33B-V1.1-GGUF/blob/main/wizardcoder-33b-v1.1.Q8_0.gguf) | Q8_0 | 8 | 35.43 GB| 37.93 GB | very large, extremely low quality loss - not recommended |
155
+
156
+ **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
157
+
158
+
159
+
160
+ <!-- README_GGUF.md-provided-files end -->
161
+
162
+ <!-- README_GGUF.md-how-to-download start -->
163
+ ## How to download GGUF files
164
+
165
+ **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.
166
+
167
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
168
+
169
+ * LM Studio
170
+ * LoLLMS Web UI
171
+ * Faraday.dev
172
+
173
+ ### In `text-generation-webui`
174
+
175
+ Under Download Model, you can enter the model repo: TheBloke/WizardCoder-33B-V1.1-GGUF and below it, a specific filename to download, such as: wizardcoder-33b-v1.1.Q4_K_M.gguf.
176
+
177
+ Then click Download.
178
+
179
+ ### On the command line, including multiple files at once
180
+
181
+ I recommend using the `huggingface-hub` Python library:
182
+
183
+ ```shell
184
+ pip3 install huggingface-hub
185
+ ```
186
+
187
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
188
+
189
+ ```shell
190
+ huggingface-cli download TheBloke/WizardCoder-33B-V1.1-GGUF wizardcoder-33b-v1.1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
191
+ ```
192
+
193
+ <details>
194
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
195
+
196
+ You can also download multiple files at once with a pattern:
197
+
198
+ ```shell
199
+ huggingface-cli download TheBloke/WizardCoder-33B-V1.1-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
200
+ ```
201
+
202
+ 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).
203
+
204
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
205
+
206
+ ```shell
207
+ pip3 install hf_transfer
208
+ ```
209
+
210
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
211
+
212
+ ```shell
213
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/WizardCoder-33B-V1.1-GGUF wizardcoder-33b-v1.1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
214
+ ```
215
+
216
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
217
+ </details>
218
+ <!-- README_GGUF.md-how-to-download end -->
219
+
220
+ <!-- README_GGUF.md-how-to-run start -->
221
+ ## Example `llama.cpp` command
222
+
223
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
224
+
225
+ ```shell
226
+ ./main -ngl 35 -m wizardcoder-33b-v1.1.Q4_K_M.gguf --color -c 16384 --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:"
227
+ ```
228
+
229
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
230
+
231
+ Change `-c 16384` 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. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
232
+
233
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
234
+
235
+ For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
236
+
237
+ ## How to run in `text-generation-webui`
238
+
239
+ Further instructions can be found in the text-generation-webui documentation, here: [text-generation-webui/docs/04 ‐ Model Tab.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/04%20%E2%80%90%20Model%20Tab.md#llamacpp).
240
+
241
+ ## How to run from Python code
242
+
243
+ You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.
244
+
245
+ ### How to load this model in Python code, using llama-cpp-python
246
+
247
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
248
+
249
+ #### First install the package
250
+
251
+ Run one of the following commands, according to your system:
252
+
253
+ ```shell
254
+ # Base ctransformers with no GPU acceleration
255
+ pip install llama-cpp-python
256
+ # With NVidia CUDA acceleration
257
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
258
+ # Or with OpenBLAS acceleration
259
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
260
+ # Or with CLBLast acceleration
261
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
262
+ # Or with AMD ROCm GPU acceleration (Linux only)
263
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
264
+ # Or with Metal GPU acceleration for macOS systems only
265
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
266
+
267
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
268
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
269
+ pip install llama-cpp-python
270
+ ```
271
+
272
+ #### Simple llama-cpp-python example code
273
+
274
+ ```python
275
+ from llama_cpp import Llama
276
+
277
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
278
+ llm = Llama(
279
+ model_path="./wizardcoder-33b-v1.1.Q4_K_M.gguf", # Download the model file first
280
+ n_ctx=16384, # The max sequence length to use - note that longer sequence lengths require much more resources
281
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
282
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
283
+ )
284
+
285
+ # Simple inference example
286
+ output = llm(
287
+ "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:", # Prompt
288
+ max_tokens=512, # Generate up to 512 tokens
289
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
290
+ echo=True # Whether to echo the prompt
291
+ )
292
+
293
+ # Chat Completion API
294
+
295
+ llm = Llama(model_path="./wizardcoder-33b-v1.1.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
296
+ llm.create_chat_completion(
297
+ messages = [
298
+ {"role": "system", "content": "You are a story writing assistant."},
299
+ {
300
+ "role": "user",
301
+ "content": "Write a story about llamas."
302
+ }
303
+ ]
304
+ )
305
+ ```
306
+
307
+ ## How to use with LangChain
308
+
309
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
310
+
311
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
312
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
313
+
314
+ <!-- README_GGUF.md-how-to-run end -->
315
+
316
+ <!-- footer start -->
317
+ <!-- 200823 -->
318
+ ## Discord
319
+
320
+ For further support, and discussions on these models and AI in general, join us at:
321
+
322
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
323
+
324
+ ## Thanks, and how to contribute
325
+
326
+ Thanks to the [chirper.ai](https://chirper.ai) team!
327
+
328
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
329
+
330
+ 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.
331
+
332
+ 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.
333
+
334
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
335
+
336
+ * Patreon: https://patreon.com/TheBlokeAI
337
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
338
+
339
+ **Special thanks to**: Aemon Algiz.
340
+
341
+ **Patreon special mentions**: Michael Levine, 阿明, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjäreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros
342
+
343
+
344
+ Thank you to all my generous patrons and donaters!
345
+
346
+ And thank you again to a16z for their generous grant.
347
+
348
+ <!-- footer end -->
349
+
350
+ <!-- original-model-card start -->
351
+ # Original model card: WizardLM's Wizardcoder 33B V1.1
352
+
353
+
354
+ ## WizardCoder: Empowering Code Large Language Models with Evol-Instruct
355
+
356
+ <p style="font-size:28px;" align="center">
357
+ 🏠 <a href="https://wizardlm.github.io/" target="_blank">Home Page</a> </p>
358
+ <p align="center">
359
+ <p align="center">
360
+ 🤗 <a href="https://huggingface.co/WizardLM" target="_blank">HF Repo</a> •🐱 <a href="https://github.com/nlpxucan/WizardLM" target="_blank">Github Repo</a> • 🐦 <a href="https://twitter.com/WizardLM_AI" target="_blank">Twitter</a> </p>
361
+ <p align="center">
362
+ 📃 <a href="https://arxiv.org/abs/2304.12244" target="_blank">[WizardLM]</a> • 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> • 📃 <a href="https://arxiv.org/abs/2308.09583" target="_blank">[WizardMath]</a> <br>
363
+ </p>
364
+ <p align="center">
365
+ 👋 Join our <a href="https://discord.gg/VZjjHtWrKs" target="_blank">Discord</a>
366
+ </p>
367
+
368
+ ## News
369
+
370
+ [2023/01/04] 🔥 We released **WizardCoder-33B-V1.1** trained from deepseek-coder-33b-base, the **SOTA OSS Code LLM** on [EvalPlus Leaderboard](https://evalplus.github.io/leaderboard.html), achieves **79.9 pass@1** on HumanEval, **73.2 pass@1** on HumanEval-Plus, **78.9 pass@1** on MBPP, and **66.9 pass@1** on MBPP-Plus.
371
+
372
+ [2023/01/04] 🔥 **WizardCoder-33B-V1.1** outperforms **ChatGPT 3.5**, **Gemini Pro**, and **DeepSeek-Coder-33B-instruct** on HumanEval and HumanEval-Plus pass@1.
373
+
374
+ [2023/01/04] 🔥 **WizardCoder-33B-V1.1** is comparable with **ChatGPT 3.5**, and surpasses **Gemini Pro** on MBPP and MBPP-Plus pass@1.
375
+
376
+ | Model | Checkpoint | Paper | HumanEval | HumanEval+ | MBPP | MBPP+ | License |
377
+ | ----- |------| ---- |------|-------| ----- | ----- |----- |
378
+ | GPT-4-Turbo (Nov 2023) | - | - | 85.4 | 81.7 | 83.0 | 70.7 |-|
379
+ | GPT-4 (May 2023) | - | - | 88.4 | 76.8 | - | - |-|
380
+ | GPT-3.5-Turbo (Nov 2023) | - | - | 72.6 | 65.9 | 81.7 | 69.4 |-|
381
+ | Gemini Pro | - | - | 63.4 | 55.5 | 72.9 | 57.9 |-|
382
+ | DeepSeek-Coder-33B-instruct | - | - | 78.7 | 72.6 | 78.7 | 66.7 |-|
383
+ | **WizardCoder-33B-V1.1** | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-33B-V1.1" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 79.9 | 73.2 | 78.9 | 66.9 | <a href="https://huggingface.co/WizardLM/WizardMath-7B-V1.1/resolve/main/LICENSE" target="_blank">MSFTResearch</a> |
384
+ | WizardCoder-Python-34B-V1.0 | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-Python-34B-V1.0" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 73.2 | 64.6 | 73.2 | 59.9 | <a href="https://ai.meta.com/resources/models-and-libraries/llama-downloads/" target="_blank">Llama2</a> |
385
+ | WizardCoder-15B-V1.0 | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-15B-V1.0" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 59.8 | 52.4 | -- | -- | <a href="https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement" target="_blank">OpenRAIL-M</a> |
386
+ | WizardCoder-Python-13B-V1.0 | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-Python-13B-V1.0" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 64.0 | -- | -- | -- | <a href="https://ai.meta.com/resources/models-and-libraries/llama-downloads/" target="_blank">Llama2</a> |
387
+ | WizardCoder-Python-7B-V1.0 | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-Python-7B-V1.0" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 55.5 | -- | -- | -- | <a href="https://ai.meta.com/resources/models-and-libraries/llama-downloads/" target="_blank">Llama2</a> |
388
+ | WizardCoder-3B-V1.0 | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-3B-V1.0" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 34.8 | -- | -- | -- | <a href="https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement" target="_blank">OpenRAIL-M</a> |
389
+ | WizardCoder-1B-V1.0 | 🤗 <a href="https://huggingface.co/WizardLM/WizardCoder-1B-V1.0" target="_blank">HF Link</a> | 📃 <a href="https://arxiv.org/abs/2306.08568" target="_blank">[WizardCoder]</a> | 23.8 | -- | -- | -- | <a href="https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement" target="_blank">OpenRAIL-M</a> |
390
+
391
+
392
+ ## ❗ Data Contamination Check:
393
+
394
+ Before model training, we carefully and rigorously checked all the training data, and used multiple deduplication methods to verify and prevent data leakage on HumanEval and MBPP test set.
395
+
396
+ 🔥
397
+ ❗<b>Note for model system prompts usage:</b>
398
+
399
+ Please use **the same systems prompts strictly** with us, and we do not guarantee the accuracy of the **quantified versions**.
400
+
401
+ **Default version:**
402
+
403
+ ```
404
+ "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{instruction}\n\n### Response:"
405
+ ```
406
+
407
+
408
+ ## How to Reproduce the Performance of WizardCoder-33B-V1.1
409
+
410
+ We provide all codes [here](https://github.com/nlpxucan/WizardLM/tree/main/WizardCoder/src).
411
+
412
+ We also provide all generated [results](https://github.com/nlpxucan/WizardLM/blob/main/WizardCoder/data/humaneval_mbpp_wizardcoder33b_v1.1_results.zip).
413
+
414
+ ```
415
+ transformers==4.36.2
416
+ vllm==0.2.5
417
+ ```
418
+
419
+ (1) HumanEval and HumanEval-Plus
420
+
421
+ - Step 1
422
+
423
+ Code Generation (w/o accelerate)
424
+ ```bash
425
+ model="WizardLM/WizardCoder-33B-V1.1"
426
+ temp=0.0
427
+ max_len=2048
428
+ pred_num=1
429
+ num_seqs_per_iter=1
430
+
431
+ output_path=preds/T${temp}_N${pred_num}_WizardCoder-33B-V1.1_Greedy_Decode
432
+
433
+ mkdir -p ${output_path}
434
+ echo 'Output path: '$output_path
435
+ echo 'Model to eval: '$model
436
+
437
+ # 164 problems, 21 per GPU if GPU=8
438
+ index=0
439
+ gpu_num=8
440
+ for ((i = 0; i < $gpu_num; i++)); do
441
+ start_index=$((i * 21))
442
+ end_index=$(((i + 1) * 21))
443
+
444
+ gpu=$((i))
445
+ echo 'Running process #' ${i} 'from' $start_index 'to' $end_index 'on GPU' ${gpu}
446
+ ((index++))
447
+ (
448
+ CUDA_VISIBLE_DEVICES=$gpu python humaneval_gen.py --model ${model} \
449
+ --start_index ${start_index} --end_index ${end_index} --temperature ${temp} \
450
+ --num_seqs_per_iter ${num_seqs_per_iter} --N ${pred_num} --max_len ${max_len} --output_path ${output_path} --greedy_decode
451
+ ) &
452
+ if (($index % $gpu_num == 0)); then wait; fi
453
+ done
454
+ ```
455
+
456
+ Code Generation (w/ vllm accelerate)
457
+ ```bash
458
+ model="WizardLM/WizardCoder-33B-V1.1"
459
+ temp=0.0
460
+ max_len=2048
461
+ pred_num=1
462
+ num_seqs_per_iter=1
463
+
464
+ output_path=preds/T${temp}_N${pred_num}_WizardCoder-33B-V1.1_Greedy_Decode_vllm
465
+
466
+ mkdir -p ${output_path}
467
+ echo 'Output path: '$output_path
468
+ echo 'Model to eval: '$model
469
+
470
+ CUDA_VISIBLE_DEVICES=0,1,2,3 python humaneval_gen_vllm.py --model ${model} \
471
+ --start_index 0 --end_index 164 --temperature ${temp} \
472
+ --num_seqs_per_iter ${num_seqs_per_iter} --N ${pred_num} --max_len ${max_len} --output_path ${output_path} --num_gpus 4 --overwrite
473
+ ```
474
+
475
+ - Step 2: Get the score
476
+
477
+ Install [Eval-Plus](https://github.com/evalplus/evalplus) benchmark.
478
+ ```bash
479
+ git clone https://github.com/evalplus/evalplus.git
480
+ cd evalplus
481
+ export PYTHONPATH=$PYTHONPATH:$(pwd)
482
+ pip install -r requirements.txt
483
+ ```
484
+ Get HumanEval and HumanEval-Plus scores.
485
+ ```bash
486
+ output_path=preds/T0.0_N1_WizardCoder-33B-V1.1_Greedy_Decode
487
+
488
+ echo 'Output path: '$output_path
489
+ python process_humaneval.py --path ${output_path} --out_path ${output_path}.jsonl --add_prompt
490
+
491
+ evalplus.evaluate --dataset humaneval --samples ${output_path}.jsonl
492
+ ```
493
+
494
+ (2) MBPP and MBPP-Plus
495
+
496
+ The preprocessed questions are provided in [mbppplus.json](https://github.com/nlpxucan/WizardLM/blob/main/WizardCoder/data/mbppplus.json).
497
+
498
+ - Step 1
499
+
500
+ Code Generation (w/o accelerate)
501
+ ```bash
502
+ model="WizardLM/WizardCoder-33B-V1.1"
503
+ temp=0.0
504
+ max_len=2048
505
+ pred_num=1
506
+ num_seqs_per_iter=1
507
+
508
+ output_path=preds/MBPP_T${temp}_N${pred_num}_WizardCoder-33B-V1.1_Greedy_Decode
509
+
510
+ mkdir -p ${output_path}
511
+ echo 'Output path: '$output_path
512
+ echo 'Model to eval: '$model
513
+
514
+ # 399 problems, 50 per GPU if GPU=8
515
+ index=0
516
+ gpu_num=8
517
+ for ((i = 0; i < $gpu_num; i++)); do
518
+ start_index=$((i * 50))
519
+ end_index=$(((i + 1) * 50))
520
+
521
+ gpu=$((i))
522
+ echo 'Running process #' ${i} 'from' $start_index 'to' $end_index 'on GPU' ${gpu}
523
+ ((index++))
524
+ (
525
+ CUDA_VISIBLE_DEVICES=$gpu python mbppplus_gen.py --model ${model} \
526
+ --start_index ${start_index} --end_index ${end_index} --temperature ${temp} \
527
+ --num_seqs_per_iter ${num_seqs_per_iter} --N ${pred_num} --max_len ${max_len} --output_path ${output_path} --mbpp_path "mbppplus.json" --greedy_decode
528
+ ) &
529
+ if (($index % $gpu_num == 0)); then wait; fi
530
+ done
531
+ ```
532
+
533
+ Code Generation (w/ vllm accelerate)
534
+ ```bash
535
+ model="WizardLM/WizardCoder-33B-V1.1"
536
+ temp=0.0
537
+ max_len=2048
538
+ pred_num=1
539
+ num_seqs_per_iter=1
540
+
541
+ output_path=preds/MBPP_T${temp}_N${pred_num}_WizardCoder-33B-V1.1_Greedy_Decode_vllm
542
+
543
+ mkdir -p ${output_path}
544
+ echo 'Output path: '$output_path
545
+ echo 'Model to eval: '$model
546
+
547
+ CUDA_VISIBLE_DEVICES=0,1,2,3 python mbppplus_gen_vllm.py --model ${model} \
548
+ --start_index ${start_index} --end_index ${end_index} --temperature ${temp} \
549
+ --num_seqs_per_iter ${num_seqs_per_iter} --N ${pred_num} --max_len ${max_len} --output_path ${output_path} --mbpp_path "mbppplus.json" --num_gpus 4
550
+ ```
551
+
552
+ - Step 2: Get the score
553
+
554
+ Install [Eval-Plus](https://github.com/evalplus/evalplus) benchmark.
555
+ ```bash
556
+ git clone https://github.com/evalplus/evalplus.git
557
+ cd evalplus
558
+ export PYTHONPATH=$PYTHONPATH:$(pwd)
559
+ pip install -r requirements.txt
560
+ ```
561
+ Get HumanEval and HumanEval-Plus scores.
562
+ ```bash
563
+ output_path=preds/MBPP_T0.0_N1_WizardCoder-33B-V1.1_Greedy_Decode
564
+
565
+ echo 'Output path: '$output_path
566
+ python mbppplus_process_preds.py --path ${output_path} --out_path ${output_path}.jsonl --add_prompt
567
+
568
+ evalplus.evaluate --dataset mbpp --samples ${output_path}.jsonl
569
+ ```
570
+
571
+
572
+ ## Citation
573
+
574
+ Please cite the repo if you use the data, method or code in this repo.
575
+
576
+ ```
577
+ @article{luo2023wizardcoder,
578
+ title={WizardCoder: Empowering Code Large Language Models with Evol-Instruct},
579
+ author={Luo, Ziyang and Xu, Can and Zhao, Pu and Sun, Qingfeng and Geng, Xiubo and Hu, Wenxiang and Tao, Chongyang and Ma, Jing and Lin, Qingwei and Jiang, Daxin},
580
+ journal={arXiv preprint arXiv:2306.08568},
581
+ year={2023}
582
+ }
583
+ ```
584
+
585
+ <!-- original-model-card end -->