TheBloke commited on
Commit
f5435d8
1 Parent(s): 77dee95

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +518 -0
README.md ADDED
@@ -0,0 +1,518 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: perlthoughts/Chupacabra-7B-v2
3
+ inference: false
4
+ license: apache-2.0
5
+ model_creator: Ray Hernandez
6
+ model_name: Chupacabra 7B V2
7
+ model_type: mistral
8
+ prompt_template: '### System:
9
+
10
+ {system_message}
11
+
12
+
13
+ ### User:
14
+
15
+ {prompt}
16
+
17
+
18
+ ### Assistant:
19
+
20
+ '
21
+ quantized_by: TheBloke
22
+ ---
23
+ <!-- markdownlint-disable MD041 -->
24
+
25
+ <!-- header start -->
26
+ <!-- 200823 -->
27
+ <div style="width: auto; margin-left: auto; margin-right: auto">
28
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
29
+ </div>
30
+ <div style="display: flex; justify-content: space-between; width: 100%;">
31
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
32
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
33
+ </div>
34
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
35
+ <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>
36
+ </div>
37
+ </div>
38
+ <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>
39
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
40
+ <!-- header end -->
41
+
42
+ # Chupacabra 7B V2 - GGUF
43
+ - Model creator: [Ray Hernandez](https://huggingface.co/perlthoughts)
44
+ - Original model: [Chupacabra 7B V2](https://huggingface.co/perlthoughts/Chupacabra-7B-v2)
45
+
46
+ <!-- description start -->
47
+ ## Description
48
+
49
+ This repo contains GGUF format model files for [Ray Hernandez's Chupacabra 7B V2](https://huggingface.co/perlthoughts/Chupacabra-7B-v2).
50
+
51
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
52
+
53
+ <!-- description end -->
54
+ <!-- README_GGUF.md-about-gguf start -->
55
+ ### About GGUF
56
+
57
+ 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.
58
+
59
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
60
+
61
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
62
+ * [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.
63
+ * [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.
64
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
65
+ * [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.
66
+ * [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.
67
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
68
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
69
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
70
+
71
+ <!-- README_GGUF.md-about-gguf end -->
72
+ <!-- repositories-available start -->
73
+ ## Repositories available
74
+
75
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Chupacabra-7B-v2-AWQ)
76
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GPTQ)
77
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF)
78
+ * [Ray Hernandez's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/perlthoughts/Chupacabra-7B-v2)
79
+ <!-- repositories-available end -->
80
+
81
+ <!-- prompt-template start -->
82
+ ## Prompt template: Orca-Hashes
83
+
84
+ ```
85
+ ### System:
86
+ {system_message}
87
+
88
+ ### User:
89
+ {prompt}
90
+
91
+ ### Assistant:
92
+
93
+ ```
94
+
95
+ <!-- prompt-template end -->
96
+
97
+
98
+ <!-- compatibility_gguf start -->
99
+ ## Compatibility
100
+
101
+ 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)
102
+
103
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
104
+
105
+ ## Explanation of quantisation methods
106
+
107
+ <details>
108
+ <summary>Click to see details</summary>
109
+
110
+ The new methods available are:
111
+
112
+ * 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)
113
+ * 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.
114
+ * 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.
115
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
116
+ * 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
117
+
118
+ Refer to the Provided Files table below to see what files use which methods, and how.
119
+ </details>
120
+ <!-- compatibility_gguf end -->
121
+
122
+ <!-- README_GGUF.md-provided-files start -->
123
+ ## Provided files
124
+
125
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
126
+ | ---- | ---- | ---- | ---- | ---- | ----- |
127
+ | [chupacabra-7b-v2.Q2_K.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q2_K.gguf) | Q2_K | 2 | 3.08 GB| 5.58 GB | smallest, significant quality loss - not recommended for most purposes |
128
+ | [chupacabra-7b-v2.Q3_K_S.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q3_K_S.gguf) | Q3_K_S | 3 | 3.16 GB| 5.66 GB | very small, high quality loss |
129
+ | [chupacabra-7b-v2.Q3_K_M.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q3_K_M.gguf) | Q3_K_M | 3 | 3.52 GB| 6.02 GB | very small, high quality loss |
130
+ | [chupacabra-7b-v2.Q3_K_L.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q3_K_L.gguf) | Q3_K_L | 3 | 3.82 GB| 6.32 GB | small, substantial quality loss |
131
+ | [chupacabra-7b-v2.Q4_0.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q4_0.gguf) | Q4_0 | 4 | 4.11 GB| 6.61 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
132
+ | [chupacabra-7b-v2.Q4_K_S.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q4_K_S.gguf) | Q4_K_S | 4 | 4.14 GB| 6.64 GB | small, greater quality loss |
133
+ | [chupacabra-7b-v2.Q4_K_M.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q4_K_M.gguf) | Q4_K_M | 4 | 4.37 GB| 6.87 GB | medium, balanced quality - recommended |
134
+ | [chupacabra-7b-v2.Q5_0.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q5_0.gguf) | Q5_0 | 5 | 5.00 GB| 7.50 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
135
+ | [chupacabra-7b-v2.Q5_K_S.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q5_K_S.gguf) | Q5_K_S | 5 | 5.00 GB| 7.50 GB | large, low quality loss - recommended |
136
+ | [chupacabra-7b-v2.Q5_K_M.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q5_K_M.gguf) | Q5_K_M | 5 | 5.13 GB| 7.63 GB | large, very low quality loss - recommended |
137
+ | [chupacabra-7b-v2.Q6_K.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q6_K.gguf) | Q6_K | 6 | 5.94 GB| 8.44 GB | very large, extremely low quality loss |
138
+ | [chupacabra-7b-v2.Q8_0.gguf](https://huggingface.co/TheBloke/Chupacabra-7B-v2-GGUF/blob/main/chupacabra-7b-v2.Q8_0.gguf) | Q8_0 | 8 | 7.70 GB| 10.20 GB | very large, extremely low quality loss - not recommended |
139
+
140
+ **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.
141
+
142
+
143
+
144
+ <!-- README_GGUF.md-provided-files end -->
145
+
146
+ <!-- README_GGUF.md-how-to-download start -->
147
+ ## How to download GGUF files
148
+
149
+ **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.
150
+
151
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
152
+
153
+ * LM Studio
154
+ * LoLLMS Web UI
155
+ * Faraday.dev
156
+
157
+ ### In `text-generation-webui`
158
+
159
+ Under Download Model, you can enter the model repo: TheBloke/Chupacabra-7B-v2-GGUF and below it, a specific filename to download, such as: chupacabra-7b-v2.Q4_K_M.gguf.
160
+
161
+ Then click Download.
162
+
163
+ ### On the command line, including multiple files at once
164
+
165
+ I recommend using the `huggingface-hub` Python library:
166
+
167
+ ```shell
168
+ pip3 install huggingface-hub
169
+ ```
170
+
171
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
172
+
173
+ ```shell
174
+ huggingface-cli download TheBloke/Chupacabra-7B-v2-GGUF chupacabra-7b-v2.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
175
+ ```
176
+
177
+ <details>
178
+ <summary>More advanced huggingface-cli download usage</summary>
179
+
180
+ You can also download multiple files at once with a pattern:
181
+
182
+ ```shell
183
+ huggingface-cli download TheBloke/Chupacabra-7B-v2-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
184
+ ```
185
+
186
+ 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).
187
+
188
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
189
+
190
+ ```shell
191
+ pip3 install hf_transfer
192
+ ```
193
+
194
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
195
+
196
+ ```shell
197
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Chupacabra-7B-v2-GGUF chupacabra-7b-v2.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
198
+ ```
199
+
200
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
201
+ </details>
202
+ <!-- README_GGUF.md-how-to-download end -->
203
+
204
+ <!-- README_GGUF.md-how-to-run start -->
205
+ ## Example `llama.cpp` command
206
+
207
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
208
+
209
+ ```shell
210
+ ./main -ngl 32 -m chupacabra-7b-v2.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### System:\n{system_message}\n\n### User:\n{prompt}\n\n### Assistant:"
211
+ ```
212
+
213
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
214
+
215
+ 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.
216
+
217
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
218
+
219
+ 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)
220
+
221
+ ## How to run in `text-generation-webui`
222
+
223
+ 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).
224
+
225
+ ## How to run from Python code
226
+
227
+ 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.
228
+
229
+ ### How to load this model in Python code, using ctransformers
230
+
231
+ #### First install the package
232
+
233
+ Run one of the following commands, according to your system:
234
+
235
+ ```shell
236
+ # Base ctransformers with no GPU acceleration
237
+ pip install ctransformers
238
+ # Or with CUDA GPU acceleration
239
+ pip install ctransformers[cuda]
240
+ # Or with AMD ROCm GPU acceleration (Linux only)
241
+ CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
242
+ # Or with Metal GPU acceleration for macOS systems only
243
+ CT_METAL=1 pip install ctransformers --no-binary ctransformers
244
+ ```
245
+
246
+ #### Simple ctransformers example code
247
+
248
+ ```python
249
+ from ctransformers import AutoModelForCausalLM
250
+
251
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
252
+ llm = AutoModelForCausalLM.from_pretrained("TheBloke/Chupacabra-7B-v2-GGUF", model_file="chupacabra-7b-v2.Q4_K_M.gguf", model_type="mistral", gpu_layers=50)
253
+
254
+ print(llm("AI is going to"))
255
+ ```
256
+
257
+ ## How to use with LangChain
258
+
259
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
260
+
261
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
262
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
263
+
264
+ <!-- README_GGUF.md-how-to-run end -->
265
+
266
+ <!-- footer start -->
267
+ <!-- 200823 -->
268
+ ## Discord
269
+
270
+ For further support, and discussions on these models and AI in general, join us at:
271
+
272
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
273
+
274
+ ## Thanks, and how to contribute
275
+
276
+ Thanks to the [chirper.ai](https://chirper.ai) team!
277
+
278
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
279
+
280
+ 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.
281
+
282
+ 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.
283
+
284
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
285
+
286
+ * Patreon: https://patreon.com/TheBlokeAI
287
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
288
+
289
+ **Special thanks to**: Aemon Algiz.
290
+
291
+ **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
292
+
293
+
294
+ Thank you to all my generous patrons and donaters!
295
+
296
+ And thank you again to a16z for their generous grant.
297
+
298
+ <!-- footer end -->
299
+
300
+ <!-- original-model-card start -->
301
+ # Original model card: Ray Hernandez's Chupacabra 7B V2
302
+
303
+
304
+ # Chupacabra 7B v2
305
+
306
+ <p><img src="https://huggingface.co/perlthoughts/Chupacabra-7B/resolve/main/chupacabra7b%202.png" width=330></p>
307
+
308
+ ### Model Description
309
+
310
+ This model was made by merging models based on Mistral with the SLERP merge method.
311
+
312
+ Advantages of SLERP vs averaging weights(common) are as follows:
313
+
314
+ - Spherical Linear Interpolation (SLERP) - Traditionally, model merging often resorts to weight averaging which, although straightforward, might not always capture the intricate features of the models being merged. The SLERP technique addresses this limitation, producing a blended model with characteristics smoothly interpolated from both parent models, ensuring the resultant model captures the essence of both its parents.
315
+
316
+ - Smooth Transitions - SLERP ensures smoother transitions between model parameters. This is especially significant when interpolating between high-dimensional vectors.
317
+
318
+ - Better Preservation of Characteristics - Unlike weight averaging, which might dilute distinct features, SLERP preserves the curvature and characteristics of both models in high-dimensional spaces.
319
+
320
+ - Nuanced Blending - SLERP takes into account the geometric and rotational properties of the models in the vector space, resulting in a blend that is more reflective of both parent models' characteristics.
321
+
322
+ List of all models and merging path is coming soon.
323
+
324
+ ## Purpose
325
+
326
+ Merging the "thick"est model weights from mistral models using amazing training methods like direct preference optimization (dpo) and reinforced learning.
327
+
328
+ I have spent countless hours studying the latest research papers, attending conferences, and networking with experts in the field. I experimented with different algorithms, tactics, fine-tuned hyperparameters, optimizers,
329
+ and optimized code until i achieved the best possible results.
330
+
331
+ It has not been without challenges. there were skeptics who doubted my abilities and questioned my approach. approach can be changed, but a closed mind cannot.
332
+
333
+ I refused to let their negativity bring me down. Instead, I used their doubts as fuel to push myself even harder. I worked tirelessly (vapenation), day and night, until i finally succeeded in merging with the most performant model weights using sota training methods like dpo and other advanced techniques.
334
+
335
+ Thank you openchat 3.5 for showing me the way.
336
+
337
+ I stand tall as a beacon of hope for those who dare to dream big and pursue their passions. my story is a testament to the power of perseverance, determination, and hard work. and i will continue to strive for excellence, always pushing the boundaries of what is possible.
338
+
339
+ Here is my contribution.
340
+
341
+ ## Prompt Template
342
+
343
+ Replace {system} with your system prompt, and {prompt} with your prompt instruction.
344
+
345
+ ```
346
+ ### System:
347
+ {system}
348
+ ### User:
349
+ {instruction}
350
+ ### Assistant:
351
+ ```
352
+
353
+ ### Bug fixes
354
+
355
+ - Fixed issue with generation and the incorrect model weights. Model weights have been corrected and now generation works again. Reuploading GGUF to the GGUF repository as well as the AWQ versions.
356
+
357
+ - **Developed by:** Ray Hernandez
358
+ - **Model type:** Mistral
359
+ - **Language(s) (NLP):** English
360
+ - **License:** Apache 2.0
361
+
362
+ ### Model Sources [optional]
363
+
364
+ <!-- Provide the basic links for the model. -->
365
+
366
+ ## Uses
367
+
368
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
369
+
370
+ ### Direct Use
371
+
372
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
373
+
374
+ [More Information Needed]
375
+
376
+ ### Downstream Use [optional]
377
+
378
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
379
+
380
+ [More Information Needed]
381
+
382
+ ### Out-of-Scope Use
383
+
384
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
385
+
386
+ [More Information Needed]
387
+
388
+ ## Bias, Risks, and Limitations
389
+
390
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
391
+
392
+ [More Information Needed]
393
+
394
+ ### Recommendations
395
+
396
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
397
+
398
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
399
+
400
+ ## How to Get Started with the Model
401
+
402
+ Use the code below to get started with the model.
403
+
404
+ [More Information Needed]
405
+
406
+ ## Training Details
407
+
408
+ ### Training Data
409
+
410
+ <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
411
+
412
+ [More Information Needed]
413
+
414
+ ### Training Procedure
415
+
416
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
417
+
418
+ #### Preprocessing [optional]
419
+
420
+ [More Information Needed]
421
+
422
+
423
+ #### Training Hyperparameters
424
+
425
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
426
+
427
+ #### Speeds, Sizes, Times [optional]
428
+
429
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
430
+
431
+ [More Information Needed]
432
+
433
+ ## Evaluation
434
+
435
+ <!-- This section describes the evaluation protocols and provides the results. -->
436
+
437
+ ### Testing Data, Factors & Metrics
438
+
439
+ #### Testing Data
440
+
441
+ <!-- This should link to a Dataset Card if possible. -->
442
+
443
+ [More Information Needed]
444
+
445
+ #### Factors
446
+
447
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
448
+
449
+ [More Information Needed]
450
+
451
+ #### Metrics
452
+
453
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
454
+
455
+ [More Information Needed]
456
+
457
+ ### Results
458
+
459
+ [More Information Needed]
460
+
461
+ #### Summary
462
+
463
+
464
+ ## Model Examination [optional]
465
+
466
+ <!-- Relevant interpretability work for the model goes here -->
467
+
468
+ [More Information Needed]
469
+
470
+ ## Technical Specifications [optional]
471
+
472
+ ### Model Architecture and Objective
473
+
474
+ [More Information Needed]
475
+
476
+ ### Compute Infrastructure
477
+
478
+ [More Information Needed]
479
+
480
+ #### Hardware
481
+
482
+ [More Information Needed]
483
+
484
+ #### Software
485
+
486
+ [More Information Needed]
487
+
488
+ ## Citation [optional]
489
+
490
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
491
+
492
+ **BibTeX:**
493
+
494
+ [More Information Needed]
495
+
496
+ **APA:**
497
+
498
+ [More Information Needed]
499
+
500
+ ## Glossary [optional]
501
+
502
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
503
+
504
+ [More Information Needed]
505
+
506
+ ## More Information [optional]
507
+
508
+ [More Information Needed]
509
+
510
+ ## Model Card Authors [optional]
511
+
512
+ [More Information Needed]
513
+
514
+ ## Model Card Contact
515
+
516
+ [More Information Needed]
517
+
518
+ <!-- original-model-card end -->