TheBloke commited on
Commit
a71e312
·
1 Parent(s): 3450b30

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +436 -0
README.md ADDED
@@ -0,0 +1,436 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: brucethemoose/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity
3
+ inference: false
4
+ language:
5
+ - en
6
+ library_name: transformers
7
+ license: other
8
+ license_link: https://huggingface.co/01-ai/Yi-34B/blob/main/LICENSE
9
+ license_name: yi-license
10
+ model_creator: brucethemoose
11
+ model_name: CaPlatTessDolXaBoros Yi 34B 200K Dare Ties Highdensity
12
+ model_type: yi
13
+ pipeline_tag: text-generation
14
+ prompt_template: 'SYSTEM: {system_message}
15
+
16
+ USER: {prompt}
17
+
18
+ ASSISTANT:
19
+
20
+ '
21
+ quantized_by: TheBloke
22
+ tags:
23
+ - text-generation-inference
24
+ ---
25
+ <!-- markdownlint-disable MD041 -->
26
+
27
+ <!-- header start -->
28
+ <!-- 200823 -->
29
+ <div style="width: auto; margin-left: auto; margin-right: auto">
30
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
31
+ </div>
32
+ <div style="display: flex; justify-content: space-between; width: 100%;">
33
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
34
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
35
+ </div>
36
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
37
+ <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>
38
+ </div>
39
+ </div>
40
+ <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>
41
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
42
+ <!-- header end -->
43
+
44
+ # CaPlatTessDolXaBoros Yi 34B 200K Dare Ties Highdensity - GGUF
45
+ - Model creator: [brucethemoose](https://huggingface.co/brucethemoose)
46
+ - Original model: [CaPlatTessDolXaBoros Yi 34B 200K Dare Ties Highdensity](https://huggingface.co/brucethemoose/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity)
47
+
48
+ <!-- description start -->
49
+ ## Description
50
+
51
+ This repo contains GGUF format model files for [brucethemoose's CaPlatTessDolXaBoros Yi 34B 200K Dare Ties Highdensity](https://huggingface.co/brucethemoose/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity).
52
+
53
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
54
+
55
+ <!-- description end -->
56
+ <!-- README_GGUF.md-about-gguf start -->
57
+ ### About GGUF
58
+
59
+ 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.
60
+
61
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
62
+
63
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
64
+ * [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.
65
+ * [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.
66
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
67
+ * [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.
68
+ * [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.
69
+ * [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.
70
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
71
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
72
+ * [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.
73
+
74
+ <!-- README_GGUF.md-about-gguf end -->
75
+ <!-- repositories-available start -->
76
+ ## Repositories available
77
+
78
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-AWQ)
79
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GPTQ)
80
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF)
81
+ * [brucethemoose's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/brucethemoose/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity)
82
+ <!-- repositories-available end -->
83
+
84
+ <!-- prompt-template start -->
85
+ ## Prompt template: Orca-Vicuna
86
+
87
+ ```
88
+ SYSTEM: {system_message}
89
+ USER: {prompt}
90
+ ASSISTANT:
91
+
92
+ ```
93
+
94
+ <!-- prompt-template end -->
95
+
96
+
97
+ <!-- compatibility_gguf start -->
98
+ ## Compatibility
99
+
100
+ 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)
101
+
102
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
103
+
104
+ ## Explanation of quantisation methods
105
+
106
+ <details>
107
+ <summary>Click to see details</summary>
108
+
109
+ The new methods available are:
110
+
111
+ * 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)
112
+ * 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.
113
+ * 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.
114
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
115
+ * 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
116
+
117
+ Refer to the Provided Files table below to see what files use which methods, and how.
118
+ </details>
119
+ <!-- compatibility_gguf end -->
120
+
121
+ <!-- README_GGUF.md-provided-files start -->
122
+ ## Provided files
123
+
124
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
125
+ | ---- | ---- | ---- | ---- | ---- | ----- |
126
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q2_K.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q2_K.gguf) | Q2_K | 2 | 14.56 GB| 17.06 GB | smallest, significant quality loss - not recommended for most purposes |
127
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q3_K_S.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q3_K_S.gguf) | Q3_K_S | 3 | 14.96 GB| 17.46 GB | very small, high quality loss |
128
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q3_K_M.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q3_K_M.gguf) | Q3_K_M | 3 | 16.64 GB| 19.14 GB | very small, high quality loss |
129
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q3_K_L.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q3_K_L.gguf) | Q3_K_L | 3 | 18.14 GB| 20.64 GB | small, substantial quality loss |
130
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_0.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_0.gguf) | Q4_0 | 4 | 19.47 GB| 21.97 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
131
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_S.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_S.gguf) | Q4_K_S | 4 | 19.54 GB| 22.04 GB | small, greater quality loss |
132
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf) | Q4_K_M | 4 | 20.66 GB| 23.16 GB | medium, balanced quality - recommended |
133
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q5_0.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q5_0.gguf) | Q5_0 | 5 | 23.71 GB| 26.21 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
134
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q5_K_S.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q5_K_S.gguf) | Q5_K_S | 5 | 23.71 GB| 26.21 GB | large, low quality loss - recommended |
135
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q5_K_M.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q5_K_M.gguf) | Q5_K_M | 5 | 24.32 GB| 26.82 GB | large, very low quality loss - recommended |
136
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q6_K.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q6_K.gguf) | Q6_K | 6 | 28.21 GB| 30.71 GB | very large, extremely low quality loss |
137
+ | [caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q8_0.gguf](https://huggingface.co/TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF/blob/main/caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q8_0.gguf) | Q8_0 | 8 | 36.54 GB| 39.04 GB | very large, extremely low quality loss - not recommended |
138
+
139
+ **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.
140
+
141
+
142
+
143
+ <!-- README_GGUF.md-provided-files end -->
144
+
145
+ <!-- README_GGUF.md-how-to-download start -->
146
+ ## How to download GGUF files
147
+
148
+ **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.
149
+
150
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
151
+
152
+ * LM Studio
153
+ * LoLLMS Web UI
154
+ * Faraday.dev
155
+
156
+ ### In `text-generation-webui`
157
+
158
+ Under Download Model, you can enter the model repo: TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF and below it, a specific filename to download, such as: caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf.
159
+
160
+ Then click Download.
161
+
162
+ ### On the command line, including multiple files at once
163
+
164
+ I recommend using the `huggingface-hub` Python library:
165
+
166
+ ```shell
167
+ pip3 install huggingface-hub
168
+ ```
169
+
170
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
171
+
172
+ ```shell
173
+ huggingface-cli download TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
174
+ ```
175
+
176
+ <details>
177
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
178
+
179
+ You can also download multiple files at once with a pattern:
180
+
181
+ ```shell
182
+ huggingface-cli download TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
183
+ ```
184
+
185
+ 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).
186
+
187
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
188
+
189
+ ```shell
190
+ pip3 install hf_transfer
191
+ ```
192
+
193
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
194
+
195
+ ```shell
196
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/CaPlatTessDolXaBoros-Yi-34B-200K-DARE-Ties-HighDensity-GGUF caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
197
+ ```
198
+
199
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
200
+ </details>
201
+ <!-- README_GGUF.md-how-to-download end -->
202
+
203
+ <!-- README_GGUF.md-how-to-run start -->
204
+ ## Example `llama.cpp` command
205
+
206
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
207
+
208
+ ```shell
209
+ ./main -ngl 35 -m caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf --color -c 200000 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "SYSTEM: {system_message}\nUSER: {prompt}\nASSISTANT:"
210
+ ```
211
+
212
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
213
+
214
+ 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.
215
+
216
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
217
+
218
+ 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)
219
+
220
+ ## How to run in `text-generation-webui`
221
+
222
+ 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).
223
+
224
+ ## How to run from Python code
225
+
226
+ 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.
227
+
228
+ ### How to load this model in Python code, using llama-cpp-python
229
+
230
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
231
+
232
+ #### First install the package
233
+
234
+ Run one of the following commands, according to your system:
235
+
236
+ ```shell
237
+ # Base ctransformers with no GPU acceleration
238
+ pip install llama-cpp-python
239
+ # With NVidia CUDA acceleration
240
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
241
+ # Or with OpenBLAS acceleration
242
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
243
+ # Or with CLBLast acceleration
244
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
245
+ # Or with AMD ROCm GPU acceleration (Linux only)
246
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
247
+ # Or with Metal GPU acceleration for macOS systems only
248
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
249
+
250
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
251
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
252
+ pip install llama-cpp-python
253
+ ```
254
+
255
+ #### Simple llama-cpp-python example code
256
+
257
+ ```python
258
+ from llama_cpp import Llama
259
+
260
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
261
+ llm = Llama(
262
+ model_path="./caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf", # Download the model file first
263
+ n_ctx=200000, # The max sequence length to use - note that longer sequence lengths require much more resources
264
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
265
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
266
+ )
267
+
268
+ # Simple inference example
269
+ output = llm(
270
+ "SYSTEM: {system_message}\nUSER: {prompt}\nASSISTANT:", # Prompt
271
+ max_tokens=512, # Generate up to 512 tokens
272
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
273
+ echo=True # Whether to echo the prompt
274
+ )
275
+
276
+ # Chat Completion API
277
+
278
+ llm = Llama(model_path="./caplattessdolxaboros-yi-34b-200k-dare-ties-highdensity.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
279
+ llm.create_chat_completion(
280
+ messages = [
281
+ {"role": "system", "content": "You are a story writing assistant."},
282
+ {
283
+ "role": "user",
284
+ "content": "Write a story about llamas."
285
+ }
286
+ ]
287
+ )
288
+ ```
289
+
290
+ ## How to use with LangChain
291
+
292
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
293
+
294
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
295
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
296
+
297
+ <!-- README_GGUF.md-how-to-run end -->
298
+
299
+ <!-- footer start -->
300
+ <!-- 200823 -->
301
+ ## Discord
302
+
303
+ For further support, and discussions on these models and AI in general, join us at:
304
+
305
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
306
+
307
+ ## Thanks, and how to contribute
308
+
309
+ Thanks to the [chirper.ai](https://chirper.ai) team!
310
+
311
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
312
+
313
+ 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.
314
+
315
+ 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.
316
+
317
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
318
+
319
+ * Patreon: https://patreon.com/TheBlokeAI
320
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
321
+
322
+ **Special thanks to**: Aemon Algiz.
323
+
324
+ **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
325
+
326
+
327
+ Thank you to all my generous patrons and donaters!
328
+
329
+ And thank you again to a16z for their generous grant.
330
+
331
+ <!-- footer end -->
332
+
333
+ <!-- original-model-card start -->
334
+ # Original model card: brucethemoose's CaPlatTessDolXaBoros Yi 34B 200K Dare Ties Highdensity
335
+
336
+
337
+ **Dolphin-2.2-yi-34b-200k**, **Nous-Capybara-34B**, **Tess-M-v1.4**, **Airoboros-3_1-yi-34b-200k**, **PlatYi-34B-200K-Q**, and **Una-xaberius-34b-v1beta** merged with a new, experimental implementation of "dare ties" via mergekit. See:
338
+
339
+ > [Language Models are Super Mario: Absorbing Abilities from Homologous Models as a Free Lunch](https://github.com/yule-BUAA/MergeLM)
340
+
341
+ > https://github.com/cg123/mergekit/tree/dare
342
+
343
+
344
+ This variant is merged with a "higher than recommended" density with with the following config, and the tokenizer from chargoddard's Yi-Llama:
345
+ ```
346
+ models:
347
+ - model: /home/alpha/Storage/Models/Raw/chargoddard_Yi-34B-200K-Llama
348
+ # no parameters necessary for base model
349
+ - model: /home/alpha/Storage/Models/Raw/migtissera_Tess-34B-v1.4
350
+ parameters:
351
+ weight: 0.19
352
+ density: 0.6
353
+ - model: /home/alpha//Storage/Models/Raw/bhenrym14_airoboros-3_1-yi-34b-200k
354
+ parameters:
355
+ weight: 0.14
356
+ density: 0.5
357
+ - model: /home/alpha/Storage/Models/Raw/Nous-Capybara-34B
358
+ parameters:
359
+ weight: 0.19
360
+ density: 0.6
361
+ - model: /home/alpha/Storage/Models/Raw/kyujinpy_PlatYi-34B-200K-Q
362
+ parameters:
363
+ weight: 0.14
364
+ density: 0.5
365
+ - model: /home/alpha/FastModels/ehartford_dolphin-2.2-yi-34b-200k
366
+ parameters:
367
+ weight: 0.19
368
+ density: 0.6
369
+ - model: /home/alpha/FastModels/fblgit_una-xaberius-34b-v1beta
370
+ parameters:
371
+ weight: 0.15
372
+ density: 0.08
373
+ merge_method: dare_ties
374
+ base_model: /home/alpha/Storage/Models/Raw/chargoddard_Yi-34B-200K-Llama
375
+ parameters:
376
+ int8_mask: true
377
+ dtype: bfloat16
378
+ ```
379
+ ## Testing Notes
380
+
381
+ Various densities were tested with perplexity tests and long context prompts. Relatively high densities seem to perform better, contrary to the findings of the Super Mario paper.
382
+
383
+ This particular version is merged with more than the "recommended" max density of 0.5. It seems to result in even better perplexity, but I'm not sure if this translates to better output.
384
+
385
+ Weights that add up to 1 seems to be optimal.
386
+
387
+ Dare Ties is also resulting in seemingly better, lower perplexity merges than a regular ties merge, task arithmetic or a slerp merge.
388
+
389
+ Xaberuis is not a 200K model, hence it was merged at a very low density to try and preserve Yi 200K's long context performance while still inheriting some of Xaberius's performance.
390
+
391
+ I chose not to include other finetunes because they aren't trained on the 200K base. If any other 200K finetunes pop up, let me know.
392
+
393
+ ***
394
+ ## Prompt template: Orca-Vicuna?
395
+ ```
396
+ SYSTEM: {system_message}
397
+ USER: {prompt}
398
+ ASSISTANT:
399
+ ```
400
+ It might recognize ChatML from Dolphin+Xaberius, and Llama-chat from Airoboros.
401
+
402
+ Sometimes the model "spells out" the stop token as `</s>` like Capybara, so you may need to add `</s>` as an additional stopping condition.
403
+
404
+ ***
405
+ ## Running
406
+ Being a Yi model, try disabling the BOS token and/or running a lower temperature with 0.05-0.13 MinP, a little repitition penalty, and no other samplers. Yi tends to run "hot" by default.
407
+
408
+ 24GB GPUs can run Yi-34B-200K models at **45K-75K context** with exllamav2. I go into more detail in this [post](https://old.reddit.com/r/LocalLLaMA/comments/1896igc/how_i_run_34b_models_at_75k_context_on_24gb_fast/)
409
+
410
+ I recommend exl2 quantizations profiled on data similar to the desired task. It is especially sensitive to the quantization data at low bpw!
411
+
412
+ To load this in full-context backends like transformers and vllm, you *must* change `max_position_embeddings` in config.json to a lower value than 200,000, otherwise you will OOM!
413
+
414
+ ***
415
+
416
+ ## Credits:
417
+
418
+ https://github.com/cg123/mergekit/tree/dare
419
+
420
+ https://huggingface.co/ehartford/dolphin-2.2-yi-34b-200k
421
+
422
+ https://huggingface.co/kyujinpy/PlatYi-34B-200K-Q
423
+
424
+ https://huggingface.co/NousResearch/Nous-Capybara-34B/
425
+
426
+ https://huggingface.co/bhenrym14/airoboros-3_1-yi-34b-200k
427
+
428
+ https://huggingface.co/migtissera/Tess-M-v1.4
429
+
430
+ https://huggingface.co/fblgit/una-xaberius-34b-v1beta
431
+
432
+ https://huggingface.co/chargoddard/Yi-34B-200K-Llama
433
+
434
+ https://huggingface.co/01-ai/Yi-34B-200K
435
+
436
+ <!-- original-model-card end -->