TheBloke commited on
Commit
72788d0
1 Parent(s): 1d244ce

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +424 -0
README.md ADDED
@@ -0,0 +1,424 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: IDEA-CCNL/Ziya-Coding-34B-v1.0
3
+ inference: false
4
+ language:
5
+ - zh
6
+ - en
7
+ library_name: transformers
8
+ license: gpl-3.0
9
+ model_creator: Fengshenbang-LM
10
+ model_name: Ziya Coding 34B v1.0
11
+ model_type: llama
12
+ pipeline_tag: text-generation
13
+ prompt_template: "<human>: \nPlease Complete the given function below according to\
14
+ \ the docstring: \n{prompt}\n<bot>: \n"
15
+ quantized_by: TheBloke
16
+ ---
17
+
18
+ <!-- header start -->
19
+ <!-- 200823 -->
20
+ <div style="width: auto; margin-left: auto; margin-right: auto">
21
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
22
+ </div>
23
+ <div style="display: flex; justify-content: space-between; width: 100%;">
24
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
25
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
26
+ </div>
27
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
28
+ <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>
29
+ </div>
30
+ </div>
31
+ <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>
32
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
33
+ <!-- header end -->
34
+
35
+ # Ziya Coding 34B v1.0 - GGUF
36
+ - Model creator: [Fengshenbang-LM](https://huggingface.co/IDEA-CCNL)
37
+ - Original model: [Ziya Coding 34B v1.0](https://huggingface.co/IDEA-CCNL/Ziya-Coding-34B-v1.0)
38
+
39
+ <!-- description start -->
40
+ ## Description
41
+
42
+ This repo contains GGUF format model files for [Fengshenbang-LM's Ziya Coding 34B v1.0](https://huggingface.co/IDEA-CCNL/Ziya-Coding-34B-v1.0).
43
+
44
+ <!-- description end -->
45
+ <!-- README_GGUF.md-about-gguf start -->
46
+ ### About GGUF
47
+
48
+ 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.
49
+
50
+ Here is an incomplate list of clients and libraries that are known to support GGUF:
51
+
52
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
53
+ * [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.
54
+ * [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.
55
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
56
+ * [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.
57
+ * [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.
58
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
59
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
60
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
61
+
62
+ <!-- README_GGUF.md-about-gguf end -->
63
+ <!-- repositories-available start -->
64
+ ## Repositories available
65
+
66
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-AWQ)
67
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GPTQ)
68
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF)
69
+ * [Fengshenbang-LM's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/IDEA-CCNL/Ziya-Coding-34B-v1.0)
70
+ <!-- repositories-available end -->
71
+
72
+ <!-- prompt-template start -->
73
+ ## Prompt template: Ziya
74
+
75
+ ```
76
+ <human>:
77
+ Please Complete the given function below according to the docstring:
78
+ {prompt}
79
+ <bot>:
80
+
81
+ ```
82
+
83
+ <!-- prompt-template end -->
84
+ <!-- licensing start -->
85
+ ## Licensing
86
+
87
+ The creator of the source model has listed its license as `gpl-3.0`, and this quantization has therefore used that same license.
88
+
89
+ As this model is based on Llama 2, it is also subject to the Meta Llama 2 license terms, and the license files for that are additionally included. It should therefore be considered as being claimed to be licensed under both licenses. I contacted Hugging Face for clarification on dual licensing but they do not yet have an official position. Should this change, or should Meta provide any feedback on this situation, I will update this section accordingly.
90
+
91
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [Fengshenbang-LM's Ziya Coding 34B v1.0](https://huggingface.co/IDEA-CCNL/Ziya-Coding-34B-v1.0).
92
+ <!-- licensing end -->
93
+ <!-- compatibility_gguf start -->
94
+ ## Compatibility
95
+
96
+ 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)
97
+
98
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
99
+
100
+ ## Explanation of quantisation methods
101
+ <details>
102
+ <summary>Click to see details</summary>
103
+
104
+ The new methods available are:
105
+ * 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)
106
+ * 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.
107
+ * 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.
108
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
109
+ * 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
110
+
111
+ Refer to the Provided Files table below to see what files use which methods, and how.
112
+ </details>
113
+ <!-- compatibility_gguf end -->
114
+
115
+ <!-- README_GGUF.md-provided-files start -->
116
+ ## Provided files
117
+
118
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
119
+ | ---- | ---- | ---- | ---- | ---- | ----- |
120
+ | [ziya-coding-34b-v1.0.Q2_K.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q2_K.gguf) | Q2_K | 2 | 14.21 GB| 16.71 GB | smallest, significant quality loss - not recommended for most purposes |
121
+ | [ziya-coding-34b-v1.0.Q3_K_S.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q3_K_S.gguf) | Q3_K_S | 3 | 14.61 GB| 17.11 GB | very small, high quality loss |
122
+ | [ziya-coding-34b-v1.0.Q3_K_M.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q3_K_M.gguf) | Q3_K_M | 3 | 16.28 GB| 18.78 GB | very small, high quality loss |
123
+ | [ziya-coding-34b-v1.0.Q3_K_L.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q3_K_L.gguf) | Q3_K_L | 3 | 17.77 GB| 20.27 GB | small, substantial quality loss |
124
+ | [ziya-coding-34b-v1.0.Q4_0.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q4_0.gguf) | Q4_0 | 4 | 19.05 GB| 21.55 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
125
+ | [ziya-coding-34b-v1.0.Q4_K_S.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q4_K_S.gguf) | Q4_K_S | 4 | 19.15 GB| 21.65 GB | small, greater quality loss |
126
+ | [ziya-coding-34b-v1.0.Q4_K_M.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q4_K_M.gguf) | Q4_K_M | 4 | 20.22 GB| 22.72 GB | medium, balanced quality - recommended |
127
+ | [ziya-coding-34b-v1.0.Q5_0.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q5_0.gguf) | Q5_0 | 5 | 23.24 GB| 25.74 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
128
+ | [ziya-coding-34b-v1.0.Q5_K_S.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q5_K_S.gguf) | Q5_K_S | 5 | 23.24 GB| 25.74 GB | large, low quality loss - recommended |
129
+ | [ziya-coding-34b-v1.0.Q5_K_M.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q5_K_M.gguf) | Q5_K_M | 5 | 23.84 GB| 26.34 GB | large, very low quality loss - recommended |
130
+ | [ziya-coding-34b-v1.0.Q6_K.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q6_K.gguf) | Q6_K | 6 | 27.68 GB| 30.18 GB | very large, extremely low quality loss |
131
+ | [ziya-coding-34b-v1.0.Q8_0.gguf](https://huggingface.co/TheBloke/Ziya-Coding-34B-v1.0-GGUF/blob/main/ziya-coding-34b-v1.0.Q8_0.gguf) | Q8_0 | 8 | 35.86 GB| 38.36 GB | very large, extremely low quality loss - not recommended |
132
+
133
+ **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.
134
+
135
+
136
+
137
+ <!-- README_GGUF.md-provided-files end -->
138
+
139
+ <!-- README_GGUF.md-how-to-download start -->
140
+ ## How to download GGUF files
141
+
142
+ **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.
143
+
144
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
145
+ - LM Studio
146
+ - LoLLMS Web UI
147
+ - Faraday.dev
148
+
149
+ ### In `text-generation-webui`
150
+
151
+ Under Download Model, you can enter the model repo: TheBloke/Ziya-Coding-34B-v1.0-GGUF and below it, a specific filename to download, such as: ziya-coding-34b-v1.0.Q4_K_M.gguf.
152
+
153
+ Then click Download.
154
+
155
+ ### On the command line, including multiple files at once
156
+
157
+ I recommend using the `huggingface-hub` Python library:
158
+
159
+ ```shell
160
+ pip3 install huggingface-hub
161
+ ```
162
+
163
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
164
+
165
+ ```shell
166
+ huggingface-cli download TheBloke/Ziya-Coding-34B-v1.0-GGUF ziya-coding-34b-v1.0.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
167
+ ```
168
+
169
+ <details>
170
+ <summary>More advanced huggingface-cli download usage</summary>
171
+
172
+ You can also download multiple files at once with a pattern:
173
+
174
+ ```shell
175
+ huggingface-cli download TheBloke/Ziya-Coding-34B-v1.0-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
176
+ ```
177
+
178
+ 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).
179
+
180
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
181
+
182
+ ```shell
183
+ pip3 install hf_transfer
184
+ ```
185
+
186
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
187
+
188
+ ```shell
189
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Ziya-Coding-34B-v1.0-GGUF ziya-coding-34b-v1.0.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
190
+ ```
191
+
192
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
193
+ </details>
194
+ <!-- README_GGUF.md-how-to-download end -->
195
+
196
+ <!-- README_GGUF.md-how-to-run start -->
197
+ ## Example `llama.cpp` command
198
+
199
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
200
+
201
+ ```shell
202
+ ./main -ngl 32 -m ziya-coding-34b-v1.0.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<human>: \nPlease Complete the given function below according to the docstring: \n{prompt}\n<bot>:"
203
+ ```
204
+
205
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
206
+
207
+ 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.
208
+
209
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
210
+
211
+ 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)
212
+
213
+ ## How to run in `text-generation-webui`
214
+
215
+ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
216
+
217
+ ## How to run from Python code
218
+
219
+ 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.
220
+
221
+ ### How to load this model in Python code, using ctransformers
222
+
223
+ #### First install the package
224
+
225
+ Run one of the following commands, according to your system:
226
+
227
+ ```shell
228
+ # Base ctransformers with no GPU acceleration
229
+ pip install ctransformers
230
+ # Or with CUDA GPU acceleration
231
+ pip install ctransformers[cuda]
232
+ # Or with AMD ROCm GPU acceleration (Linux only)
233
+ CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
234
+ # Or with Metal GPU acceleration for macOS systems only
235
+ CT_METAL=1 pip install ctransformers --no-binary ctransformers
236
+ ```
237
+
238
+ #### Simple ctransformers example code
239
+
240
+ ```python
241
+ from ctransformers import AutoModelForCausalLM
242
+
243
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
244
+ llm = AutoModelForCausalLM.from_pretrained("TheBloke/Ziya-Coding-34B-v1.0-GGUF", model_file="ziya-coding-34b-v1.0.Q4_K_M.gguf", model_type="llama", gpu_layers=50)
245
+
246
+ print(llm("AI is going to"))
247
+ ```
248
+
249
+ ## How to use with LangChain
250
+
251
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
252
+
253
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
254
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
255
+
256
+ <!-- README_GGUF.md-how-to-run end -->
257
+
258
+ <!-- footer start -->
259
+ <!-- 200823 -->
260
+ ## Discord
261
+
262
+ For further support, and discussions on these models and AI in general, join us at:
263
+
264
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
265
+
266
+ ## Thanks, and how to contribute
267
+
268
+ Thanks to the [chirper.ai](https://chirper.ai) team!
269
+
270
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
271
+
272
+ 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.
273
+
274
+ 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.
275
+
276
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
277
+
278
+ * Patreon: https://patreon.com/TheBlokeAI
279
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
280
+
281
+ **Special thanks to**: Aemon Algiz.
282
+
283
+ **Patreon special mentions**: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski
284
+
285
+
286
+ Thank you to all my generous patrons and donaters!
287
+
288
+ And thank you again to a16z for their generous grant.
289
+
290
+ <!-- footer end -->
291
+
292
+ <!-- original-model-card start -->
293
+ # Original model card: Fengshenbang-LM's Ziya Coding 34B v1.0
294
+
295
+
296
+ # Ziya-Coding-34B-v1.0
297
+
298
+
299
+ # 姜子牙系列模型
300
+
301
+ - [Ziya-LLaMA-13B-v1.1](https://huggingface.co/IDEA-CCNL/Ziya-LLaMA-13B-v1.1)
302
+ - [Ziya-LLaMA-13B-v1](https://huggingface.co/IDEA-CCNL/Ziya-LLaMA-13B-v1)
303
+ - [Ziya-LLaMA-7B-Reward](https://huggingface.co/IDEA-CCNL/Ziya-LLaMA-7B-Reward)
304
+ - [Ziya-LLaMA-13B-Pretrain-v1](https://huggingface.co/IDEA-CCNL/Ziya-LLaMA-13B-Pretrain-v1)
305
+ - [Ziya-BLIP2-14B-Visual-v1](https://huggingface.co/IDEA-CCNL/Ziya-BLIP2-14B-Visual-v1)
306
+ - [Ziya-Writing-LLaMa-13B-v1](https://huggingface.co/IDEA-CCNL/Ziya-Writing-LLaMa-13B-v1)
307
+ - [Ziya-Coding-15B-v1](https://huggingface.co/IDEA-CCNL/Ziya-Coding-15B-v1)
308
+
309
+ ## 简介 Brief Introduction
310
+
311
+ 使用自然语言生成高质量的代码是大模型落地中的高频需求。今天,IDEA研究院封神榜团队正式开源最新的代码大模型Ziya-Coding-34B-v1.0,我们在HumanEval Pass@1的评测上,取得了75.5的好成绩,超过了GPT-4(67.0)的得分,也成为目前已知开源模型新高。封神榜团队正在为社区提供先进的大模型技术和经验,帮助生产和定制更多优秀垂类模型,推进大模型生态发展。
312
+
313
+
314
+ Generating high-quality code using natural language is a high-frequency demand in the deployment of large models. Today, the IDEA Research Institute's Fengshenbang team officially open-sourced the latest code model, Ziya-Coding-34B-v1.0. We achieved a good score of 75.5 on the HumanEval Pass@1 evaluation, surpassing the score of GPT-4 (67.0) and setting a new high for known open-source models. The Fengshenbang team is providing the community with advanced large model technology and experience, helping to produce and customize more excellent vertical models, and promoting the development of the large model ecosystem.
315
+
316
+
317
+ 更多细节可以参考我们的公众号文章:
318
+
319
+ [再创新高!姜子牙大模型开源代码大模型Ziya-Coding-34B-v1.0](https://mp.weixin.qq.com/s/Op4Wkiu2J9jwFr_Zj0YSZg)
320
+
321
+ [姜子牙大模型系列 | 代码模型ziya-coding发布!低成本微调即可学会在专有场景编程](https://mp.weixin.qq.com/s/tWaRF1wL3HM87ZDEawd2UA)
322
+
323
+ ## 软件依赖
324
+ ```
325
+ pip install torch==1.12.1 tokenizers==0.13.3 git+https://github.com/huggingface/transformers
326
+ ```
327
+
328
+ ## 模型信息 Model Information
329
+
330
+ 在9月初,我们开源了基于StarCoder-15B的代码模型Ziya-Coding-15B-v1,我们将训练Ziya-Coding-15B-v1积累的训练经验迁移到了新版本的训练中。
331
+
332
+ 我们收集并构造了约45万涵盖了几乎所有代码相关任务的指令数据进行第一阶段的微调,这其中包括约10万的中文指令和35万的英文指令,保证了数据的多样性,在构造数据时,我们充分利用了高质量的无指令代码数据,使用LLM生成对应的指令,扩充得到了更多高质量的代码指令数据。
333
+
334
+ 同时实验过程中,我们注意到,代码指令的难度和正确性是训练代码模型成功的关键。因此,我们引入了第二阶段的精调。我们使用evol-instruct的方法生成了大量高难度多要求的代码指令数据,并利用代码编译器作为反馈,筛选出能够通过编译的代码。最后利用LLM生成单元测试进一步验证代码的正确性。我们最终筛选出了46k数据,在第一阶段模型的基础上,使用较低的学习率进行微调,最终得到了我们的Ziya-coding-34B-v1.0。
335
+
336
+
337
+
338
+ In early September, we open-sourced the code model Ziya-Coding-15B-v1 based on StarCoder-15B. The training experience accumulated in training Ziya-Coding-15B-v1 was transferred to the training of the new version.
339
+
340
+
341
+ We collected and constructed about 450,000 instruction data covering almost all code-related tasks for the first stage of fine-tuning. This includes about 100,000 Chinese instructions and 350,000 English instructions, ensuring data diversity. When constructing the data, we made full use of high-quality non-instructional code data, used LLM to generate corresponding instructions, and expanded to obtain more high-quality code instruction data.
342
+
343
+ During the experiment, we noticed that the difficulty and correctness of code instructions are key to the successful training of code models. Therefore, we introduced a second stage of fine-tuning. We used the evol-instruct method to generate a large amount of high-difficulty, multi-requirement code instruction data, and used a code compiler as feedback to filter out code that could pass compilation. Finally, we used LLM to generate unit tests to further verify the correctness of the code. We ultimately filtered out 46k data, and on the basis of the first-stage model, we fine-tuned it with a lower learning rate to finally obtain our Ziya-coding-34B-v1.0.
344
+
345
+ ### 效果评估 Performance
346
+
347
+ | Model | HumanEval(pass@1) |
348
+ |:----------------------------|:-----------------:|
349
+ | **Ziya-Coding-34B-v1.0** | **75.5%** |
350
+ | CodeFuse-CodeLlama-34B | 74.4% |
351
+ | Phind-CodeLLaMa-34B-v2 | 73.8% |
352
+ | WizardCoder-Python-34B-V1.0 | 73.2% |
353
+ | GPT-4 | 67.0% |
354
+ | PanGu-Coder2 15B | 61.6% |
355
+ | WizardCoder-15B-V1.0 | 59.8% |
356
+ | CodeLlama-34b-Python | 53.7% |
357
+ | Ziya-Coding-15B-v1 | 50.1% |
358
+ | CodeLlama-34b | 48.8% |
359
+ | GPT-3.5 | 48.1% |
360
+ | StarCoder-15B | 33.6% |
361
+
362
+
363
+ 其中,我们对微调数据集进行了去污处理,避免数据泄露,HumanEval的pass@1指标是贪婪生成的结果。
364
+
365
+ Prompt Format
366
+ ```python3
367
+ "<human>: \nPlease Complete the given function below according to the docstring: \n{prompt}\n<bot>: \n"
368
+ ```
369
+ In this process, we performed a decontamination process on the fine-tuning dataset to avoid data leakage. The pass@1 metric for HumanEval is based on the results of greedy generation.
370
+
371
+ ## <span id="jump"> 使用 Usage </span>
372
+ ```python3
373
+ from transformers import AutoTokenizer, AutoModelForCausalLM
374
+ import torch
375
+
376
+ device = torch.device("cuda")
377
+ prompt = "写一段快速排序"
378
+ model = AutoModelForCausalLM.from_pretrained("IDEA-CCNL/Ziya-Coding-34B-v1.0", torch_dtype=torch.float16, device_map="auto")
379
+ tokenizer = AutoTokenizer.from_pretrained("IDEA-CCNL/Ziya-Coding-34B-v1.0", use_fast=False)
380
+ input = f"<human>: \n{prompt}\n<bot>: \n"
381
+ input_ids = tokenizer(input, return_tensors="pt").input_ids.to(device)
382
+ generate_ids = model.generate(
383
+ input_ids,
384
+ max_new_tokens = 512,
385
+ do_sample = True,
386
+ top_p = 0.85,
387
+ temperature = 1.0,
388
+ repetition_penalty = 1.0,
389
+ eos_token_id = tokenizer.eos_token_id,
390
+ pad_token_id = tokenizer.pad_token_id,
391
+ )
392
+ output = tokenizer.batch_decode(generate_ids)[0]
393
+ print(output)
394
+ ```
395
+
396
+ ## 引用 Citation
397
+
398
+ 如果您在您的工作中使用了我们的模型,可以引用我们的[论文](https://arxiv.org/abs/2210.08590):
399
+
400
+ If you are using the resource for your work, please cite the our [paper](https://arxiv.org/abs/2210.08590):
401
+
402
+ ```text
403
+ @article{fengshenbang,
404
+ author = {Jiaxing Zhang and Ruyi Gan and Junjie Wang and Yuxiang Zhang and Lin Zhang and Ping Yang and Xinyu Gao and Ziwei Wu and Xiaoqun Dong and Junqing He and Jianheng Zhuo and Qi Yang and Yongfeng Huang and Xiayu Li and Yanghan Wu and Junyu Lu and Xinyu Zhu and Weifeng Chen and Ting Han and Kunhao Pan and Rui Wang and Hao Wang and Xiaojun Wu and Zhongshen Zeng and Chongpei Chen},
405
+ title = {Fengshenbang 1.0: Being the Foundation of Chinese Cognitive Intelligence},
406
+ journal = {CoRR},
407
+ volume = {abs/2209.02970},
408
+ year = {2022}
409
+ }
410
+ ```
411
+
412
+ You can also cite our [website](https://github.com/IDEA-CCNL/Fengshenbang-LM/):
413
+
414
+ 欢迎引用我们的[网站](https://github.com/IDEA-CCNL/Fengshenbang-LM/):
415
+ ```text
416
+ @misc{Fengshenbang-LM,
417
+ title={Fengshenbang-LM},
418
+ author={IDEA-CCNL},
419
+ year={2021},
420
+ howpublished={\url{https://github.com/IDEA-CCNL/Fengshenbang-LM}},
421
+ }
422
+ ```
423
+
424
+ <!-- original-model-card end -->