Update README.md
Browse files
README.md
CHANGED
@@ -23,199 +23,87 @@ tags:
|
|
23 |
|
24 |
|
25 |
# LAION LeoLM 70b Chat: **L**inguistically **E**nhanced **O**pen **L**anguage **M**odel
|
26 |
-
|
27 |
-
Our models extend Llama-2's capabilities into German through continued pretraining on a large corpus of German-language and mostly locality specific text.
|
28 |
-
Thanks to a compute grant at HessianAI's new supercomputer **42**, we release a series foundation models trained with 8k context length
|
29 |
-
under the [Llama-2 community license](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt). Now, we're finally releasing the
|
30 |
-
much anticipated `leo-hessianai-70b`, the largest model of this series based on `Llama-2-70b`.
|
31 |
-
With this release, we hope to bring a new wave of opportunities to German open-source and commercial LLM research and accelerate adoption.
|
32 |
-
Read our [blog post](https://laion.ai/blog/leo-lm/) or our paper (preprint coming soon) for more details!
|
33 |
|
34 |
-
##
|
|
|
35 |
|
36 |
-
|
|
|
37 |
|
38 |
-
|
39 |
|
|
|
40 |
|
41 |
|
42 |
-
- **Developed by:** [More Information Needed]
|
43 |
-
- **Funded by [optional]:** [More Information Needed]
|
44 |
-
- **Shared by [optional]:** [More Information Needed]
|
45 |
-
- **Model type:** [More Information Needed]
|
46 |
-
- **Language(s) (NLP):** [More Information Needed]
|
47 |
-
- **License:** [More Information Needed]
|
48 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
49 |
-
|
50 |
-
### Model Sources [optional]
|
51 |
-
|
52 |
-
<!-- Provide the basic links for the model. -->
|
53 |
-
|
54 |
-
- **Repository:** [More Information Needed]
|
55 |
-
- **Paper [optional]:** [More Information Needed]
|
56 |
-
- **Demo [optional]:** [More Information Needed]
|
57 |
-
|
58 |
## Uses
|
59 |
|
60 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
61 |
-
|
62 |
### Direct Use
|
|
|
63 |
|
64 |
-
|
65 |
-
|
66 |
-
[More Information Needed]
|
67 |
-
|
68 |
-
### Downstream Use [optional]
|
69 |
-
|
70 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
71 |
-
|
72 |
-
[More Information Needed]
|
73 |
|
74 |
### Out-of-Scope Use
|
75 |
-
|
76 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
77 |
-
|
78 |
-
[More Information Needed]
|
79 |
|
80 |
## Bias, Risks, and Limitations
|
81 |
|
82 |
-
|
83 |
-
|
84 |
-
[More Information Needed]
|
85 |
|
86 |
### Recommendations
|
87 |
|
88 |
-
|
89 |
|
90 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
91 |
|
92 |
## How to Get Started with the Model
|
93 |
|
94 |
-
|
95 |
-
|
96 |
-
[More Information Needed]
|
97 |
-
|
98 |
-
## Training Details
|
99 |
-
|
100 |
-
### Training Data
|
101 |
-
|
102 |
-
<!-- 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. -->
|
103 |
-
|
104 |
-
[More Information Needed]
|
105 |
-
|
106 |
-
### Training Procedure
|
107 |
-
|
108 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
109 |
-
|
110 |
-
#### Preprocessing [optional]
|
111 |
-
|
112 |
-
[More Information Needed]
|
113 |
-
|
114 |
-
|
115 |
-
#### Training Hyperparameters
|
116 |
-
|
117 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
118 |
-
|
119 |
-
#### Speeds, Sizes, Times [optional]
|
120 |
-
|
121 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
122 |
-
|
123 |
-
[More Information Needed]
|
124 |
-
|
125 |
-
## Evaluation
|
126 |
-
|
127 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
128 |
-
|
129 |
-
### Testing Data, Factors & Metrics
|
130 |
-
|
131 |
-
#### Testing Data
|
132 |
-
|
133 |
-
<!-- This should link to a Dataset Card if possible. -->
|
134 |
-
|
135 |
-
[More Information Needed]
|
136 |
-
|
137 |
-
#### Factors
|
138 |
-
|
139 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
140 |
-
|
141 |
-
[More Information Needed]
|
142 |
-
|
143 |
-
#### Metrics
|
144 |
-
|
145 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
146 |
-
|
147 |
-
[More Information Needed]
|
148 |
-
|
149 |
-
### Results
|
150 |
-
|
151 |
-
[More Information Needed]
|
152 |
-
|
153 |
-
#### Summary
|
154 |
-
|
155 |
-
|
156 |
-
|
157 |
-
## Model Examination [optional]
|
158 |
-
|
159 |
-
<!-- Relevant interpretability work for the model goes here -->
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
## Environmental Impact
|
164 |
-
|
165 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
166 |
-
|
167 |
-
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).
|
168 |
-
|
169 |
-
- **Hardware Type:** [More Information Needed]
|
170 |
-
- **Hours used:** [More Information Needed]
|
171 |
-
- **Cloud Provider:** [More Information Needed]
|
172 |
-
- **Compute Region:** [More Information Needed]
|
173 |
-
- **Carbon Emitted:** [More Information Needed]
|
174 |
-
|
175 |
-
## Technical Specifications [optional]
|
176 |
-
|
177 |
-
### Model Architecture and Objective
|
178 |
-
|
179 |
-
[More Information Needed]
|
180 |
-
|
181 |
-
### Compute Infrastructure
|
182 |
-
|
183 |
-
[More Information Needed]
|
184 |
-
|
185 |
-
#### Hardware
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
#### Software
|
190 |
-
|
191 |
-
[More Information Needed]
|
192 |
-
|
193 |
-
## Citation [optional]
|
194 |
-
|
195 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
196 |
-
|
197 |
-
**BibTeX:**
|
198 |
|
199 |
-
|
200 |
|
201 |
-
|
202 |
|
203 |
-
|
204 |
|
205 |
-
|
206 |
|
207 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
208 |
|
209 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
210 |
|
211 |
-
|
212 |
|
213 |
-
[More Information Needed]
|
214 |
|
215 |
-
|
216 |
|
217 |
-
|
218 |
|
219 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
220 |
|
221 |
-
|
|
|
23 |
|
24 |
|
25 |
# LAION LeoLM 70b Chat: **L**inguistically **E**nhanced **O**pen **L**anguage **M**odel
|
26 |
+
Dieses Modell ist eine quantisierte Version des LeoLM/leo-hessianai-70b, einem der leistungsfähigsten öffentlich zugänglichen Sprachmodelle für die deutsche Sprache, basierend auf Llama-2. Durch die Quantisierung mit der Q5_K_M-Methode ist es möglich, das Modell effizient auf Hardware wie dem MacBook Pro M3 Max zu betreiben. Trotz der Anpassung durch Quantisierung bietet das Modell eine beeindruckende Leistung für eine Vielzahl von Textgenerierungs- und Verständnisaufgaben in deutscher Sprache.
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
+
## Verwendungshinweise
|
29 |
+
Das Modell ist für den Einsatz in der deutschen Sprache optimiert und eignet sich hervorragend für Anwendungen wie Textgenerierung, Übersetzung und weitere NLP-Aufgaben. Es wurde speziell quantisiert, um eine lokale Ausführung auf Computern mit begrenzten Ressourcen zu ermöglichen, ohne dabei signifikant an Genauigkeit oder Reaktionsfähigkeit zu verlieren.
|
30 |
|
31 |
+
## Anerkennungen
|
32 |
+
Ein besonderer Dank gilt dem llama.cpp-Team für den Quantisierungscode und dem LeoLM-Team für die Entwicklung des ursprünglichen Modells. Diese Arbeit wäre ohne ihre wertvollen Beiträge nicht möglich gewesen. Weiterhin vielen Dank an TheBloke, an dessen ausführungen die Modellbeschreibung angelehnt ist.
|
33 |
|
34 |
+
## Lizenz
|
35 |
|
36 |
+
Bitte beachten Sie die Lizenzbedingungen des ursprünglichen Modells sowie jegliche zusätzliche Richtlinien, die für die Nutzung der quantisierten Version gelten.
|
37 |
|
38 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
39 |
## Uses
|
40 |
|
|
|
|
|
41 |
### Direct Use
|
42 |
+
Das LeoLM 70B - Q5_K_M quantisierte Modell ist für eine direkte Nutzung in Anwendungen der natürlichen Sprachverarbeitung (NLP) vorgesehen, einschließlich, aber nicht beschränkt auf Textgenerierung, Übersetzung, Zusammenfassung und weitere Aufgaben, die eine Verarbeitung der deutschen Sprache erfordern.
|
43 |
|
44 |
+
### Downstream Use
|
45 |
+
Das Modell kann weiter für spezifische NLP-Aufgaben feinabgestimmt werden, um die Leistung in spezialisierten Domänen oder Anwendungen zu verbessern. Es kann auch in größere Systeme oder Plattformen integriert werden, die NLP-Funktionen benötigen.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
46 |
|
47 |
### Out-of-Scope Use
|
48 |
+
Nicht vorgesehen ist der Einsatz des Modells für Zwecke, die ethische Richtlinien verletzen, illegale Aktivitäten unterstützen oder Schaden für Individuen oder Gruppen verursachen könnten.
|
|
|
|
|
|
|
49 |
|
50 |
## Bias, Risks, and Limitations
|
51 |
|
52 |
+
Das Modell erbt potenzielle Verzerrungen und Einschränkungen von seinem Trainingsdatensatz sowie den Risiken, die mit großen Sprachmodellen verbunden sind, einschließlich, aber nicht beschränkt auf, die Reproduktion oder Verstärkung bestehender gesellschaftlicher Vorurteile.
|
|
|
|
|
53 |
|
54 |
### Recommendations
|
55 |
|
56 |
+
Anwender sollten sich der Limitationen und möglichen Verzerrungen des Modells bewusst sein und entsprechende Maßnahmen zur Minderung dieser Risiken ergreifen, einschließlich der Überprüfung der Ausgaben und der Implementierung von Sicherheitsmechanismen.
|
57 |
|
|
|
58 |
|
59 |
## How to Get Started with the Model
|
60 |
|
61 |
+
Das LeoLM 70B - Q5_K_M quantisierte Modell ist im GGUF-Format verfügbar und kann nicht direkt mit der Hugging Face Transformers-Bibliothek genutzt werden. Stattdessen wird es mit dem llama.cpp-Projekt ausgeführt, das eine effiziente Ausführung quantisierter Modelle auf verschiedenen Hardwarekonfigurationen ermöglicht, einschließlich Unterstützung für GPU-Beschleunigung.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
62 |
|
63 |
+
### Installation und Ausführung mit llama.cpp
|
64 |
|
65 |
+
Besuchen Sie die GitHub-Seite von [llama.cpp](https://github.com/ggerganov/llama.cpp) für Anweisungen zur Installation und Verwendung mit GGUF-Modellen. Nach der Installation können Sie das Modell mit dem CLI oder dem Server von llama.cpp ausführen.
|
66 |
|
67 |
+
## Prompting / Prompt Template
|
68 |
|
69 |
+
Das Modell unterstützt das folgende Prompt-Template im ChatML-Format für die Interaktion:
|
70 |
|
71 |
+
```
|
72 |
+
"""
|
73 |
+
<|im_start|>system
|
74 |
+
{system_message}<|im_end|>
|
75 |
+
<|im_start|>user
|
76 |
+
{prompt}<|im_end|>
|
77 |
+
<|im_start|>assistant
|
78 |
+
"""
|
79 |
+
```
|
80 |
|
81 |
+
The model input can contain multiple conversation turns between user and assistant, e.g.
|
82 |
+
```
|
83 |
+
<|im_start|>user
|
84 |
+
{prompt 1}<|im_end|>
|
85 |
+
<|im_start|>assistant
|
86 |
+
{reply 1}<|im_end|>
|
87 |
+
<|im_start|>user
|
88 |
+
{prompt 2}<|im_end|>
|
89 |
+
<|im_start|>assistant
|
90 |
+
(...)
|
91 |
+
```
|
92 |
|
93 |
+
Beachten Sie, dass im Modell die Tokens `|im_start|` und `|im_end|` durch einen Tokenizerfehler ersetzt sind.
|
94 |
|
|
|
95 |
|
96 |
+
### About GGUF
|
97 |
|
98 |
+
GGUF ist ein neues Format, das am 21. August 2023 vom llama.cpp-Team eingeführt wurde. Es dient als Ersatz für das GGML-Format, welches von llama.cpp nicht mehr unterstützt wird. GGUF-Modelle sind mit einer Vielzahl von Clients und Bibliotheken kompatibel, darunter:
|
99 |
|
100 |
+
- [llama.cpp](https://github.com/ggerganov/llama.cpp): Das Quellprojekt für GGUF. Bietet eine CLI- und eine Serveroption.
|
101 |
+
- [text-generation-webui](https://github.com/oobabooga/text-generation-webui): Die am weitesten verbreitete Web-UI mit vielen Funktionen und leistungsstarken Erweiterungen. Unterstützt GPU-Beschleunigung.
|
102 |
+
- [KoboldCpp](https://github.com/LostRuins/koboldcpp): Eine voll ausgestattete Web-UI, die GPU-Beschleunigung auf allen Plattformen und GPU-Architekturen bietet. Besonders geeignet für Storytelling.
|
103 |
+
- [GPT4All](https://gpt4all.io/index.html): Eine kostenlose und Open-Source-GUI für den lokalen Betrieb, unterstützt Windows, Linux und macOS mit voller GPU-Beschleunigung.
|
104 |
+
- [LM Studio](https://lmstudio.ai/): Eine benutzerfreundliche und leistungsstarke lokale GUI für Windows und macOS (Silicon) mit GPU-Beschleunigung. Linux ist als Beta-Version verfügbar.
|
105 |
+
- [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui): Eine großartige Web-UI mit vielen interessanten und einzigartigen Funktionen, einschließlich einer vollständigen Modellbibliothek für eine einfache Modellauswahl.
|
106 |
+
- [Faraday.dev](https://faraday.dev/): Eine attraktive und einfach zu bedienende Chat-GUI für Windows und macOS (Silicon und Intel) mit GPU-Beschleunigung.
|
107 |
+
- [llama-cpp-python](https://github.com/abetlen/llama-cpp-python): Eine Python-Bibliothek mit GPU-Beschleunigung, LangChain-Unterstützung und einem OpenAI-kompatiblen API-Server.
|
108 |
|
109 |
+
Für detaillierte Informationen zur Nutzung des GGUF-Formats und zur Kompatibilität mit verschiedenen Tools besuchen Sie die entsprechenden Projektseiten.
|