Update README.md

README.md

@@ -31,14 +31,45 @@ The model performs exceptionally well on writing, explanation and discussion tas
 
 ## Model Details
 
-- **Finetuned from:** [LeoLM/leo-hessianai-13b](https://huggingface.co/LeoLM/leo-hessianai-13b)
+- **Finetuned from:** [LeoLM/leo-hessianai-13b](https://huggingface.co/LeoLM/leo-hessianai-7b)
 - **Model type:** Causal decoder-only transformer language model
 - **Language:** English and German
-- **Demo:** [Continuations for 250 random prompts (TGI, 4bit nf4 quantization)](https://open-assistant.github.io/oasst-model-eval/?f=https%3A%2F%2Fraw.githubusercontent.com%2FOpen-Assistant%2Foasst-model-eval%2Fmain%2Fsampling_reports%2Foasst-sft%2F2023-08-22_OpenAssistant_llama2-70b-oasst-sft-v10_sampling_noprefix2_nf4.json%0A)
+- **Demo:** [Web Demo]()
 - **License:** [LLAMA 2 COMMUNITY LICENSE AGREEMENT](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt)
 - **Contact:** [LAION Discord](https://discord.com/invite/eq3cAMZtCC) or [Björn Plüster](mailto:bjoern.pl@outlook.de)
 
 
+## Use in 🤗Transformers
+First install direct dependencies:
+```
+pip install transformers torch sentencepiece
+```
+If you want faster inference using flash-attention2, you need to install these dependencies:
+```bash
+pip install packaging ninja
+pip install flash-attn==v2.1.1 --no-build-isolation
+pip install git+https://github.com/HazyResearch/flash-attention.git@v2.1.1#subdirectory=csrc/rotary
+```
+Then load the model in transformers:
+```python
+from transformers import pipeline
+
+system_prompt = """<|im_start|>system
+Dies ist eine Unterhaltung zwischen einem intelligenten, hilfsbereitem KI-Assistenten und einem Nutzer.
+Der Assistent gibt ausführliche, hilfreiche und ehrliche Antworten.<|im_end|>
+
+"""
+prompt_format = "<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant\n"
+prompt = "Erkläre mir wie die Fahrradwegesituation in Hamburg ist."
+
+generator = pipeline(model="LeoLM/leo-hessianai-13b-chat", device="cuda", torch_dtype=torch.float16, trust_remote_code=True) # True for flash-attn2 else False
+print(generator(prompt_format.format(prompt=prompt), do_sample=True, top_p=0.95, max_length=8192))
+```
+
+"*Als KI kann ich keine persönlichen Beobachtungen teilen, aber ich kann einige allgemeine Informationen zur Fahrradwegesituation in Hamburg liefern. Im Vergleich zu vielen anderen großen Städten hat Hamburg eine hohe Anzahl von Fahrradfahrern und nimmt seine Verantwortung für nachhaltige Verkehrsmittel sehr ernst. Es gibt viele Fahrradwege und separate Fahrspuren, die Radfahrern ermöglichen, zusammen mit dem Autoverkehr zu fahren. Diese Fahrradspuren sind oft mit Markierungen gekennzeichnet und durch physische Trennungen von anderen Fahrspuren abgegrenzt. Darüber hinaus gibt es viele Fahrradstraßen, auf denen Radfahrer Vorfahrt haben und Autos langsamer fahren müssen.*
+
+*In einigen städtischen Gebieten können Fahrradwege jedoch eng oder überfüllt sein, besonders während der Stoßzeiten. Es gibt auch viele Kreuzungen, an denen Radfahrer anhalten und auf Grün warten müssen, ähnlich wie Autofahrer. Insgesamt ist die Fahrradinfrastruktur in Hamburg ziemlich gut, aber wie überall gibt es immer Raum für Verbesserungen.*"
+
 ## Prompting / Prompt Template
 
 Prompt dialogue template (ChatML format):
@@ -75,6 +106,19 @@ perform safety testing and tuning tailored to their specific applications of the
 
 Please see Meta's [Responsible Use Guide](https://ai.meta.com/llama/responsible-use-guide/).
 
+## Finetuning Details
+
+| Hyperparameter  | Value  |
+|---|---|
+| Num epochs | 3 |
+| Examples per epoch  | 131214  |
+| Global batch size | 256 |
+| Learning rate  |  3e-5 |
+| Warmup steps  |  100 |
+| LR scheduler  |  Cosine |
+| Adam betas  | (0.9, 0.95)  |
+
+
 ## Dataset Details
 ```
 ## Stats for 'Subset of OpenAssistant/OASST-DE' (3534 samples (100.0%))