Update README.md

README.md

@@ -3,9 +3,18 @@ license: llama3
 language:
 - gsw
 datasets:
+- cis-lmu/Glot500
 - cis-lmu/GlotCC-V1
 pipeline_tag: text-generation
 base_model: NousResearch/Hermes-2-Pro-Llama-3-8B
+model_type: LlamaForCausalLM
+tags:
+- Llama-3
+- instruct
+- finetune
+- chatml
+- synthetic data
+- axolotl
 ---
 
 # Alpesteibock-Llama-3-8B-Alpha
@@ -14,15 +23,31 @@ base_model: NousResearch/Hermes-2-Pro-Llama-3-8B
 
 ## License
 
-This model is release under the [Llama 3 Community License](https://llama.meta.com/llama3/license/).
+This model is released under the [Llama 3 Community License](https://llama.meta.com/llama3/license/).
+
+## Usage
+
+The model uses ChatML as an instruction template and was trained using "You are Alpesteibock, a helpful assistant who speaks Swiss German." as a system message:
+```
+<|im_start|>system
+You are Alpesteibock, a helpful assistant who speaks Swiss German.<|im_end|>
+<|im_start|>user
+Hoi. Wie heissisch du?<|im_end|>
+<|im_start|>assistant
+Ich bi de Alpesteibock und ich freu mi uf di.<|im_end|>
+```
 
 ## Dataset
 
+The dataset used for training consists of the following sources:
+
 | Dataset | File Size | Description | Phase |
 |---------|-----------|-------------|-------|
+| [Glot500 Corpus](https://huggingface.co/datasets/cis-lmu/Glot500) (gsw_Latn, Leipzig_web) | 21.7 MB | Text, usually sentences, crawled from the web | 1 |
 | [Alemannic Wikipedia](https://dumps.wikimedia.org/alswiki/) (Subset) | 50.5 MB | Articles in the Alemannic Wikipedia with most of those written in Alsatian filtered out | 2 |
 | [Schweizerdeutscher Mundartkorpus](https://chmk.ch/) (Copyright Free Subset) | 28.4 MB | Copyright free books written in Swiss German | 2 |
 | [GlotCC-V1.0](https://huggingface.co/datasets/cis-lmu/GlotCC-V1) (gsw-Latn) | 7.5 MB | Document-level general domain monolingual dataset derived from CommonCrawl | 2 |
+| Synthetic Instruction Data | 1.7 MB | Different datasets of synthetically generated Swiss German text | 2 |
 
 ## Training Details