TheBloke commited on
Commit
8247227
1 Parent(s): fb35f65

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +572 -0
README.md ADDED
@@ -0,0 +1,572 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: LeoLM/leo-hessianai-70b-chat
3
+ datasets:
4
+ - LeoLM/OpenSchnabeltier
5
+ - OpenAssistant/OASST-DE
6
+ - FreedomIntelligence/alpaca-gpt4-deutsch
7
+ - FreedomIntelligence/evol-instruct-deutsch
8
+ - LeoLM/German_Poems
9
+ - LeoLM/German_Songs
10
+ inference: false
11
+ language:
12
+ - en
13
+ - de
14
+ library_name: transformers
15
+ license: llama2
16
+ model_creator: LAION LeoLM
17
+ model_name: Leo Hessianai 70B Chat
18
+ model_type: llama
19
+ pipeline_tag: text-generation
20
+ prompt_template: '<|im_start|>system
21
+
22
+ {system_message}<|im_end|>
23
+
24
+ <|im_start|>user
25
+
26
+ {prompt}<|im_end|>
27
+
28
+ <|im_start|>assistant
29
+
30
+ '
31
+ quantized_by: TheBloke
32
+ ---
33
+ <!-- markdownlint-disable MD041 -->
34
+
35
+ <!-- header start -->
36
+ <!-- 200823 -->
37
+ <div style="width: auto; margin-left: auto; margin-right: auto">
38
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
39
+ </div>
40
+ <div style="display: flex; justify-content: space-between; width: 100%;">
41
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
42
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
43
+ </div>
44
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
45
+ <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>
46
+ </div>
47
+ </div>
48
+ <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>
49
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
50
+ <!-- header end -->
51
+
52
+ # Leo Hessianai 70B Chat - GGUF
53
+ - Model creator: [LAION LeoLM](https://huggingface.co/LeoLM)
54
+ - Original model: [Leo Hessianai 70B Chat](https://huggingface.co/LeoLM/leo-hessianai-70b-chat)
55
+
56
+ <!-- description start -->
57
+ ## Description
58
+
59
+ This repo contains GGUF format model files for [LAION LeoLM's Leo Hessianai 70B Chat](https://huggingface.co/LeoLM/leo-hessianai-70b-chat).
60
+
61
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
62
+
63
+ <!-- description end -->
64
+ <!-- README_GGUF.md-about-gguf start -->
65
+ ### About GGUF
66
+
67
+ 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.
68
+
69
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
70
+
71
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
72
+ * [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.
73
+ * [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.
74
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
75
+ * [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.
76
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
77
+ * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
78
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
79
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
80
+ * [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.
81
+
82
+ <!-- README_GGUF.md-about-gguf end -->
83
+ <!-- repositories-available start -->
84
+ ## Repositories available
85
+
86
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-AWQ)
87
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GPTQ)
88
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF)
89
+ * [LAION LeoLM's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/LeoLM/leo-hessianai-70b-chat)
90
+ <!-- repositories-available end -->
91
+
92
+ <!-- prompt-template start -->
93
+ ## Prompt template: ChatML
94
+
95
+ ```
96
+ <|im_start|>system
97
+ {system_message}<|im_end|>
98
+ <|im_start|>user
99
+ {prompt}<|im_end|>
100
+ <|im_start|>assistant
101
+
102
+ ```
103
+
104
+ <!-- prompt-template end -->
105
+
106
+
107
+ <!-- compatibility_gguf start -->
108
+ ## Compatibility
109
+
110
+ 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)
111
+
112
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
113
+
114
+ ## Explanation of quantisation methods
115
+
116
+ <details>
117
+ <summary>Click to see details</summary>
118
+
119
+ The new methods available are:
120
+
121
+ * 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)
122
+ * 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.
123
+ * 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.
124
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
125
+ * 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
126
+
127
+ Refer to the Provided Files table below to see what files use which methods, and how.
128
+ </details>
129
+ <!-- compatibility_gguf end -->
130
+
131
+ <!-- README_GGUF.md-provided-files start -->
132
+ ## Provided files
133
+
134
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
135
+ | ---- | ---- | ---- | ---- | ---- | ----- |
136
+ | [leo-hessianai-70b-chat.Q2_K.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q2_K.gguf) | Q2_K | 2 | 29.28 GB| 31.78 GB | smallest, significant quality loss - not recommended for most purposes |
137
+ | [leo-hessianai-70b-chat.Q3_K_S.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q3_K_S.gguf) | Q3_K_S | 3 | 29.92 GB| 32.42 GB | very small, high quality loss |
138
+ | [leo-hessianai-70b-chat.Q3_K_M.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q3_K_M.gguf) | Q3_K_M | 3 | 33.19 GB| 35.69 GB | very small, high quality loss |
139
+ | [leo-hessianai-70b-chat.Q3_K_L.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q3_K_L.gguf) | Q3_K_L | 3 | 36.15 GB| 38.65 GB | small, substantial quality loss |
140
+ | [leo-hessianai-70b-chat.Q4_0.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q4_0.gguf) | Q4_0 | 4 | 38.87 GB| 41.37 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
141
+ | [leo-hessianai-70b-chat.Q4_K_S.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q4_K_S.gguf) | Q4_K_S | 4 | 39.08 GB| 41.58 GB | small, greater quality loss |
142
+ | [leo-hessianai-70b-chat.Q4_K_M.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q4_K_M.gguf) | Q4_K_M | 4 | 41.42 GB| 43.92 GB | medium, balanced quality - recommended |
143
+ | [leo-hessianai-70b-chat.Q5_0.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q5_0.gguf) | Q5_0 | 5 | 47.46 GB| 49.96 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
144
+ | [leo-hessianai-70b-chat.Q5_K_S.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q5_K_S.gguf) | Q5_K_S | 5 | 47.46 GB| 49.96 GB | large, low quality loss - recommended |
145
+ | [leo-hessianai-70b-chat.Q5_K_M.gguf](https://huggingface.co/TheBloke/leo-hessianai-70B-chat-GGUF/blob/main/leo-hessianai-70b-chat.Q5_K_M.gguf) | Q5_K_M | 5 | 48.76 GB| 51.26 GB | large, very low quality loss - recommended |
146
+ | leo-hessianai-70b-chat.Q6_K.gguf | Q6_K | 6 | 56.59 GB| 59.09 GB | very large, extremely low quality loss |
147
+ | leo-hessianai-70b-chat.Q8_0.gguf | Q8_0 | 8 | 73.29 GB| 75.79 GB | very large, extremely low quality loss - not recommended |
148
+
149
+ **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.
150
+
151
+ ### Q6_K and Q8_0 files are split and require joining
152
+
153
+ **Note:** HF does not support uploading files larger than 50GB. Therefore I have uploaded the Q6_K and Q8_0 files as split files.
154
+
155
+ <details>
156
+ <summary>Click for instructions regarding Q6_K and Q8_0 files</summary>
157
+
158
+ ### q6_K
159
+ Please download:
160
+ * `leo-hessianai-70b-chat.Q6_K.gguf-split-a`
161
+ * `leo-hessianai-70b-chat.Q6_K.gguf-split-b`
162
+
163
+ ### q8_0
164
+ Please download:
165
+ * `leo-hessianai-70b-chat.Q8_0.gguf-split-a`
166
+ * `leo-hessianai-70b-chat.Q8_0.gguf-split-b`
167
+
168
+ To join the files, do the following:
169
+
170
+ Linux and macOS:
171
+ ```
172
+ cat leo-hessianai-70b-chat.Q6_K.gguf-split-* > leo-hessianai-70b-chat.Q6_K.gguf && rm leo-hessianai-70b-chat.Q6_K.gguf-split-*
173
+ cat leo-hessianai-70b-chat.Q8_0.gguf-split-* > leo-hessianai-70b-chat.Q8_0.gguf && rm leo-hessianai-70b-chat.Q8_0.gguf-split-*
174
+ ```
175
+ Windows command line:
176
+ ```
177
+ COPY /B leo-hessianai-70b-chat.Q6_K.gguf-split-a + leo-hessianai-70b-chat.Q6_K.gguf-split-b leo-hessianai-70b-chat.Q6_K.gguf
178
+ del leo-hessianai-70b-chat.Q6_K.gguf-split-a leo-hessianai-70b-chat.Q6_K.gguf-split-b
179
+
180
+ COPY /B leo-hessianai-70b-chat.Q8_0.gguf-split-a + leo-hessianai-70b-chat.Q8_0.gguf-split-b leo-hessianai-70b-chat.Q8_0.gguf
181
+ del leo-hessianai-70b-chat.Q8_0.gguf-split-a leo-hessianai-70b-chat.Q8_0.gguf-split-b
182
+ ```
183
+
184
+ </details>
185
+ <!-- README_GGUF.md-provided-files end -->
186
+
187
+ <!-- README_GGUF.md-how-to-download start -->
188
+ ## How to download GGUF files
189
+
190
+ **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.
191
+
192
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
193
+
194
+ * LM Studio
195
+ * LoLLMS Web UI
196
+ * Faraday.dev
197
+
198
+ ### In `text-generation-webui`
199
+
200
+ Under Download Model, you can enter the model repo: TheBloke/leo-hessianai-70B-chat-GGUF and below it, a specific filename to download, such as: leo-hessianai-70b-chat.Q4_K_M.gguf.
201
+
202
+ Then click Download.
203
+
204
+ ### On the command line, including multiple files at once
205
+
206
+ I recommend using the `huggingface-hub` Python library:
207
+
208
+ ```shell
209
+ pip3 install huggingface-hub
210
+ ```
211
+
212
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
213
+
214
+ ```shell
215
+ huggingface-cli download TheBloke/leo-hessianai-70B-chat-GGUF leo-hessianai-70b-chat.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
216
+ ```
217
+
218
+ <details>
219
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
220
+
221
+ You can also download multiple files at once with a pattern:
222
+
223
+ ```shell
224
+ huggingface-cli download TheBloke/leo-hessianai-70B-chat-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
225
+ ```
226
+
227
+ 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).
228
+
229
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
230
+
231
+ ```shell
232
+ pip3 install hf_transfer
233
+ ```
234
+
235
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
236
+
237
+ ```shell
238
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/leo-hessianai-70B-chat-GGUF leo-hessianai-70b-chat.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
239
+ ```
240
+
241
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
242
+ </details>
243
+ <!-- README_GGUF.md-how-to-download end -->
244
+
245
+ <!-- README_GGUF.md-how-to-run start -->
246
+ ## Example `llama.cpp` command
247
+
248
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
249
+
250
+ ```shell
251
+ ./main -ngl 35 -m leo-hessianai-70b-chat.Q4_K_M.gguf --color -c 8192 --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"
252
+ ```
253
+
254
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
255
+
256
+ Change `-c 8192` 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.
257
+
258
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
259
+
260
+ 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)
261
+
262
+ ## How to run in `text-generation-webui`
263
+
264
+ 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).
265
+
266
+ ## How to run from Python code
267
+
268
+ 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.
269
+
270
+ ### How to load this model in Python code, using llama-cpp-python
271
+
272
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
273
+
274
+ #### First install the package
275
+
276
+ Run one of the following commands, according to your system:
277
+
278
+ ```shell
279
+ # Base ctransformers with no GPU acceleration
280
+ pip install llama-cpp-python
281
+ # With NVidia CUDA acceleration
282
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
283
+ # Or with OpenBLAS acceleration
284
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
285
+ # Or with CLBLast acceleration
286
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
287
+ # Or with AMD ROCm GPU acceleration (Linux only)
288
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
289
+ # Or with Metal GPU acceleration for macOS systems only
290
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
291
+
292
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
293
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
294
+ pip install llama-cpp-python
295
+ ```
296
+
297
+ #### Simple llama-cpp-python example code
298
+
299
+ ```python
300
+ from llama_cpp import Llama
301
+
302
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
303
+ llm = Llama(
304
+ model_path="./leo-hessianai-70b-chat.Q4_K_M.gguf", # Download the model file first
305
+ n_ctx=8192, # The max sequence length to use - note that longer sequence lengths require much more resources
306
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
307
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
308
+ )
309
+
310
+ # Simple inference example
311
+ output = llm(
312
+ "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant", # Prompt
313
+ max_tokens=512, # Generate up to 512 tokens
314
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
315
+ echo=True # Whether to echo the prompt
316
+ )
317
+
318
+ # Chat Completion API
319
+
320
+ llm = Llama(model_path="./leo-hessianai-70b-chat.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
321
+ llm.create_chat_completion(
322
+ messages = [
323
+ {"role": "system", "content": "You are a story writing assistant."},
324
+ {
325
+ "role": "user",
326
+ "content": "Write a story about llamas."
327
+ }
328
+ ]
329
+ )
330
+ ```
331
+
332
+ ## How to use with LangChain
333
+
334
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
335
+
336
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
337
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
338
+
339
+ <!-- README_GGUF.md-how-to-run end -->
340
+
341
+ <!-- footer start -->
342
+ <!-- 200823 -->
343
+ ## Discord
344
+
345
+ For further support, and discussions on these models and AI in general, join us at:
346
+
347
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
348
+
349
+ ## Thanks, and how to contribute
350
+
351
+ Thanks to the [chirper.ai](https://chirper.ai) team!
352
+
353
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
354
+
355
+ 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.
356
+
357
+ 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.
358
+
359
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
360
+
361
+ * Patreon: https://patreon.com/TheBlokeAI
362
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
363
+
364
+ **Special thanks to**: Aemon Algiz.
365
+
366
+ **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
367
+
368
+
369
+ Thank you to all my generous patrons and donaters!
370
+
371
+ And thank you again to a16z for their generous grant.
372
+
373
+ <!-- footer end -->
374
+
375
+ <!-- original-model-card start -->
376
+ # Original model card: LAION LeoLM's Leo Hessianai 70B Chat
377
+
378
+ # LAION LeoLM 70b Chat: **L**inguistically **E**nhanced **O**pen **L**anguage **M**odel
379
+ Meet LeoLM, the first open and commercially available German Foundation Language Model built on Llama-2.
380
+ Our models extend Llama-2's capabilities into German through continued pretraining on a large corpus of German-language and mostly locality specific text.
381
+ Thanks to a compute grant at HessianAI's new supercomputer **42**, we release a series foundation models trained with 8k context length
382
+ under the [Llama-2 community license](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt). Now, we're finally releasing the
383
+ much anticipated `leo-hessianai-70b`, the largest model of this series based on `Llama-2-70b`.
384
+ With this release, we hope to bring a new wave of opportunities to German open-source and commercial LLM research and accelerate adoption.
385
+ Read our [blog post](https://laion.ai/blog/leo-lm/) or our paper (preprint coming soon) for more details!
386
+
387
+
388
+ *A project by Björn Plüster and Christoph Schuhmann in collaboration with LAION and HessianAI.*
389
+
390
+ ## LeoLM Chat
391
+ `LeoLM/leo-hessianai-70b-chat` is a German chat model built on our foundation model `LeoLM/leo-hessianai-70b` and finetuned on a selection of German instruction datasets.
392
+ The model performs exceptionally well on writing, explanation and discussion tasks but struggles somewhat with math and advanced reasoning. See our MT-Bench-DE scores:
393
+ ```
394
+ {
395
+ "first_turn": 7.2375,
396
+ "second_turn": 6.5375,
397
+ "categories": {
398
+ "writing": 8.55,
399
+ "roleplay": 7.15,
400
+ "reasoning": 4.2,
401
+ "math": 4.85,
402
+ "coding": 4.85,
403
+ "extraction": 7.75,
404
+ "stem": 8.45,
405
+ "humanities": 9.3
406
+ },
407
+ "average": 6.8875
408
+ }
409
+ ```
410
+ Have a look at some examples [in this Google Doc](https://docs.google.com/document/d/1SAAikkPAF4oLoFISqE0P1mRL5OUk8l2pI90zZC4bP1E/edit?usp=sharing).
411
+
412
+
413
+ ## Model Details
414
+
415
+ - **Finetuned from:** [LeoLM/leo-hessianai-70b](https://huggingface.co/LeoLM/leo-hessianai-70b)
416
+ - **Model type:** Causal decoder-only transformer language model
417
+ - **Language:** English and German
418
+ - **Demo:** [Web Demo]()
419
+ - **License:** [LLAMA 2 COMMUNITY LICENSE AGREEMENT](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt)
420
+ - **Contact:** [LAION Discord](https://discord.com/invite/eq3cAMZtCC) or [Björn Plüster](mailto:bjoern.pl@outlook.de)
421
+
422
+
423
+ ## Use in 🤗Transformers
424
+ First install direct dependencies:
425
+ ```
426
+ pip install transformers torch
427
+ ```
428
+ Then load the model in transformers:
429
+ ```python
430
+ from transformers import pipeline
431
+ import torch
432
+
433
+ system_prompt = """<|im_start|>system
434
+ Dies ist eine Unterhaltung zwischen einem intelligenten, hilfsbereitem KI-Assistenten und einem Nutzer.
435
+ Der Assistent gibt ausführliche, hilfreiche und ehrliche Antworten.<|im_end|>
436
+
437
+ """
438
+ prompt_format = "<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant\n"
439
+ prompt = "Erkläre mir wie die Fahrradwegesituation in Hamburg ist."
440
+
441
+ generator = pipeline(model="LeoLM/leo-hessianai-70b-chat", device="cuda", torch_dtype=torch.float16)
442
+ print(generator(prompt_format.format(prompt=prompt), do_sample=True, top_p=0.95, max_length=8192))
443
+ ```
444
+
445
+ "*Hamburg verfügt über ein umfangreiches Netzwerk an Radwegen, das ein effizientes und angenehmes Radfahren in der ganzen Stadt ermöglicht. Die Radwege variieren in Bezug auf ihre Qualität, wobei einige erstklassig mit eigens für Radfahrer reservierten Spuren sind, während andere einfache Fahrradsymbole auf dem Boden haben, die anzeigen, dass Radfahrer abwechselnd mit dem Autoverkehr auf der Straße fahren sollten. Einige Nebenstraßen haben auch spezielle Fahrradspuren, wobei einige mit Bordsteinabsenkungen zur Seite der Autospuren markiert sind. Zusätzlich haben viele Hauptstraßen, insbesondere in Nebenstraßen, fahrradfreundliche Abstände zwischen den geparkten Autos und dem Gehweg, was ein bequemes Fahren auf der Straße ermöglicht. Der Bau von Radschnellwegen, die schnelles und effizientes Radfahren in und aus der Stadt ermöglichen, ist im Gange und wird in den kommenden Jahren fortgesetzt. Insgesamt sind die Radwege in Hamburg weitläufig und gut ausgeschildert, was es zu einem angenehmen Ort macht, um mit dem Fahrrad zu fahren.*"
446
+
447
+ ## Prompting / Prompt Template
448
+
449
+ Prompt dialogue template (ChatML format):
450
+
451
+ ```
452
+ """
453
+ <|im_start|>system
454
+ {system_message}<|im_end|>
455
+ <|im_start|>user
456
+ {prompt}<|im_end|>
457
+ <|im_start|>assistant
458
+ """
459
+ ```
460
+
461
+ The model input can contain multiple conversation turns between user and assistant, e.g.
462
+ ```
463
+ <|im_start|>user
464
+ {prompt 1}<|im_end|>
465
+ <|im_start|>assistant
466
+ {reply 1}<|im_end|>
467
+ <|im_start|>user
468
+ {prompt 2}<|im_end|>
469
+ <|im_start|>assistant
470
+ (...)
471
+ ```
472
+
473
+ ## Ethical Considerations and Limitations
474
+
475
+ LeoLM has been tested in English and German, and has not covered, nor could it cover all scenarios.
476
+ For these reasons, as with all LLMs, the potential outputs of `LeoLM/leo-hessianai-70b-chat` cannot be predicted
477
+ in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses
478
+ to user prompts. Therefore, before deploying any applications of `LeoLM/leo-hessianai-70b-chat`, developers should
479
+ perform safety testing and tuning tailored to their specific applications of the model.
480
+
481
+ We are aware of the model refusing to answer more often than desired. This will be adressed in future versions. For now, the training
482
+ dataset is equal to that used for our smaller chat variants.
483
+
484
+ Please see Meta's [Responsible Use Guide](https://ai.meta.com/llama/responsible-use-guide/).
485
+
486
+ ## Finetuning Details
487
+
488
+ | Hyperparameter | Value |
489
+ |---|---|
490
+ | Num epochs | 3 |
491
+ | Examples per epoch | 131214 |
492
+ | Global batch size | 256 |
493
+ | Learning rate | 1.5e-5 |
494
+ | Warmup steps | 15 |
495
+ | LR scheduler | Cosine |
496
+ | Adam betas | (0.9, 0.95) |
497
+ | Weight Decay | 0.01 |
498
+
499
+ ## Dataset Details
500
+ ```
501
+ ## Stats for 'Subset of OpenAssistant/OASST-DE' (3534 samples (100.0%))
502
+ -----------------
503
+ Accepted: 3534/3534 (100.0%)
504
+ Accepted tokens: 2259302
505
+ Skipped: 0 (0.0%)
506
+ Min tokens per sample: 29
507
+ Max tokens per sample: 2484
508
+ Avg tokens per sample: 639.3044708545557
509
+ -----------------
510
+
511
+ ## Stats for 'Subset of FreedomIntelligence/evol-instruct-deutsch' (57841 samples (100.0%))
512
+ -----------------
513
+ Accepted: 57841/57841 (100.0%)
514
+ Accepted tokens: 42958192
515
+ Skipped: 0 (0.0%)
516
+ Min tokens per sample: 33
517
+ Max tokens per sample: 5507
518
+ Avg tokens per sample: 742.6944900675991
519
+ -----------------
520
+
521
+ ## Stats for 'Subset of FreedomIntelligence/alpaca-gpt4-deutsch' (48969 samples (100.0%))
522
+ -----------------
523
+ Accepted: 48969/48969 (100.0%)
524
+ Accepted tokens: 13372005
525
+ Skipped: 0 (0.0%)
526
+ Min tokens per sample: 19
527
+ Max tokens per sample: 1359
528
+ Avg tokens per sample: 273.07082031489307
529
+ -----------------
530
+
531
+ ## Stats for 'Subset of LeoLM/OpenSchnabeltier' (21314 samples (100.0%))
532
+ -----------------
533
+ Accepted: 21314/21314 (100.0%)
534
+ Accepted tokens: 8134690
535
+ Skipped: 0 (0.0%)
536
+ Min tokens per sample: 25
537
+ Max tokens per sample: 1202
538
+ Avg tokens per sample: 381.65947264708643
539
+ -----------------
540
+
541
+ ## Stats for 'Subset of LeoLM/German_Poems' (490 samples (100.0%))
542
+ -----------------
543
+ Accepted: 490/490 (100.0%)
544
+ Accepted tokens: 618642
545
+ Skipped: 0 (0.0%)
546
+ Min tokens per sample: 747
547
+ Max tokens per sample: 1678
548
+ Avg tokens per sample: 1262.534693877551
549
+ -----------------
550
+
551
+ ## Stats for 'Subset of LeoLM/German_Songs' (392 samples (100.0%))
552
+ -----------------
553
+ Accepted: 392/392 (100.0%)
554
+ Accepted tokens: 187897
555
+ Skipped: 0 (0.0%)
556
+ Min tokens per sample: 231
557
+ Max tokens per sample: 826
558
+ Avg tokens per sample: 479.3290816326531
559
+ -----------------
560
+
561
+ ## Stats for 'total' (132540 samples (100.0%))
562
+ -----------------
563
+ Accepted: 132540/132540 (100.0%)
564
+ Accepted tokens: 67530728
565
+ Skipped: 0 (0.0%)
566
+ Min tokens per sample: 19
567
+ Max tokens per sample: 5507
568
+ Avg tokens per sample: 509.51205673758864
569
+ -----------------
570
+ ```
571
+
572
+ <!-- original-model-card end -->