TheBloke commited on
Commit
b200315
1 Parent(s): daa3be0

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +463 -0
README.md ADDED
@@ -0,0 +1,463 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: seedboxai/KafkaLM-70B-German-V0.1
3
+ datasets:
4
+ - seedboxai/multitask_german_examples_32k
5
+ inference: false
6
+ language:
7
+ - de
8
+ library_name: transformers
9
+ license: llama2
10
+ model_creator: Seedbox
11
+ model_name: KafkaLM 70B German V0.1
12
+ model_type: llama
13
+ pipeline_tag: text-generation
14
+ prompt_template: '<|system|>
15
+
16
+ {system_message}</s>
17
+
18
+ <|user|>
19
+
20
+ {prompt}</s>
21
+
22
+ <|assistant|>
23
+
24
+ '
25
+ quantized_by: TheBloke
26
+ tags:
27
+ - llama2
28
+ - deutsch
29
+ - german
30
+ - seedbox
31
+ ---
32
+ <!-- markdownlint-disable MD041 -->
33
+
34
+ <!-- header start -->
35
+ <!-- 200823 -->
36
+ <div style="width: auto; margin-left: auto; margin-right: auto">
37
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
38
+ </div>
39
+ <div style="display: flex; justify-content: space-between; width: 100%;">
40
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
41
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
42
+ </div>
43
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
44
+ <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>
45
+ </div>
46
+ </div>
47
+ <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>
48
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
49
+ <!-- header end -->
50
+
51
+ # KafkaLM 70B German V0.1 - GGUF
52
+ - Model creator: [Seedbox](https://huggingface.co/seedboxai)
53
+ - Original model: [KafkaLM 70B German V0.1](https://huggingface.co/seedboxai/KafkaLM-70B-German-V0.1)
54
+
55
+ <!-- description start -->
56
+ ## Description
57
+
58
+ This repo contains GGUF format model files for [Seedbox's KafkaLM 70B German V0.1](https://huggingface.co/seedboxai/KafkaLM-70B-German-V0.1).
59
+
60
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
61
+
62
+ <!-- description end -->
63
+ <!-- README_GGUF.md-about-gguf start -->
64
+ ### About GGUF
65
+
66
+ 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.
67
+
68
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
69
+
70
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
71
+ * [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.
72
+ * [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.
73
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
74
+ * [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.
75
+ * [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.
76
+ * [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.
77
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
78
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
79
+ * [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.
80
+
81
+ <!-- README_GGUF.md-about-gguf end -->
82
+ <!-- repositories-available start -->
83
+ ## Repositories available
84
+
85
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-AWQ)
86
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GPTQ)
87
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF)
88
+ * [Seedbox's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/seedboxai/KafkaLM-70B-German-V0.1)
89
+ <!-- repositories-available end -->
90
+
91
+ <!-- prompt-template start -->
92
+ ## Prompt template: Zephyr
93
+
94
+ ```
95
+ <|system|>
96
+ {system_message}</s>
97
+ <|user|>
98
+ {prompt}</s>
99
+ <|assistant|>
100
+
101
+ ```
102
+
103
+ <!-- prompt-template end -->
104
+
105
+
106
+ <!-- compatibility_gguf start -->
107
+ ## Compatibility
108
+
109
+ 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)
110
+
111
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
112
+
113
+ ## Explanation of quantisation methods
114
+
115
+ <details>
116
+ <summary>Click to see details</summary>
117
+
118
+ The new methods available are:
119
+
120
+ * 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)
121
+ * 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.
122
+ * 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.
123
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
124
+ * 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
125
+
126
+ Refer to the Provided Files table below to see what files use which methods, and how.
127
+ </details>
128
+ <!-- compatibility_gguf end -->
129
+
130
+ <!-- README_GGUF.md-provided-files start -->
131
+ ## Provided files
132
+
133
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
134
+ | ---- | ---- | ---- | ---- | ---- | ----- |
135
+ | [kafkalm-70b-german-v0.1.Q2_K.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q2_K.gguf) | Q2_K | 2 | 25.46 GB| 27.96 GB | significant quality loss - not recommended for most purposes |
136
+ | [kafkalm-70b-german-v0.1.Q3_K_S.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q3_K_S.gguf) | Q3_K_S | 3 | 29.92 GB| 32.42 GB | very small, high quality loss |
137
+ | [kafkalm-70b-german-v0.1.Q3_K_M.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q3_K_M.gguf) | Q3_K_M | 3 | 33.27 GB| 35.77 GB | very small, high quality loss |
138
+ | [kafkalm-70b-german-v0.1.Q3_K_L.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q3_K_L.gguf) | Q3_K_L | 3 | 36.15 GB| 38.65 GB | small, substantial quality loss |
139
+ | [kafkalm-70b-german-v0.1.Q4_0.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q4_0.gguf) | Q4_0 | 4 | 38.87 GB| 41.37 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
140
+ | [kafkalm-70b-german-v0.1.Q4_K_S.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q4_K_S.gguf) | Q4_K_S | 4 | 39.25 GB| 41.75 GB | small, greater quality loss |
141
+ | [kafkalm-70b-german-v0.1.Q4_K_M.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q4_K_M.gguf) | Q4_K_M | 4 | 41.42 GB| 43.92 GB | medium, balanced quality - recommended |
142
+ | [kafkalm-70b-german-v0.1.Q5_0.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q5_0.gguf) | Q5_0 | 5 | 47.46 GB| 49.96 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
143
+ | [kafkalm-70b-german-v0.1.Q5_K_S.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q5_K_S.gguf) | Q5_K_S | 5 | 47.46 GB| 49.96 GB | large, low quality loss - recommended |
144
+ | [kafkalm-70b-german-v0.1.Q5_K_M.gguf](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF/blob/main/kafkalm-70b-german-v0.1.Q5_K_M.gguf) | Q5_K_M | 5 | 48.75 GB| 51.25 GB | large, very low quality loss - recommended |
145
+ | kafkalm-70b-german-v0.1.Q6_K.gguf | Q6_K | 6 | 56.59 GB| 59.09 GB | very large, extremely low quality loss |
146
+ | kafkalm-70b-german-v0.1.Q8_0.gguf | Q8_0 | 8 | 73.29 GB| 75.79 GB | very large, extremely low quality loss - not recommended |
147
+
148
+ **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.
149
+
150
+ ### Q6_K and Q8_0 files are split and require joining
151
+
152
+ **Note:** HF does not support uploading files larger than 50GB. Therefore I have uploaded the Q6_K and Q8_0 files as split files.
153
+
154
+ <details>
155
+ <summary>Click for instructions regarding Q6_K and Q8_0 files</summary>
156
+
157
+ ### q6_K
158
+ Please download:
159
+ * `kafkalm-70b-german-v0.1.Q6_K.gguf-split-a`
160
+ * `kafkalm-70b-german-v0.1.Q6_K.gguf-split-b`
161
+
162
+ ### q8_0
163
+ Please download:
164
+ * `kafkalm-70b-german-v0.1.Q8_0.gguf-split-a`
165
+ * `kafkalm-70b-german-v0.1.Q8_0.gguf-split-b`
166
+
167
+ To join the files, do the following:
168
+
169
+ Linux and macOS:
170
+ ```
171
+ cat kafkalm-70b-german-v0.1.Q6_K.gguf-split-* > kafkalm-70b-german-v0.1.Q6_K.gguf && rm kafkalm-70b-german-v0.1.Q6_K.gguf-split-*
172
+ cat kafkalm-70b-german-v0.1.Q8_0.gguf-split-* > kafkalm-70b-german-v0.1.Q8_0.gguf && rm kafkalm-70b-german-v0.1.Q8_0.gguf-split-*
173
+ ```
174
+ Windows command line:
175
+ ```
176
+ COPY /B kafkalm-70b-german-v0.1.Q6_K.gguf-split-a + kafkalm-70b-german-v0.1.Q6_K.gguf-split-b kafkalm-70b-german-v0.1.Q6_K.gguf
177
+ del kafkalm-70b-german-v0.1.Q6_K.gguf-split-a kafkalm-70b-german-v0.1.Q6_K.gguf-split-b
178
+
179
+ COPY /B kafkalm-70b-german-v0.1.Q8_0.gguf-split-a + kafkalm-70b-german-v0.1.Q8_0.gguf-split-b kafkalm-70b-german-v0.1.Q8_0.gguf
180
+ del kafkalm-70b-german-v0.1.Q8_0.gguf-split-a kafkalm-70b-german-v0.1.Q8_0.gguf-split-b
181
+ ```
182
+
183
+ </details>
184
+ <!-- README_GGUF.md-provided-files end -->
185
+
186
+ <!-- README_GGUF.md-how-to-download start -->
187
+ ## How to download GGUF files
188
+
189
+ **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.
190
+
191
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
192
+
193
+ * LM Studio
194
+ * LoLLMS Web UI
195
+ * Faraday.dev
196
+
197
+ ### In `text-generation-webui`
198
+
199
+ Under Download Model, you can enter the model repo: TheBloke/KafkaLM-70B-German-V0.1-GGUF and below it, a specific filename to download, such as: kafkalm-70b-german-v0.1.Q4_K_M.gguf.
200
+
201
+ Then click Download.
202
+
203
+ ### On the command line, including multiple files at once
204
+
205
+ I recommend using the `huggingface-hub` Python library:
206
+
207
+ ```shell
208
+ pip3 install huggingface-hub
209
+ ```
210
+
211
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
212
+
213
+ ```shell
214
+ huggingface-cli download TheBloke/KafkaLM-70B-German-V0.1-GGUF kafkalm-70b-german-v0.1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
215
+ ```
216
+
217
+ <details>
218
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
219
+
220
+ You can also download multiple files at once with a pattern:
221
+
222
+ ```shell
223
+ huggingface-cli download TheBloke/KafkaLM-70B-German-V0.1-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
224
+ ```
225
+
226
+ 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).
227
+
228
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
229
+
230
+ ```shell
231
+ pip3 install hf_transfer
232
+ ```
233
+
234
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
235
+
236
+ ```shell
237
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/KafkaLM-70B-German-V0.1-GGUF kafkalm-70b-german-v0.1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
238
+ ```
239
+
240
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
241
+ </details>
242
+ <!-- README_GGUF.md-how-to-download end -->
243
+
244
+ <!-- README_GGUF.md-how-to-run start -->
245
+ ## Example `llama.cpp` command
246
+
247
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
248
+
249
+ ```shell
250
+ ./main -ngl 35 -m kafkalm-70b-german-v0.1.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|system|>\n{system_message}</s>\n<|user|>\n{prompt}</s>\n<|assistant|>"
251
+ ```
252
+
253
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
254
+
255
+ Change `-c 4096` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
256
+
257
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
258
+
259
+ 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)
260
+
261
+ ## How to run in `text-generation-webui`
262
+
263
+ 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).
264
+
265
+ ## How to run from Python code
266
+
267
+ 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.
268
+
269
+ ### How to load this model in Python code, using llama-cpp-python
270
+
271
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
272
+
273
+ #### First install the package
274
+
275
+ Run one of the following commands, according to your system:
276
+
277
+ ```shell
278
+ # Base ctransformers with no GPU acceleration
279
+ pip install llama-cpp-python
280
+ # With NVidia CUDA acceleration
281
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
282
+ # Or with OpenBLAS acceleration
283
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
284
+ # Or with CLBLast acceleration
285
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
286
+ # Or with AMD ROCm GPU acceleration (Linux only)
287
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
288
+ # Or with Metal GPU acceleration for macOS systems only
289
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
290
+
291
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
292
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
293
+ pip install llama-cpp-python
294
+ ```
295
+
296
+ #### Simple llama-cpp-python example code
297
+
298
+ ```python
299
+ from llama_cpp import Llama
300
+
301
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
302
+ llm = Llama(
303
+ model_path="./kafkalm-70b-german-v0.1.Q4_K_M.gguf", # Download the model file first
304
+ n_ctx=4096, # The max sequence length to use - note that longer sequence lengths require much more resources
305
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
306
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
307
+ )
308
+
309
+ # Simple inference example
310
+ output = llm(
311
+ "<|system|>\n{system_message}</s>\n<|user|>\n{prompt}</s>\n<|assistant|>", # Prompt
312
+ max_tokens=512, # Generate up to 512 tokens
313
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
314
+ echo=True # Whether to echo the prompt
315
+ )
316
+
317
+ # Chat Completion API
318
+
319
+ llm = Llama(model_path="./kafkalm-70b-german-v0.1.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
320
+ llm.create_chat_completion(
321
+ messages = [
322
+ {"role": "system", "content": "You are a story writing assistant."},
323
+ {
324
+ "role": "user",
325
+ "content": "Write a story about llamas."
326
+ }
327
+ ]
328
+ )
329
+ ```
330
+
331
+ ## How to use with LangChain
332
+
333
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
334
+
335
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
336
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
337
+
338
+ <!-- README_GGUF.md-how-to-run end -->
339
+
340
+ <!-- footer start -->
341
+ <!-- 200823 -->
342
+ ## Discord
343
+
344
+ For further support, and discussions on these models and AI in general, join us at:
345
+
346
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
347
+
348
+ ## Thanks, and how to contribute
349
+
350
+ Thanks to the [chirper.ai](https://chirper.ai) team!
351
+
352
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
353
+
354
+ 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.
355
+
356
+ 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.
357
+
358
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
359
+
360
+ * Patreon: https://patreon.com/TheBlokeAI
361
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
362
+
363
+ **Special thanks to**: Aemon Algiz.
364
+
365
+ **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
366
+
367
+
368
+ Thank you to all my generous patrons and donaters!
369
+
370
+ And thank you again to a16z for their generous grant.
371
+
372
+ <!-- footer end -->
373
+
374
+ <!-- original-model-card start -->
375
+ # Original model card: Seedbox's KafkaLM 70B German V0.1
376
+
377
+
378
+ ![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/645ded34a45b4182d7f5c385/hJ7zsOGDgLWUmf7vbaoI_.jpeg)
379
+
380
+
381
+ # KafkaLM-70B-German-V0.1
382
+
383
+ **KafkaLM 70b** is a 70b model based on [Llama2 70B Base Model](https://huggingface.co/meta-llama/Llama-2-70b-hf) which was finetuned on an ensemble of popular high-quality open-source instruction sets (translated from English to German).
384
+
385
+ KafkaLM 70b is a [Seedbox](https://huggingface.co/seedboxai) project trained by [Dennis Dickmann](https://huggingface.co/doubledsbv).
386
+
387
+ **Why Kafka?**
388
+ The models are proficient, yet creative, have some tendencies to linguistically push boundaries 😊
389
+
390
+
391
+ ## Model Details
392
+
393
+ The purpose of releasing the **KafkaLM series** is to contribute to the German AI community with a set of fine-tuned LLMs that are easy to use in everyday applications across a variety of tasks.
394
+
395
+ The main goal was to provide LLMs proficient in German, especially to be used in German-speaking business contexts where English alone is not sufficient.
396
+
397
+
398
+ ### Dataset
399
+
400
+ I used a 4k filtered version of the following [seedboxai/multitask_german_examples_32k](https://huggingface.co/datasets/seedboxai/multitask_german_examples_32k)
401
+
402
+ ### Prompt Format
403
+
404
+
405
+ This model follows the subsequent prompt format:
406
+
407
+ ```
408
+ <|system|>
409
+ Du bist ein freundlicher und hilfsbereiter KI-Assistent. Du beantwortest Fragen faktenorientiert und präzise, ohne dabei relevante Fakten auszulassen.</s>
410
+ <|user|>
411
+ Welche Möglichkeiten der energetischen Sanierung habe ich neben Solar und Energiespeicher?</s>
412
+ <|assistant|>
413
+ ```
414
+
415
+ ### Inference
416
+
417
+ Getting started with the model is straight forward
418
+
419
+ ```python
420
+ import transformers
421
+
422
+ model_id = "seedboxai/KafkaLM-70B-German-V0.1"
423
+
424
+ model = AutoModelForCausalLM.from_pretrained(model_id, load_in_4bit=True)
425
+
426
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
427
+
428
+ tokenizer.padding_side = "right"
429
+ tokenizer.pad_token = tokenizer.unk_token
430
+ tokenizer.add_eos_token = False
431
+
432
+ def generate_prompt(input):
433
+ prompt = ''
434
+ sys_prompt = "Du bist ein freundlicher und hilfsbereiter KI-Assistent. Du beantwortest Fragen faktenorientiert und präzise, ohne dabei relevante Fakten auszulassen."
435
+
436
+ prompt += f"<|system|>\n{sys_prompt.strip()}</s>\n"
437
+ prompt += f"<|user|>\n{input.strip()}</s>\n"
438
+ prompt += f"<|assistant|>\n"
439
+
440
+ return prompt.strip()
441
+
442
+
443
+ generate_text = transformers.pipeline(
444
+ model=model, tokenizer=tokenizer,
445
+ return_full_text=True,
446
+ task='text-generation',
447
+ temperature=0.5,
448
+ max_new_tokens=512,
449
+ top_p=0.95,
450
+ top_k=50,
451
+ do_sample=True,
452
+ )
453
+
454
+ print(generate_text(generate_prompt("Wer ist eigentlich dieser Kafka?"))
455
+
456
+ ```
457
+
458
+ ## Disclaimer
459
+
460
+ The license on this model does not constitute legal advice. We are not responsible for the actions of third parties who use this model.
461
+ This model should only be used for research purposes. The original Llama2 license and all restrictions of datasets used to train this model apply.
462
+
463
+ <!-- original-model-card end -->