doubledsbv
commited on
Commit
•
dc44a30
1
Parent(s):
df7166d
Update README.md
Browse files
README.md
CHANGED
@@ -1,201 +1,135 @@
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
-
tags:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
|
7 |
|
8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
9 |
|
|
|
10 |
|
|
|
11 |
|
12 |
-
|
13 |
-
|
14 |
-
### Model Description
|
15 |
-
|
16 |
-
<!-- Provide a longer summary of what this model is. -->
|
17 |
-
|
18 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
19 |
-
|
20 |
-
- **Developed by:** [More Information Needed]
|
21 |
-
- **Funded by [optional]:** [More Information Needed]
|
22 |
-
- **Shared by [optional]:** [More Information Needed]
|
23 |
-
- **Model type:** [More Information Needed]
|
24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
25 |
-
- **License:** [More Information Needed]
|
26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
27 |
-
|
28 |
-
### Model Sources [optional]
|
29 |
-
|
30 |
-
<!-- Provide the basic links for the model. -->
|
31 |
-
|
32 |
-
- **Repository:** [More Information Needed]
|
33 |
-
- **Paper [optional]:** [More Information Needed]
|
34 |
-
- **Demo [optional]:** [More Information Needed]
|
35 |
-
|
36 |
-
## Uses
|
37 |
-
|
38 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
39 |
-
|
40 |
-
### Direct Use
|
41 |
-
|
42 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
43 |
-
|
44 |
-
[More Information Needed]
|
45 |
-
|
46 |
-
### Downstream Use [optional]
|
47 |
-
|
48 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
49 |
-
|
50 |
-
[More Information Needed]
|
51 |
-
|
52 |
-
### Out-of-Scope Use
|
53 |
-
|
54 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
55 |
-
|
56 |
-
[More Information Needed]
|
57 |
-
|
58 |
-
## Bias, Risks, and Limitations
|
59 |
-
|
60 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
61 |
-
|
62 |
-
[More Information Needed]
|
63 |
-
|
64 |
-
### Recommendations
|
65 |
-
|
66 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
67 |
-
|
68 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
69 |
-
|
70 |
-
## How to Get Started with the Model
|
71 |
-
|
72 |
-
Use the code below to get started with the model.
|
73 |
-
|
74 |
-
[More Information Needed]
|
75 |
-
|
76 |
-
## Training Details
|
77 |
-
|
78 |
-
### Training Data
|
79 |
-
|
80 |
-
<!-- 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. -->
|
81 |
-
|
82 |
-
[More Information Needed]
|
83 |
|
84 |
-
|
|
|
85 |
|
86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
87 |
|
88 |
-
|
89 |
-
|
90 |
-
[More Information Needed]
|
91 |
-
|
92 |
-
|
93 |
-
#### Training Hyperparameters
|
94 |
-
|
95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
96 |
-
|
97 |
-
#### Speeds, Sizes, Times [optional]
|
98 |
-
|
99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
100 |
-
|
101 |
-
[More Information Needed]
|
102 |
-
|
103 |
-
## Evaluation
|
104 |
-
|
105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
106 |
-
|
107 |
-
### Testing Data, Factors & Metrics
|
108 |
-
|
109 |
-
#### Testing Data
|
110 |
-
|
111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Factors
|
116 |
-
|
117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Metrics
|
122 |
-
|
123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
### Results
|
128 |
-
|
129 |
-
[More Information Needed]
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
## Environmental Impact
|
142 |
-
|
143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
144 |
-
|
145 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
146 |
|
147 |
-
|
148 |
-
- **Hours used:** [More Information Needed]
|
149 |
-
- **Cloud Provider:** [More Information Needed]
|
150 |
-
- **Compute Region:** [More Information Needed]
|
151 |
-
- **Carbon Emitted:** [More Information Needed]
|
152 |
|
153 |
-
|
154 |
|
155 |
-
### Model Architecture and Objective
|
156 |
|
157 |
-
|
158 |
|
159 |
-
|
160 |
|
161 |
-
|
162 |
|
163 |
-
#### Hardware
|
164 |
|
165 |
-
|
166 |
|
167 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
168 |
|
169 |
-
|
170 |
|
171 |
-
|
172 |
|
173 |
-
|
|
|
174 |
|
175 |
-
|
176 |
|
177 |
-
|
178 |
|
179 |
-
|
180 |
|
181 |
-
|
|
|
|
|
182 |
|
183 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
184 |
|
185 |
-
|
186 |
|
187 |
-
[More Information Needed]
|
188 |
|
189 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
190 |
|
191 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
192 |
|
193 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
194 |
|
195 |
-
[More Information Needed]
|
196 |
|
197 |
-
|
198 |
|
199 |
-
|
200 |
|
|
|
201 |
|
|
|
|
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
+
tags:
|
4 |
+
- llama2
|
5 |
+
- deutsch
|
6 |
+
- german
|
7 |
+
- seedbox
|
8 |
+
license: apache-2.0
|
9 |
+
datasets:
|
10 |
+
- seedboxai/multitask_german_examples_32k
|
11 |
+
- seedboxai/ultra_feedback_german_modified_v1
|
12 |
+
language:
|
13 |
+
- de
|
14 |
+
- en
|
15 |
+
pipeline_tag: text-generation
|
16 |
---
|
17 |
|
18 |
+
![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/645ded34a45b4182d7f5c385/oh7yRzqtRlDtdu8sJoAdV.jpeg)
|
19 |
|
|
|
20 |
|
21 |
+
# KafkaLM-7B-German-V0.1
|
22 |
|
23 |
+
**KafkaLM 70b** is a Mistral 7b model - further pre-trained on a large german dataset from Björn Plüster and LAION. [leo-mistral-hessianai-7b](https://huggingface.co/LeoLM/leo-mistral-hessianai-7b) - which was finetuned on an ensemble of popular high-quality open-source instruction sets (translated from English to German).
|
24 |
|
25 |
+
KafkaLM 7b is a [Seedbox](https://huggingface.co/seedboxai) project trained by [Dennis Dickmann](https://huggingface.co/doubledsbv).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
26 |
|
27 |
+
**Why Kafka?**
|
28 |
+
The models are proficient, yet creative, have some tendencies to linguistically push boundaries 😊
|
29 |
|
|
|
30 |
|
31 |
+
## Model Details
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
32 |
|
33 |
+
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.
|
|
|
|
|
|
|
|
|
34 |
|
35 |
+
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.
|
36 |
|
|
|
37 |
|
38 |
+
### Dataset
|
39 |
|
40 |
+
I used a 8k filtered version of the following [seedboxai/multitask_german_examples_32k](https://huggingface.co/datasets/seedboxai/multitask_german_examples_32k)
|
41 |
|
42 |
+
### Prompt Format
|
43 |
|
|
|
44 |
|
45 |
+
This model follows the subsequent prompt format:
|
46 |
|
47 |
+
```
|
48 |
+
<|system|>
|
49 |
+
Du bist ein freundlicher und hilfsbereiter KI-Assistent. Du beantwortest Fragen faktenorientiert und präzise, ohne dabei relevante Fakten auszulassen.</s>
|
50 |
+
<|user|>
|
51 |
+
Welche Möglichkeiten der energetischen Sanierung habe ich neben Solar und Energiespeicher?</s>
|
52 |
+
<|assistant|>
|
53 |
+
```
|
54 |
|
55 |
+
### Inference
|
56 |
|
57 |
+
Getting started with the model is straightforward
|
58 |
|
59 |
+
```python
|
60 |
+
import transformers
|
61 |
|
62 |
+
model_id = "seedboxai/KafkaLM-7B-German-V0.1"
|
63 |
|
64 |
+
model = AutoModelForCausalLM.from_pretrained(model_id, load_in_4bit=True)
|
65 |
|
66 |
+
tokenizer = AutoTokenizer.from_pretrained(model_id)
|
67 |
|
68 |
+
tokenizer.padding_side = "right"
|
69 |
+
tokenizer.pad_token = tokenizer.unk_token
|
70 |
+
tokenizer.add_eos_token = False
|
71 |
|
72 |
+
def generate_prompt(input):
|
73 |
+
prompt = ''
|
74 |
+
sys_prompt = "Du bist ein freundlicher und hilfsbereiter KI-Assistent. Du beantwortest Fragen faktenorientiert und präzise, ohne dabei relevante Fakten auszulassen."
|
75 |
+
|
76 |
+
prompt += f"<|system|>\n{sys_prompt.strip()}</s>\n"
|
77 |
+
prompt += f"<|user|>\n{input.strip()}</s>\n"
|
78 |
+
prompt += f"<|assistant|>\n"
|
79 |
|
80 |
+
return prompt.strip()
|
81 |
|
|
|
82 |
|
83 |
+
def evaluate(
|
84 |
+
input,
|
85 |
+
temperature=0.7,
|
86 |
+
top_p=0.95,
|
87 |
+
top_k=50,
|
88 |
+
num_beams=3,
|
89 |
+
max_new_tokens=512,
|
90 |
+
#max_length=8192,
|
91 |
+
**kwargs,
|
92 |
+
):
|
93 |
+
prompt = generate_prompt(input)
|
94 |
|
95 |
+
#print(prompt)
|
96 |
+
|
97 |
+
inputs = tokenizer(prompt, return_tensors="pt")
|
98 |
+
input_ids = inputs["input_ids"].to(device)
|
99 |
+
attention_mask=inputs["attention_mask"].to(device)
|
100 |
+
generation_config = GenerationConfig(
|
101 |
+
temperature=temperature,
|
102 |
+
top_p=top_p,
|
103 |
+
top_k=top_k,
|
104 |
+
num_beams=num_beams,
|
105 |
+
no_repeat_ngram_size=3,
|
106 |
+
do_sample=True,
|
107 |
+
**kwargs,
|
108 |
+
)
|
109 |
|
110 |
+
with torch.no_grad():
|
111 |
+
generation_output = model.generate(
|
112 |
+
early_stopping=False,
|
113 |
+
#eos_token_id=tokenizer.eos_token_id,
|
114 |
+
#pad_token_id=tokenizer.pad_token_id,
|
115 |
+
input_ids=input_ids,
|
116 |
+
attention_mask=attention_mask,
|
117 |
+
generation_config=generation_config,
|
118 |
+
return_dict_in_generate=True,
|
119 |
+
output_scores=True,
|
120 |
+
max_new_tokens=max_new_tokens,
|
121 |
+
#max_length= max_length
|
122 |
+
)
|
123 |
+
s = generation_output.sequences[0]
|
124 |
+
output = tokenizer.decode(s)
|
125 |
+
return output #.split("<|assistant|>")[1].strip()
|
126 |
|
|
|
127 |
|
128 |
+
print(evaluate("Wer ist eigentlich dieser Kafka?"))
|
129 |
|
130 |
+
```
|
131 |
|
132 |
+
## Disclaimer
|
133 |
|
134 |
+
The license on this model does not constitute legal advice. We are not responsible for the actions of third parties who use this model.
|
135 |
+
This model should only be used for research purposes. The original Llama2 license and all restrictions of datasets used to train this model apply.
|