TheBloke commited on
Commit
57c1e81
1 Parent(s): d020206

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +468 -0
README.md ADDED
@@ -0,0 +1,468 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: jphme/em_german_leo_mistral
3
+ inference: false
4
+ language:
5
+ - de
6
+ library_name: transformers
7
+ license: apache-2.0
8
+ model_creator: Jan Philipp Harries
9
+ model_name: EM German Leo Mistral
10
+ model_type: mistral
11
+ pipeline_tag: text-generation
12
+ prompt_template: 'Du bist ein hilfreicher Assistent. USER: {prompt} ASSISTANT:
13
+
14
+ '
15
+ quantized_by: TheBloke
16
+ tags:
17
+ - pytorch
18
+ - german
19
+ - deutsch
20
+ - mistral
21
+ - leolm
22
+ ---
23
+
24
+ <!-- header start -->
25
+ <!-- 200823 -->
26
+ <div style="width: auto; margin-left: auto; margin-right: auto">
27
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
28
+ </div>
29
+ <div style="display: flex; justify-content: space-between; width: 100%;">
30
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
31
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
32
+ </div>
33
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
34
+ <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>
35
+ </div>
36
+ </div>
37
+ <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>
38
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
39
+ <!-- header end -->
40
+
41
+ # EM German Leo Mistral - GPTQ
42
+ - Model creator: [Jan Philipp Harries](https://huggingface.co/jphme)
43
+ - Original model: [EM German Leo Mistral](https://huggingface.co/jphme/em_german_leo_mistral)
44
+
45
+ <!-- description start -->
46
+ ## Description
47
+
48
+ This repo contains GPTQ model files for [Jan Philipp Harries's EM German Leo Mistral](https://huggingface.co/jphme/em_german_leo_mistral).
49
+
50
+ Multiple GPTQ parameter permutations are provided; see Provided Files below for details of the options provided, their parameters, and the software used to create them.
51
+
52
+ <!-- description end -->
53
+ <!-- repositories-available start -->
54
+ ## Repositories available
55
+
56
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/em_german_leo_mistral-AWQ)
57
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ)
58
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/em_german_leo_mistral-GGUF)
59
+ * [Jan Philipp Harries's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/jphme/em_german_leo_mistral)
60
+ <!-- repositories-available end -->
61
+
62
+ <!-- prompt-template start -->
63
+ ## Prompt template: EmGerman
64
+
65
+ ```
66
+ Du bist ein hilfreicher Assistent. USER: {prompt} ASSISTANT:
67
+
68
+ ```
69
+
70
+ <!-- prompt-template end -->
71
+
72
+
73
+ <!-- README_GPTQ.md-provided-files start -->
74
+ ## Provided files, and GPTQ parameters
75
+
76
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
77
+
78
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
79
+
80
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
81
+
82
+ <details>
83
+ <summary>Explanation of GPTQ parameters</summary>
84
+
85
+ - Bits: The bit size of the quantised model.
86
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
87
+ - Act Order: True or False. Also known as `desc_act`. True results in better quantisation accuracy. Some GPTQ clients have had issues with models that use Act Order plus Group Size, but this is generally resolved now.
88
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
89
+ - GPTQ dataset: The calibration dataset used during quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ calibration dataset is not the same as the dataset used to train the model - please refer to the original model repo for details of the training dataset(s).
90
+ - Sequence Length: The length of the dataset sequences used for quantisation. Ideally this is the same as the model sequence length. For some very long sequence models (16+K), a lower sequence length may have to be used. Note that a lower sequence length does not limit the sequence length of the quantised model. It only impacts the quantisation accuracy on longer inference sequences.
91
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
92
+
93
+ </details>
94
+
95
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
96
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
97
+ | [main](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [German Quad](https://huggingface.co/datasets/deepset/germanquad) | 4096 | 4.16 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
98
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [German Quad](https://huggingface.co/datasets/deepset/germanquad) | 4096 | 4.57 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
99
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [German Quad](https://huggingface.co/datasets/deepset/germanquad) | 4096 | 7.52 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
100
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [German Quad](https://huggingface.co/datasets/deepset/germanquad) | 4096 | 7.68 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
101
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [German Quad](https://huggingface.co/datasets/deepset/germanquad) | 4096 | 8.17 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
102
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [German Quad](https://huggingface.co/datasets/deepset/germanquad) | 4096 | 4.29 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
103
+
104
+ <!-- README_GPTQ.md-provided-files end -->
105
+
106
+ <!-- README_GPTQ.md-download-from-branches start -->
107
+ ## How to download, including from branches
108
+
109
+ ### In text-generation-webui
110
+
111
+ To download from the `main` branch, enter `TheBloke/em_german_leo_mistral-GPTQ` in the "Download model" box.
112
+
113
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/em_german_leo_mistral-GPTQ:gptq-4bit-32g-actorder_True`
114
+
115
+ ### From the command line
116
+
117
+ I recommend using the `huggingface-hub` Python library:
118
+
119
+ ```shell
120
+ pip3 install huggingface-hub
121
+ ```
122
+
123
+ To download the `main` branch to a folder called `em_german_leo_mistral-GPTQ`:
124
+
125
+ ```shell
126
+ mkdir em_german_leo_mistral-GPTQ
127
+ huggingface-cli download TheBloke/em_german_leo_mistral-GPTQ --local-dir em_german_leo_mistral-GPTQ --local-dir-use-symlinks False
128
+ ```
129
+
130
+ To download from a different branch, add the `--revision` parameter:
131
+
132
+ ```shell
133
+ mkdir em_german_leo_mistral-GPTQ
134
+ huggingface-cli download TheBloke/em_german_leo_mistral-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir em_german_leo_mistral-GPTQ --local-dir-use-symlinks False
135
+ ```
136
+
137
+ <details>
138
+ <summary>More advanced huggingface-cli download usage</summary>
139
+
140
+ If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Huggingface cache directory (default location on Linux is: `~/.cache/huggingface`), and symlinks will be added to the specified `--local-dir`, pointing to their real location in the cache. This allows for interrupted downloads to be resumed, and allows you to quickly clone the repo to multiple places on disk without triggering a download again. The downside, and the reason why I don't list that as the default option, is that the files are then hidden away in a cache folder and it's harder to know where your disk space is being used, and to clear it up if/when you want to remove a download model.
141
+
142
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
143
+
144
+ 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).
145
+
146
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
147
+
148
+ ```shell
149
+ pip3 install hf_transfer
150
+ ```
151
+
152
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
153
+
154
+ ```shell
155
+ mkdir em_german_leo_mistral-GPTQ
156
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/em_german_leo_mistral-GPTQ --local-dir em_german_leo_mistral-GPTQ --local-dir-use-symlinks False
157
+ ```
158
+
159
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
160
+ </details>
161
+
162
+ ### With `git` (**not** recommended)
163
+
164
+ To clone a specific branch with `git`, use a command like this:
165
+
166
+ ```shell
167
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/em_german_leo_mistral-GPTQ
168
+ ```
169
+
170
+ Note that using Git with HF repos is strongly discouraged. It will be much slower than using `huggingface-hub`, and will use twice as much disk space as it has to store the model files twice (it stores every byte both in the intended target folder, and again in the `.git` folder as a blob.)
171
+
172
+ <!-- README_GPTQ.md-download-from-branches end -->
173
+ <!-- README_GPTQ.md-text-generation-webui start -->
174
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
175
+
176
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
177
+
178
+ It is strongly recommended to use the text-generation-webui one-click-installers unless you're sure you know how to make a manual install.
179
+
180
+ 1. Click the **Model tab**.
181
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/em_german_leo_mistral-GPTQ`.
182
+ - To download from a specific branch, enter for example `TheBloke/em_german_leo_mistral-GPTQ:gptq-4bit-32g-actorder_True`
183
+ - see Provided Files above for the list of branches for each option.
184
+ 3. Click **Download**.
185
+ 4. The model will start downloading. Once it's finished it will say "Done".
186
+ 5. In the top left, click the refresh icon next to **Model**.
187
+ 6. In the **Model** dropdown, choose the model you just downloaded: `em_german_leo_mistral-GPTQ`
188
+ 7. The model will automatically load, and is now ready for use!
189
+ 8. If you want any custom settings, set them and then click **Save settings for this model** followed by **Reload the Model** in the top right.
190
+ * Note that you do not need to and should not set manual GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
191
+ 9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
192
+
193
+ <!-- README_GPTQ.md-text-generation-webui end -->
194
+
195
+ <!-- README_GPTQ.md-use-from-tgi start -->
196
+ ## Serving this model from Text Generation Inference (TGI)
197
+
198
+ It's recommended to use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
199
+
200
+ Example Docker parameters:
201
+
202
+ ```shell
203
+ --model-id TheBloke/em_german_leo_mistral-GPTQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
204
+ ```
205
+
206
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
207
+
208
+ ```shell
209
+ pip3 install huggingface-hub
210
+ ```
211
+
212
+ ```python
213
+ from huggingface_hub import InferenceClient
214
+
215
+ endpoint_url = "https://your-endpoint-url-here"
216
+
217
+ prompt = "Tell me about AI"
218
+ prompt_template=f'''Du bist ein hilfreicher Assistent. USER: {prompt} ASSISTANT:
219
+ '''
220
+
221
+ client = InferenceClient(endpoint_url)
222
+ response = client.text_generation(prompt,
223
+ max_new_tokens=128,
224
+ do_sample=True,
225
+ temperature=0.7,
226
+ top_p=0.95,
227
+ top_k=40,
228
+ repetition_penalty=1.1)
229
+
230
+ print(f"Model output: {response}")
231
+ ```
232
+ <!-- README_GPTQ.md-use-from-tgi end -->
233
+ <!-- README_GPTQ.md-use-from-python start -->
234
+ ## How to use this GPTQ model from Python code
235
+
236
+ ### Install the necessary packages
237
+
238
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
239
+
240
+ ```shell
241
+ pip3 install transformers optimum
242
+ pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
243
+ ```
244
+
245
+ If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
246
+
247
+ ```shell
248
+ pip3 uninstall -y auto-gptq
249
+ git clone https://github.com/PanQiWei/AutoGPTQ
250
+ cd AutoGPTQ
251
+ git checkout v0.4.2
252
+ pip3 install .
253
+ ```
254
+
255
+ ### You can then use the following code
256
+
257
+ ```python
258
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
259
+
260
+ model_name_or_path = "TheBloke/em_german_leo_mistral-GPTQ"
261
+ # To use a different branch, change revision
262
+ # For example: revision="gptq-4bit-32g-actorder_True"
263
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
264
+ device_map="auto",
265
+ trust_remote_code=False,
266
+ revision="main")
267
+
268
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
269
+
270
+ prompt = "Tell me about AI"
271
+ prompt_template=f'''Du bist ein hilfreicher Assistent. USER: {prompt} ASSISTANT:
272
+ '''
273
+
274
+ print("\n\n*** Generate:")
275
+
276
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
277
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
278
+ print(tokenizer.decode(output[0]))
279
+
280
+ # Inference can also be done using transformers' pipeline
281
+
282
+ print("*** Pipeline:")
283
+ pipe = pipeline(
284
+ "text-generation",
285
+ model=model,
286
+ tokenizer=tokenizer,
287
+ max_new_tokens=512,
288
+ do_sample=True,
289
+ temperature=0.7,
290
+ top_p=0.95,
291
+ top_k=40,
292
+ repetition_penalty=1.1
293
+ )
294
+
295
+ print(pipe(prompt_template)[0]['generated_text'])
296
+ ```
297
+ <!-- README_GPTQ.md-use-from-python end -->
298
+
299
+ <!-- README_GPTQ.md-compatibility start -->
300
+ ## Compatibility
301
+
302
+ The files provided are tested to work with AutoGPTQ, both via Transformers and using AutoGPTQ directly. They should also work with [Occ4m's GPTQ-for-LLaMa fork](https://github.com/0cc4m/KoboldAI).
303
+
304
+ [ExLlama](https://github.com/turboderp/exllama) is compatible with Llama and Mistral models in 4-bit. Please see the Provided Files table above for per-file compatibility.
305
+
306
+ [Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
307
+ <!-- README_GPTQ.md-compatibility end -->
308
+
309
+ <!-- footer start -->
310
+ <!-- 200823 -->
311
+ ## Discord
312
+
313
+ For further support, and discussions on these models and AI in general, join us at:
314
+
315
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
316
+
317
+ ## Thanks, and how to contribute
318
+
319
+ Thanks to the [chirper.ai](https://chirper.ai) team!
320
+
321
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
322
+
323
+ 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.
324
+
325
+ 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.
326
+
327
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
328
+
329
+ * Patreon: https://patreon.com/TheBlokeAI
330
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
331
+
332
+ **Special thanks to**: Aemon Algiz.
333
+
334
+ **Patreon special mentions**: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski
335
+
336
+
337
+ Thank you to all my generous patrons and donaters!
338
+
339
+ And thank you again to a16z for their generous grant.
340
+
341
+ <!-- footer end -->
342
+
343
+ # Original model card: Jan Philipp Harries's EM German Leo Mistral
344
+
345
+ ![EM Logo](em_model_logo_web.jpeg)
346
+
347
+ In our opinion, this is the strongest open 7b model for German-language applications.
348
+
349
+ **Many thanks to the [LeoLM](https://huggingface.co/LeoLM) team for the publication of a base model that has received continued pretraining with German texts, greatly improving generation capabilities.**
350
+
351
+ *Please note that the Mistral architecture is very recent and still not supported by all libraries (e.g. AutoGPTQ). In case of any problems, please try a different format/base model.*
352
+
353
+ # Table of Contents
354
+
355
+ 1. [Introduction](#introduction)
356
+ 2. [Links & Demos](#links--demos)
357
+ - [Model Links](#model-links)
358
+ - [Demos](#demos)
359
+ 3. [Prompt Format](#prompt-format)
360
+ 4. [Example Output](#example-output)
361
+ 5. [Acknowledgements](#acknowledgements)
362
+ 6. [Contact](#contact)
363
+ 7. [Disclaimer](#disclaimer)
364
+
365
+ # Introduction
366
+
367
+ **EM German** is a Llama2/Mistral/LeoLM-based model family, finetuned on a large dataset of various instructions in German language. The models are optimized for German text, providing proficiency in understanding, generating, and interacting with German language content.
368
+
369
+ We offer versions based on 7b, 13b and 70b Llama-2, Mistral and LeoLM (Llama-2/Mistral with continued pretraining on German texts) models.
370
+
371
+ Please find all Informations, Example Outputs, the special RAG prompt format, output examples and eval results for the EM German Model family in [our Github Repository](https://github.com/jphme/EM_German). ([Deutsche Version](https://github.com/jphme/EM_German/blob/main/README_DE.md))
372
+
373
+
374
+ # Links & Demos
375
+
376
+ ## Model Links
377
+
378
+ Should you try only one model version, I strongly recommend the **LeoLM Mistral** model which offers by far the best combination of performance and computing requirements!
379
+
380
+ | Base Model | HF | GPTQ | GGUF | AWQ |
381
+ |-------|-------|-------|-------|-------|
382
+ | Llama2 7b | [Link](https://huggingface.co/jphme/em_german_7b_v01) | [Link](https://huggingface.co/TheBloke/em_german_7b_v01-GPTQ) | [Link](https://huggingface.co/TheBloke/em_german_7b_v01-GGUF) | [Link](https://huggingface.co/TheBloke/em_german_7b_v01-AWQ) |
383
+ | Llama2 13b | [Link](https://huggingface.co/jphme/em_german_13b_v01) | [Link](https://huggingface.co/TheBloke/em_german_13b_v01-GPTQ) | [Link](https://huggingface.co/TheBloke/em_german_13b_v01-GGUF) | [Link](https://huggingface.co/TheBloke/em_german_13b_v01-AWQ) |
384
+ | Llama2 70b | [Link](https://huggingface.co/jphme/em_german_70b_v01) | [Link](https://huggingface.co/TheBloke/em_german_70b_v01-GPTQ) | [Link](https://huggingface.co/TheBloke/em_german_70b_v01-GGUF) | [Link](https://huggingface.co/TheBloke/em_german_70b_v01-AWQ) |
385
+ | [Mistral 7b](https://huggingface.co/mistralai/Mistral-7B-v0.1) | [Link](https://huggingface.co/jphme/em_german_mistral_v01) | [Link](https://huggingface.co/TheBloke/em_german_mistral_v01-GPTQ) | [Link](https://huggingface.co/TheBloke/em_german_mistral_v01-GGUF) | [Link](https://huggingface.co/TheBloke/em_german_mistral_v01-AWQ) |
386
+ | [LeoLM 7b](https://huggingface.co/LeoLM/leo-hessianai-7b) | [Link](https://huggingface.co/jphme/em_german_7b_leo) | [Link](https://huggingface.co/jphme/em_german_7b_leo_gptq) | [Link](hhttps://huggingface.co/jphme/em_german_7b_leo_gguf) | tbc |
387
+ | [LeoLM 13b](https://huggingface.co/LeoLM/leo-hessianai-13b) | soon | soon | [Link](https://huggingface.co/jphme/em_german_13b_leo_gguf) | tbc |
388
+ | [LeoLM Mistral 7b](tbc) | [Link](https://huggingface.co/jphme/em_german_leo_mistral) | soon | [Link](https://huggingface.co/jphme/em_german_leo_mistral_gguf) | tbc |
389
+
390
+ ### Notes about the different versions:
391
+ See also the [comparison of example outputs](https://github.com/jphme/EM_German/blob/main/example_output_comparison.md) for a comparison of (7b) model capabilities.
392
+
393
+ If you get unsatisfying results with one or another EM German version, please try a different (and/or larger) model or version for your usecase.
394
+
395
+
396
+ ## Demos:
397
+
398
+ You can use some of the models with **free** google Colab instances (e.g. the 7bn model in 8bit or the 13b model with GPTQ):
399
+
400
+ * [Example Colab Notebook for 13b with GPTQ](https://colab.research.google.com/drive/1IJfJdVwGkfe5MYOqHptystR3FBeEUdGn?usp=sharing)
401
+ * [Example Colab Notebook for 7b with 8bit-Loading](https://colab.research.google.com/drive/1bsv6vkLM4AlCpSyXA6ol9P32zxZmf7Zu?usp=sharing)
402
+ * [Example Colab Notebook for 7b Mistral GGUF with Grammar-based structured output](https://colab.research.google.com/drive/17O-a3D4BnVc_V9Of3dFfed18v1ULu1Sv?usp=sharing)
403
+
404
+
405
+ # Prompt Format
406
+
407
+ This model follows the Vicuna format without linebreaks (but should work with linebreaks as well). The format is as follows:
408
+
409
+ ```
410
+ Du bist ein hilfreicher Assistent. USER: <instruction> ASSISTANT:
411
+ ```
412
+
413
+ You can swap the standard system prompt for a better suited one (see below for RAG-tasks).
414
+
415
+ # Example Output
416
+
417
+ Please find a selection of various example outputs for all 7b versions of EM German [here](https://github.com/jphme/EM_German/blob/main/example_output_comparison.md).
418
+
419
+ **Prompt:**
420
+ > Erkläre die Bedeutung von drei wesentlichen Elementen der Bilanzierung und des Accountings nach IFRS für Unternehmen, die auf internationaler Ebene tätig sind.
421
+
422
+ **Antwort EM German Leo Mistral 7b:**
423
+ ```
424
+ Die International Financial Reporting Standards (IFRS) sind eine Reihe von internationalen Rechnungslegungsstandards, die von der International Accounting Standards Board (IASB) entwickelt wurden. Sie sollen dazu beitragen, dass Finanzberichte vergleichbar, zuverlässig und relevant sind.
425
+
426
+ 1. Fair Value: Dieses Konzept ist ein zentraler Bestandteil der IFRS. Es besagt, dass Vermögenswerte und Schulden zum fairen Wert bilanziert werden sollten, was dem Preis entspricht, zu dem sie zwischen Marktteilnehmern gehandelt werden könnten. Dadurch wird sichergestellt, dass das Unternehmen eine genaue Darstellung seiner finanziellen Lage liefert.
427
+
428
+ 2. Konsolidierung: Die IFRS verlangen von Unternehmen, ihre Finanzergebnisse auf konsolidierter Basis darzustellen. Das bedeutet, dass alle Tochtergesellschaften und verbundenen Unternehmen in die Bilanz des Mutterunternehmens aufgenommen werden. Dadurch wird ein klareres Bild von der finanziellen Situation des Konzerns geschaffen.
429
+
430
+ 3. Vollständigkeitsprinzip: Die IFRS verlangen von Unternehmen, alle relevanten Informationen offenzulegen. Dies umfasst sowohl positive als auch negative Faktoren, wie zum Beispiel Gewinne und Verluste, Einnahmen und Ausgaben sowie Risiken und Unsicherheiten. Durch dieses Prinzip wird sichergestellt, dass Investoren, Kreditgeber und andere Stakeholder eine umfassende Einschätzung der finanziellen Lage des Unternehmens vornehmen können.
431
+ ```
432
+
433
+ **Prompt:**
434
+ > Ein Mensch atmet durchschnittlich 16 Mal pro Minute. Wie oft atmet er an einem Tag?
435
+
436
+ **Antwort EM German Leo Mistral 7b:**
437
+ ```
438
+ Zuerst berechnen wir, wie oft eine Person in einer Stunde atmet. Wir wissen, dass eine Stunde 60 Minuten hat, also:
439
+
440
+ Atemzüge pro Stunde = Atemfrequenz * Minuten pro Stunde
441
+ = 16 Atemzüge pro Minute * 60 Minuten
442
+ = 960 Atemzüge
443
+
444
+ Um herauszufinden, wie viele Atemzüge eine Person an einem Tag macht, müssen wir diese stündliche Rate mit der Anzahl der Stunden an einem Tag multiplizieren, also 24:
445
+
446
+ Atemzüge pro Tag = Atemzüge pro Stunde * Stunden pro Tag
447
+ = 960 Atemzüge * 24 Stunden
448
+ = 23.040 Atemzüge
449
+
450
+ Also macht ein durchschnittlicher Mensch etwa 23.040 Atemzüge an einem Tag.
451
+ ```
452
+ (For more examples, please visit [our Github Repository](https://github.com/jphme/EM_German).)
453
+
454
+ # Acknowledgements:
455
+
456
+ Many thanks to [winglian/caseus](https://huggingface.co/winglian) for his great work on Axolotl which I used to train the EM mdoels. I am also grateful to [Jon Durbin](https://huggingface.co/jondurbin) and his [Airoboros](https://huggingface.co/jondurbin/airoboros-l2-70b-2.2.1) models and code from which I borrowed many ideas and code snippets.
457
+ Additionally many thanks to [Björn Plüster](https://huggingface.co/bjoernp) and the LeoLM team for the outstanding pretraining work on LeoLM and last but not least many many thanks to [TheBloke](https://huggingface.co/TheBloke) for the preparation of quantized versions in all formats under the sun.
458
+ The 70b model was trained with support of the [OVH Cloud Startup Program](https://startup.ovhcloud.com/en/).
459
+
460
+ # Contact
461
+
462
+ I you are interested in customized LLMs for business applications, please get in contact with me via [my website](https://www.jph.me). I am also always happy about suggestions and feedback.
463
+
464
+ *PS: We are also always interested in support for our startup [ellamind](https://ellamind.com), which will offer customized models for business applications in the future (we are currently still in stealth mode). If you use our models for business applications and have advanced needs for specialized capabilities, please get in touch.*
465
+
466
+ # Disclaimer:
467
+
468
+ I am not responsible for the actions of third parties who use this model or the outputs of the model. This model should only be used for research purposes. The original base model license applies and is distributed with the model files.