TheBloke commited on
Commit
70cab19
1 Parent(s): 9d9359a

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +398 -0
README.md ADDED
@@ -0,0 +1,398 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: 01-ai/Yi-6B
3
+ inference: false
4
+ license: other
5
+ license_link: LICENSE
6
+ license_name: yi-license
7
+ model_creator: 01-ai
8
+ model_name: Yi 6B
9
+ model_type: yi
10
+ pipeline_tag: text-generation
11
+ prompt_template: '{prompt}
12
+
13
+ '
14
+ quantized_by: TheBloke
15
+ widget:
16
+ - output:
17
+ text: " an eerie sense that something is just not right\u2026\nBetween the two\
18
+ \ worlds lies The Forgotten Kingdom - home to creatures long since thought extinct\
19
+ \ and ancient magic so strong it defies belief! Only here can you find what\
20
+ \ has been lost for centuries: An Elixir Of Life which will restore youth and\
21
+ \ vitality if only those who seek its power are brave enough to face up against\
22
+ \ all manner of dangers lurking in this mysterious land! But beware; some say\
23
+ \ there may even exist powerful entities beyond our comprehension whose intentions\
24
+ \ towards humanity remain unclear at best ---- they might want nothing more\
25
+ \ than destruction itself rather then anything else from their quest after immortality\
26
+ \ (and maybe someone should tell them about modern medicine)? In any event though\
27
+ \ \u2013 one thing remains true regardless : whether or not success comes easy\
28
+ \ depends entirely upon how much effort we put into conquering whatever challenges\
29
+ \ lie ahead along with having faith deep down inside ourselves too ;) So let\u2019\
30
+ s get started now shall We?"
31
+ text: There's a place where time stands still. A place of breath taking wonder,
32
+ but also
33
+ ---
34
+ <!-- markdownlint-disable MD041 -->
35
+
36
+ <!-- header start -->
37
+ <!-- 200823 -->
38
+ <div style="width: auto; margin-left: auto; margin-right: auto">
39
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
40
+ </div>
41
+ <div style="display: flex; justify-content: space-between; width: 100%;">
42
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
43
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
44
+ </div>
45
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
46
+ <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>
47
+ </div>
48
+ </div>
49
+ <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>
50
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
51
+ <!-- header end -->
52
+
53
+ # Yi 6B - GGUF
54
+ - Model creator: [01-ai](https://huggingface.co/01-ai)
55
+ - Original model: [Yi 6B](https://huggingface.co/01-ai/Yi-6B)
56
+
57
+ <!-- description start -->
58
+ ## Description
59
+
60
+ This repo contains GGUF format model files for [01-ai's Yi 6B](https://huggingface.co/01-ai/Yi-6B).
61
+
62
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
63
+
64
+ <!-- description end -->
65
+ <!-- README_GGUF.md-about-gguf start -->
66
+ ### About GGUF
67
+
68
+ 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.
69
+
70
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
71
+
72
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
73
+ * [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.
74
+ * [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.
75
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
76
+ * [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.
77
+ * [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.
78
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
79
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
80
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
81
+
82
+ <!-- README_GGUF.md-about-gguf end -->
83
+ <!-- repositories-available start -->
84
+ ## Repositories available
85
+
86
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Yi-6B-AWQ)
87
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Yi-6B-GPTQ)
88
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Yi-6B-GGUF)
89
+ * [01-ai's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/01-ai/Yi-6B)
90
+ <!-- repositories-available end -->
91
+
92
+ <!-- prompt-template start -->
93
+ ## Prompt template: None
94
+
95
+ ```
96
+ {prompt}
97
+
98
+ ```
99
+
100
+ <!-- prompt-template end -->
101
+
102
+
103
+ <!-- compatibility_gguf start -->
104
+ ## Compatibility
105
+
106
+ 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)
107
+
108
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
109
+
110
+ ## Explanation of quantisation methods
111
+
112
+ <details>
113
+ <summary>Click to see details</summary>
114
+
115
+ The new methods available are:
116
+
117
+ * 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)
118
+ * 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.
119
+ * 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.
120
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
121
+ * 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
122
+
123
+ Refer to the Provided Files table below to see what files use which methods, and how.
124
+ </details>
125
+ <!-- compatibility_gguf end -->
126
+
127
+ <!-- README_GGUF.md-provided-files start -->
128
+ ## Provided files
129
+
130
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
131
+ | ---- | ---- | ---- | ---- | ---- | ----- |
132
+ | [yi-6b.Q2_K.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q2_K.gguf) | Q2_K | 2 | 2.62 GB| 5.12 GB | smallest, significant quality loss - not recommended for most purposes |
133
+ | [yi-6b.Q3_K_S.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q3_K_S.gguf) | Q3_K_S | 3 | 2.71 GB| 5.21 GB | very small, high quality loss |
134
+ | [yi-6b.Q3_K_M.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q3_K_M.gguf) | Q3_K_M | 3 | 2.99 GB| 5.49 GB | very small, high quality loss |
135
+ | [yi-6b.Q3_K_L.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q3_K_L.gguf) | Q3_K_L | 3 | 3.24 GB| 5.74 GB | small, substantial quality loss |
136
+ | [yi-6b.Q4_0.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q4_0.gguf) | Q4_0 | 4 | 3.48 GB| 5.98 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
137
+ | [yi-6b.Q4_K_S.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q4_K_S.gguf) | Q4_K_S | 4 | 3.50 GB| 6.00 GB | small, greater quality loss |
138
+ | [yi-6b.Q4_K_M.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q4_K_M.gguf) | Q4_K_M | 4 | 3.67 GB| 6.17 GB | medium, balanced quality - recommended |
139
+ | [yi-6b.Q5_0.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q5_0.gguf) | Q5_0 | 5 | 4.20 GB| 6.70 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
140
+ | [yi-6b.Q5_K_S.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q5_K_S.gguf) | Q5_K_S | 5 | 4.20 GB| 6.70 GB | large, low quality loss - recommended |
141
+ | [yi-6b.Q5_K_M.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q5_K_M.gguf) | Q5_K_M | 5 | 4.30 GB| 6.80 GB | large, very low quality loss - recommended |
142
+ | [yi-6b.Q6_K.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q6_K.gguf) | Q6_K | 6 | 4.97 GB| 7.47 GB | very large, extremely low quality loss |
143
+ | [yi-6b.Q8_0.gguf](https://huggingface.co/TheBloke/Yi-6B-GGUF/blob/main/yi-6b.Q8_0.gguf) | Q8_0 | 8 | 6.44 GB| 8.94 GB | very large, extremely low quality loss - not recommended |
144
+
145
+ **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.
146
+
147
+
148
+
149
+ <!-- README_GGUF.md-provided-files end -->
150
+
151
+ <!-- README_GGUF.md-how-to-download start -->
152
+ ## How to download GGUF files
153
+
154
+ **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.
155
+
156
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
157
+
158
+ * LM Studio
159
+ * LoLLMS Web UI
160
+ * Faraday.dev
161
+
162
+ ### In `text-generation-webui`
163
+
164
+ Under Download Model, you can enter the model repo: TheBloke/Yi-6B-GGUF and below it, a specific filename to download, such as: yi-6b.Q4_K_M.gguf.
165
+
166
+ Then click Download.
167
+
168
+ ### On the command line, including multiple files at once
169
+
170
+ I recommend using the `huggingface-hub` Python library:
171
+
172
+ ```shell
173
+ pip3 install huggingface-hub
174
+ ```
175
+
176
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
177
+
178
+ ```shell
179
+ huggingface-cli download TheBloke/Yi-6B-GGUF yi-6b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
180
+ ```
181
+
182
+ <details>
183
+ <summary>More advanced huggingface-cli download usage</summary>
184
+
185
+ You can also download multiple files at once with a pattern:
186
+
187
+ ```shell
188
+ huggingface-cli download TheBloke/Yi-6B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
189
+ ```
190
+
191
+ 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).
192
+
193
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
194
+
195
+ ```shell
196
+ pip3 install hf_transfer
197
+ ```
198
+
199
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
200
+
201
+ ```shell
202
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Yi-6B-GGUF yi-6b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
203
+ ```
204
+
205
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
206
+ </details>
207
+ <!-- README_GGUF.md-how-to-download end -->
208
+
209
+ <!-- README_GGUF.md-how-to-run start -->
210
+ ## Example `llama.cpp` command
211
+
212
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
213
+
214
+ ```shell
215
+ ./main -ngl 32 -m yi-6b.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "{prompt}"
216
+ ```
217
+
218
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
219
+
220
+ Change `-c 2048` 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.
221
+
222
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
223
+
224
+ 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)
225
+
226
+ ## How to run in `text-generation-webui`
227
+
228
+ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
229
+
230
+ ## How to run from Python code
231
+
232
+ 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.
233
+
234
+ ### How to load this model in Python code, using ctransformers
235
+
236
+ #### First install the package
237
+
238
+ Run one of the following commands, according to your system:
239
+
240
+ ```shell
241
+ # Base ctransformers with no GPU acceleration
242
+ pip install ctransformers
243
+ # Or with CUDA GPU acceleration
244
+ pip install ctransformers[cuda]
245
+ # Or with AMD ROCm GPU acceleration (Linux only)
246
+ CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
247
+ # Or with Metal GPU acceleration for macOS systems only
248
+ CT_METAL=1 pip install ctransformers --no-binary ctransformers
249
+ ```
250
+
251
+ #### Simple ctransformers example code
252
+
253
+ ```python
254
+ from ctransformers import AutoModelForCausalLM
255
+
256
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
257
+ llm = AutoModelForCausalLM.from_pretrained("TheBloke/Yi-6B-GGUF", model_file="yi-6b.Q4_K_M.gguf", model_type="yi", gpu_layers=50)
258
+
259
+ print(llm("AI is going to"))
260
+ ```
261
+
262
+ ## How to use with LangChain
263
+
264
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
265
+
266
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
267
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
268
+
269
+ <!-- README_GGUF.md-how-to-run end -->
270
+
271
+ <!-- footer start -->
272
+ <!-- 200823 -->
273
+ ## Discord
274
+
275
+ For further support, and discussions on these models and AI in general, join us at:
276
+
277
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
278
+
279
+ ## Thanks, and how to contribute
280
+
281
+ Thanks to the [chirper.ai](https://chirper.ai) team!
282
+
283
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
284
+
285
+ 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.
286
+
287
+ 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.
288
+
289
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
290
+
291
+ * Patreon: https://patreon.com/TheBlokeAI
292
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
293
+
294
+ **Special thanks to**: Aemon Algiz.
295
+
296
+ **Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
297
+
298
+
299
+ Thank you to all my generous patrons and donaters!
300
+
301
+ And thank you again to a16z for their generous grant.
302
+
303
+ <!-- footer end -->
304
+
305
+ <!-- original-model-card start -->
306
+ # Original model card: 01-ai's Yi 6B
307
+
308
+ <div align="center">
309
+
310
+ <img src="./Yi.svg" width="200px">
311
+
312
+ </div>
313
+
314
+ ## Introduction
315
+
316
+ The **Yi** series models are large language models trained from scratch by
317
+ developers at [01.AI](https://01.ai/). The first public release contains two
318
+ bilingual(English/Chinese) base models with the parameter sizes of 6B([`Yi-6B`](https://huggingface.co/01-ai/Yi-6B))
319
+ and 34B([`Yi-34B`](https://huggingface.co/01-ai/Yi-34B)). Both of them are trained
320
+ with 4K sequence length and can be extended to 32K during inference time.
321
+ The [`Yi-6B-200K`](https://huggingface.co/01-ai/Yi-6B-200K)
322
+ and [`Yi-34B-200K`](https://huggingface.co/01-ai/Yi-34B-200K) are base model with
323
+ 200K context length.
324
+
325
+ ## News
326
+
327
+ - 🎯 **2023/11/06**: The base model of [`Yi-6B-200K`](https://huggingface.co/01-ai/Yi-6B-200K)
328
+ and [`Yi-34B-200K`](https://huggingface.co/01-ai/Yi-34B-200K) with 200K context length.
329
+ - 🎯 **2023/11/02**: The base model of [`Yi-6B`](https://huggingface.co/01-ai/Yi-6B) and
330
+ [`Yi-34B`](https://huggingface.co/01-ai/Yi-34B).
331
+
332
+
333
+ ## Model Performance
334
+
335
+ | Model | MMLU | CMMLU | C-Eval | GAOKAO | BBH | Common-sense Reasoning | Reading Comprehension | Math & Code |
336
+ | :------------ | :------: | :------: | :------: | :------: | :------: | :--------------------: | :-------------------: | :---------: |
337
+ | | 5-shot | 5-shot | 5-shot | 0-shot | 3-shot@1 | - | - | - |
338
+ | LLaMA2-34B | 62.6 | - | - | - | 44.1 | 69.9 | 68.0 | 26.0 |
339
+ | LLaMA2-70B | 68.9 | 53.3 | - | 49.8 | 51.2 | 71.9 | 69.4 | 36.8 |
340
+ | Baichuan2-13B | 59.2 | 62.0 | 58.1 | 54.3 | 48.8 | 64.3 | 62.4 | 23.0 |
341
+ | Qwen-14B | 66.3 | 71.0 | 72.1 | 62.5 | 53.4 | 73.3 | 72.5 | **39.8** |
342
+ | Skywork-13B | 62.1 | 61.8 | 60.6 | 68.1 | 41.7 | 72.4 | 61.4 | 24.9 |
343
+ | InternLM-20B | 62.1 | 59.0 | 58.8 | 45.5 | 52.5 | 78.3 | - | 30.4 |
344
+ | Aquila-34B | 67.8 | 71.4 | 63.1 | - | - | - | - | - |
345
+ | Falcon-180B | 70.4 | 58.0 | 57.8 | 59.0 | 54.0 | 77.3 | 68.8 | 34.0 |
346
+ | Yi-6B | 63.2 | 75.5 | 72.0 | 72.2 | 42.8 | 72.3 | 68.7 | 19.8 |
347
+ | Yi-6B-200K | 64.0 | 75.3 | 73.5 | 73.9 | 42.0 | 72.0 | 69.1 | 19.0 |
348
+ | **Yi-34B** | **76.3** | **83.7** | 81.4 | 82.8 | **54.3** | **80.1** | 76.4 | 37.1 |
349
+ | Yi-34B-200K | 76.1 | 83.6 | **81.9** | **83.4** | 52.7 | 79.7 | **76.6** | 36.3 |
350
+
351
+ While benchmarking open-source models, we have observed a disparity between the
352
+ results generated by our pipeline and those reported in public sources (e.g.
353
+ OpenCompass). Upon conducting a more in-depth investigation of this difference,
354
+ we have discovered that various models may employ different prompts,
355
+ post-processing strategies, and sampling techniques, potentially resulting in
356
+ significant variations in the outcomes. Our prompt and post-processing strategy
357
+ remains consistent with the original benchmark, and greedy decoding is employed
358
+ during evaluation without any post-processing for the generated content. For
359
+ scores that were not reported by the original authors (including scores reported
360
+ with different settings), we try to get results with our pipeline.
361
+
362
+ To evaluate the model's capability extensively, we adopted the methodology
363
+ outlined in Llama2. Specifically, we included PIQA, SIQA, HellaSwag, WinoGrande,
364
+ ARC, OBQA, and CSQA to assess common sense reasoning. SquAD, QuAC, and BoolQ
365
+ were incorporated to evaluate reading comprehension. CSQA was exclusively tested
366
+ using a 7-shot setup, while all other tests were conducted with a 0-shot
367
+ configuration. Additionally, we introduced GSM8K (8-shot@1), MATH (4-shot@1),
368
+ HumanEval (0-shot@1), and MBPP (3-shot@1) under the category "Math & Code". Due
369
+ to technical constraints, we did not test Falcon-180 on QuAC and OBQA; the score
370
+ is derived by averaging the scores on the remaining tasks. Since the scores for
371
+ these two tasks are generally lower than the average, we believe that
372
+ Falcon-180B's performance was not underestimated.
373
+
374
+ ## Usage
375
+
376
+ Please visit our [github repository](https://github.com/01-ai/Yi) for general
377
+ guidance on how to use this model.
378
+
379
+ ## Disclaimer
380
+
381
+ Although we use data compliance checking algorithms during the training process
382
+ to ensure the compliance of the trained model to the best of our ability, due to
383
+ the complexity of the data and the diversity of language model usage scenarios,
384
+ we cannot guarantee that the model will generate correct and reasonable output
385
+ in all scenarios. Please be aware that there is still a risk of the model
386
+ producing problematic outputs. We will not be responsible for any risks and
387
+ issues resulting from misuse, misguidance, illegal usage, and related
388
+ misinformation, as well as any associated data security concerns.
389
+
390
+ ## License
391
+
392
+ The Yi series models are fully open for academic research and free commercial
393
+ usage with permission via applications. All usage must adhere to the [Model
394
+ License Agreement 2.0](https://huggingface.co/01-ai/Yi-6B/blob/main/LICENSE). To
395
+ apply for the official commercial license, please contact us
396
+ ([yi@01.ai](mailto:yi@01.ai)).
397
+
398
+ <!-- original-model-card end -->