TheBloke commited on
Commit
f714666
1 Parent(s): 0060e40

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +429 -0
README.md ADDED
@@ -0,0 +1,429 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: adamo1139/Yi-34B-200K-AEZAKMI-v2
3
+ datasets:
4
+ - adamo1139/AEZAKMI_v2
5
+ inference: false
6
+ license: other
7
+ license_link: LICENSE
8
+ license_name: yi-license
9
+ model_creator: Adam
10
+ model_name: Yi 34B 200K Aezakmi v2
11
+ model_type: yi
12
+ prompt_template: '<|im_start|>system
13
+
14
+ {system_message}<|im_end|>
15
+
16
+ <|im_start|>user
17
+
18
+ {prompt}<|im_end|>
19
+
20
+ <|im_start|>assistant
21
+
22
+ '
23
+ quantized_by: TheBloke
24
+ tags:
25
+ - llm
26
+ - fine-tune
27
+ - yi
28
+ ---
29
+ <!-- markdownlint-disable MD041 -->
30
+
31
+ <!-- header start -->
32
+ <!-- 200823 -->
33
+ <div style="width: auto; margin-left: auto; margin-right: auto">
34
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
35
+ </div>
36
+ <div style="display: flex; justify-content: space-between; width: 100%;">
37
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
38
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
39
+ </div>
40
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
41
+ <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>
42
+ </div>
43
+ </div>
44
+ <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>
45
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
46
+ <!-- header end -->
47
+
48
+ # Yi 34B 200K Aezakmi v2 - GGUF
49
+ - Model creator: [Adam](https://huggingface.co/adamo1139)
50
+ - Original model: [Yi 34B 200K Aezakmi v2](https://huggingface.co/adamo1139/Yi-34B-200K-AEZAKMI-v2)
51
+
52
+ <!-- description start -->
53
+ ## Description
54
+
55
+ This repo contains GGUF format model files for [Adam's Yi 34B 200K Aezakmi v2](https://huggingface.co/adamo1139/Yi-34B-200K-AEZAKMI-v2).
56
+
57
+ <!-- description end -->
58
+ <!-- README_GGUF.md-about-gguf start -->
59
+ ### About GGUF
60
+
61
+ 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.
62
+
63
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
64
+
65
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
66
+ * [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.
67
+ * [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.
68
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
69
+ * [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.
70
+ * [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.
71
+ * [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.
72
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
73
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
74
+ * [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.
75
+
76
+ <!-- README_GGUF.md-about-gguf end -->
77
+ <!-- repositories-available start -->
78
+ ## Repositories available
79
+
80
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-AWQ)
81
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GPTQ)
82
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF)
83
+ * [Adam's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/adamo1139/Yi-34B-200K-AEZAKMI-v2)
84
+ <!-- repositories-available end -->
85
+
86
+ <!-- prompt-template start -->
87
+ ## Prompt template: ChatML
88
+
89
+ ```
90
+ <|im_start|>system
91
+ {system_message}<|im_end|>
92
+ <|im_start|>user
93
+ {prompt}<|im_end|>
94
+ <|im_start|>assistant
95
+
96
+ ```
97
+
98
+ <!-- prompt-template end -->
99
+
100
+
101
+ <!-- compatibility_gguf start -->
102
+ ## Compatibility
103
+
104
+ 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)
105
+
106
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
107
+
108
+ ## Explanation of quantisation methods
109
+
110
+ <details>
111
+ <summary>Click to see details</summary>
112
+
113
+ The new methods available are:
114
+
115
+ * 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)
116
+ * 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.
117
+ * 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.
118
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
119
+ * 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
120
+
121
+ Refer to the Provided Files table below to see what files use which methods, and how.
122
+ </details>
123
+ <!-- compatibility_gguf end -->
124
+
125
+ <!-- README_GGUF.md-provided-files start -->
126
+ ## Provided files
127
+
128
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
129
+ | ---- | ---- | ---- | ---- | ---- | ----- |
130
+ | [yi-34b-200k-aezakmi-v2.Q2_K.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q2_K.gguf) | Q2_K | 2 | 14.56 GB| 17.06 GB | smallest, significant quality loss - not recommended for most purposes |
131
+ | [yi-34b-200k-aezakmi-v2.Q3_K_S.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q3_K_S.gguf) | Q3_K_S | 3 | 14.96 GB| 17.46 GB | very small, high quality loss |
132
+ | [yi-34b-200k-aezakmi-v2.Q3_K_M.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q3_K_M.gguf) | Q3_K_M | 3 | 16.64 GB| 19.14 GB | very small, high quality loss |
133
+ | [yi-34b-200k-aezakmi-v2.Q3_K_L.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q3_K_L.gguf) | Q3_K_L | 3 | 18.14 GB| 20.64 GB | small, substantial quality loss |
134
+ | [yi-34b-200k-aezakmi-v2.Q4_0.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q4_0.gguf) | Q4_0 | 4 | 19.47 GB| 21.97 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
135
+ | [yi-34b-200k-aezakmi-v2.Q4_K_S.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q4_K_S.gguf) | Q4_K_S | 4 | 19.55 GB| 22.05 GB | small, greater quality loss |
136
+ | [yi-34b-200k-aezakmi-v2.Q4_K_M.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q4_K_M.gguf) | Q4_K_M | 4 | 20.66 GB| 23.16 GB | medium, balanced quality - recommended |
137
+ | [yi-34b-200k-aezakmi-v2.Q5_0.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q5_0.gguf) | Q5_0 | 5 | 23.71 GB| 26.21 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
138
+ | [yi-34b-200k-aezakmi-v2.Q5_K_S.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q5_K_S.gguf) | Q5_K_S | 5 | 23.71 GB| 26.21 GB | large, low quality loss - recommended |
139
+ | [yi-34b-200k-aezakmi-v2.Q5_K_M.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q5_K_M.gguf) | Q5_K_M | 5 | 24.32 GB| 26.82 GB | large, very low quality loss - recommended |
140
+ | [yi-34b-200k-aezakmi-v2.Q6_K.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q6_K.gguf) | Q6_K | 6 | 28.22 GB| 30.72 GB | very large, extremely low quality loss |
141
+ | [yi-34b-200k-aezakmi-v2.Q8_0.gguf](https://huggingface.co/TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF/blob/main/yi-34b-200k-aezakmi-v2.Q8_0.gguf) | Q8_0 | 8 | 36.54 GB| 39.04 GB | very large, extremely low quality loss - not recommended |
142
+
143
+ **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.
144
+
145
+
146
+
147
+ <!-- README_GGUF.md-provided-files end -->
148
+
149
+ <!-- README_GGUF.md-how-to-download start -->
150
+ ## How to download GGUF files
151
+
152
+ **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.
153
+
154
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
155
+
156
+ * LM Studio
157
+ * LoLLMS Web UI
158
+ * Faraday.dev
159
+
160
+ ### In `text-generation-webui`
161
+
162
+ Under Download Model, you can enter the model repo: TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF and below it, a specific filename to download, such as: yi-34b-200k-aezakmi-v2.Q4_K_M.gguf.
163
+
164
+ Then click Download.
165
+
166
+ ### On the command line, including multiple files at once
167
+
168
+ I recommend using the `huggingface-hub` Python library:
169
+
170
+ ```shell
171
+ pip3 install huggingface-hub
172
+ ```
173
+
174
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
175
+
176
+ ```shell
177
+ huggingface-cli download TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF yi-34b-200k-aezakmi-v2.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
178
+ ```
179
+
180
+ <details>
181
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
182
+
183
+ You can also download multiple files at once with a pattern:
184
+
185
+ ```shell
186
+ huggingface-cli download TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
187
+ ```
188
+
189
+ 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).
190
+
191
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
192
+
193
+ ```shell
194
+ pip3 install hf_transfer
195
+ ```
196
+
197
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
198
+
199
+ ```shell
200
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Yi-34B-200K-AEZAKMI-v2-GGUF yi-34b-200k-aezakmi-v2.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
201
+ ```
202
+
203
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
204
+ </details>
205
+ <!-- README_GGUF.md-how-to-download end -->
206
+
207
+ <!-- README_GGUF.md-how-to-run start -->
208
+ ## Example `llama.cpp` command
209
+
210
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
211
+
212
+ ```shell
213
+ ./main -ngl 35 -m yi-34b-200k-aezakmi-v2.Q4_K_M.gguf --color -c 200000 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"
214
+ ```
215
+
216
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
217
+
218
+ Change `-c 200000` 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.
219
+
220
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
221
+
222
+ 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)
223
+
224
+ ## How to run in `text-generation-webui`
225
+
226
+ 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).
227
+
228
+ ## How to run from Python code
229
+
230
+ 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.
231
+
232
+ ### How to load this model in Python code, using llama-cpp-python
233
+
234
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
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 llama-cpp-python
243
+ # With NVidia CUDA acceleration
244
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
245
+ # Or with OpenBLAS acceleration
246
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
247
+ # Or with CLBLast acceleration
248
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
249
+ # Or with AMD ROCm GPU acceleration (Linux only)
250
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
251
+ # Or with Metal GPU acceleration for macOS systems only
252
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
253
+
254
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
255
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
256
+ pip install llama-cpp-python
257
+ ```
258
+
259
+ #### Simple llama-cpp-python example code
260
+
261
+ ```python
262
+ from llama_cpp import Llama
263
+
264
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
265
+ llm = Llama(
266
+ model_path="./yi-34b-200k-aezakmi-v2.Q4_K_M.gguf", # Download the model file first
267
+ n_ctx=200000, # The max sequence length to use - note that longer sequence lengths require much more resources
268
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
269
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
270
+ )
271
+
272
+ # Simple inference example
273
+ output = llm(
274
+ "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant", # Prompt
275
+ max_tokens=512, # Generate up to 512 tokens
276
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
277
+ echo=True # Whether to echo the prompt
278
+ )
279
+
280
+ # Chat Completion API
281
+
282
+ llm = Llama(model_path="./yi-34b-200k-aezakmi-v2.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
283
+ llm.create_chat_completion(
284
+ messages = [
285
+ {"role": "system", "content": "You are a story writing assistant."},
286
+ {
287
+ "role": "user",
288
+ "content": "Write a story about llamas."
289
+ }
290
+ ]
291
+ )
292
+ ```
293
+
294
+ ## How to use with LangChain
295
+
296
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
297
+
298
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
299
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
300
+
301
+ <!-- README_GGUF.md-how-to-run end -->
302
+
303
+ <!-- footer start -->
304
+ <!-- 200823 -->
305
+ ## Discord
306
+
307
+ For further support, and discussions on these models and AI in general, join us at:
308
+
309
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
310
+
311
+ ## Thanks, and how to contribute
312
+
313
+ Thanks to the [chirper.ai](https://chirper.ai) team!
314
+
315
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
316
+
317
+ 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.
318
+
319
+ 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.
320
+
321
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
322
+
323
+ * Patreon: https://patreon.com/TheBlokeAI
324
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
325
+
326
+ **Special thanks to**: Aemon Algiz.
327
+
328
+ **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
329
+
330
+
331
+ Thank you to all my generous patrons and donaters!
332
+
333
+ And thank you again to a16z for their generous grant.
334
+
335
+ <!-- footer end -->
336
+
337
+ <!-- original-model-card start -->
338
+ # Original model card: Adam's Yi 34B 200K Aezakmi v2
339
+
340
+
341
+ ## Model description
342
+
343
+ Yi-34B 200K base model fine-tuned on AEZAKMI v2 dataset. Training took around 25 hours on single local RTX 3090 Ti.
344
+ It's like airoboros but with less gptslop, no refusals and less typical language used by RLHFed OpenAI models.
345
+ Say goodbye to "It's important to remember"! \
346
+ Prompt format is standard chatml. Don't expect it to be good at math, riddles or be crazy smart. My end goal with AEZAKMI is to create a cozy free chatbot.
347
+ Cost of this fine-tune is about $10 in electricity. It took me 3 tries to get it right.
348
+ Base model used for fine-tuning was 200k context Yi-34B-Llama model shared by larryvrh.
349
+
350
+ I had to lower max_positional_embeddings in config.json and model_max_length for training to start, otherwise I was OOMing straight away.
351
+ My first attempt had max_positional_embeddings set to 16384 and model_max_length set to 200000. This allowed fine-tuning to finish, but that model was broken after applying LoRA and merging it. \
352
+ This attempt had both max_position_embeddings and model_max_length set to 4096, which worked perfectly fine.
353
+
354
+ ## Prompt Format
355
+
356
+ I recommend using ChatML format, as this was used during fine-tune. \
357
+ Here's a prompt format you should use, you can set a different system message, model seems to respect that fine, so it wasn't overfitted.
358
+
359
+ ```
360
+ <|im_start|>system
361
+ A chat with uncensored assistant.<|im_end|>
362
+ <|im_start|>user
363
+ {prompt}<|im_end|>
364
+ <|im_start|>assistant
365
+ ```
366
+
367
+ ## Intended uses & limitations
368
+
369
+ Use is limited by Yi license.
370
+
371
+ ## Known Issues
372
+
373
+ I recommend to set repetition penalty to something around 1.05 to avoid repetition. So far I had good experience running this model with temperature 1.2.
374
+ Stories have ChatGPT like paragraph spacing, I will work on this in the future maybe, not a high priority
375
+
376
+ Unrestricted-ness of the v2 isn't quite something that I am happy with yet, especially using prompt "A chat.". \
377
+ With a slightly modifed prompt it works much better, I recommend using "A chat with uncensored assistant.", it's stupid but it helps a lot. \
378
+ Base Yi-34B model is contaminated with refusals and this contaminates all models trained on Yi-34B \
379
+ My next project is to attempt to de-contaminate base Yi-34B 4K and Yi-34B 200K using DPO with preferred data coming from uncontaminated raw models. I plan to release that dataset openly.
380
+
381
+ I was made aware of the frequent occurrence of the phrase "sending shivers down a spine" in the generations during RP of v1, so I fixed those samples - it should be better now. \
382
+ I can hold up to 24000 ctx with 4.65bpw exl2 version and 8-bit cache - long context should work as good as other models trained on 200k version of Yi-34B \
383
+ There is also some issue with handling long system messages for RP, I was planning to investigate it for v2 but I didn't.
384
+
385
+
386
+ ## Axolotl training parameters
387
+
388
+ - bnb_4bit_use_double_quant: true
389
+ - is_llama_derived_model: true
390
+ - load_in_4bit: true
391
+ - adapter: qlora
392
+ - sequence_len: 1400
393
+ - sample_packing: true
394
+ - lora_r: 16
395
+ - lora_alpha: 32
396
+ - lora_target_modules:
397
+ - q_proj
398
+ - v_proj
399
+ - k_proj
400
+ - o_proj
401
+ - gate_proj
402
+ - down_proj
403
+ - up_proj
404
+ - lora_target_linear: true
405
+ - pad_to_sequence_len: false
406
+ - micro_batch_size: 1
407
+ - gradient_accumulation_steps: 1
408
+ - num_epochs: 2.4
409
+ - optimizer: adamw_bnb_8bit
410
+ - lr_scheduler: constant
411
+ - learning_rate: 0.00005
412
+ - train_on_inputs: false
413
+ - group_by_length: false
414
+ - bf16: true
415
+ - bfloat16: true
416
+ - flash_optimum: false
417
+ - gradient_checkpointing: true
418
+ - flash_attention: true
419
+ - seed: 42
420
+
421
+
422
+ ## Upcoming
423
+
424
+ I will probably be working on de-contaminating base Yi-34B model now. \
425
+ My second run of AEZAKMI v2 fine-tune was just 0.15 epochs and I really like how natural this model is and how rich is it's vocabulary. I will try to train less to hit the sweetspot. \
426
+ I will be uploading LoRA adapter for that second run that was just 0.15 epochs. \
427
+ I believe that I might have gotten what I want if I would have stopped training sooner. I don't have checkpoints older than 1500 steps back so I would need to re-run training to get it back.
428
+
429
+ <!-- original-model-card end -->