Create README.md

README.md

@@ -0,0 +1,175 @@
+---
+license: llama3
+language:
+- de
+library_name: transformers
+base_model: DiscoResearch/Llama3-German-8B
+pipeline_tag: text-generation
+---
+
+# Llama3-German-8B-GGUF
+
+This is quantized version of [DiscoResearch/Llama3-German-8B](https://huggingface.co/DiscoResearch/Llama3-German-8B) created using llama.cpp
+
+## Model Description
+
+Llama3-German-8B-v0.1 is a large language model based on [Meta's Llama3-8B](https://huggingface.co/meta-llama/Meta-Llama-3-8B). It is specialized for the German language through continuous pretraining on 65 billion high-quality tokens, similar to previous [LeoLM](https://huggingface.co/LeoLM) or [Occiglot](https://huggingface.co/collections/occiglot/occiglot-eu5-7b-v01-65dbed502a6348b052695e01) models.
+
+Llama3 itself was trained on 15T tokens, of which only <1T were multilingual, resulting in suboptimal performance in German with reduced linguistic capabilities and frequent grammatical errors, motivating the necessity for continued pretraining. Benchmark results on our model show minimal degradation in English performance, despite the absence of replay during training. Importantly, Llama3-German-8B-v0.1 demonstrates strong improvements in German, particularly on the Hellaswag benchmark, which measures linguistic understanding and general reasoning. 
+
+[DiscoResearch/Llama3-German-8B-v0.1](https://huggingface.co/collections/DiscoResearch/discoleo-8b-llama3-for-german-6650527496c0fafefd4c9729) is the result of a joint effort between [DiscoResearch](https://huggingface.co/DiscoResearch) and [Occiglot](https://huggingface.co/occiglot) with support from the [DFKI](https://www.dfki.de/web/) (German Research Center for Artificial Intelligence) and [hessian.Ai](https://hessian.ai). Occiglot kindly handled data preprocessing, filtering, and deduplication as part of their latest [dataset release](https://huggingface.co/datasets/occiglot/occiglot-fineweb-v0.5), as well as sharing their compute allocation at hessian.Ai's 42 Supercomputer.
+
+## How to use
+This is a base model and should probably be subject to finetuning before use. See our [collection](https://huggingface.co/collections/DiscoResearch/discoleo-8b-llama3-for-german-6650527496c0fafefd4c9729) for various finetuned and long-context versions.
+
+## Model Training and Hyperparameters
+The model was trained on 128 GPUs on [hessian.Ai 42](hessian.ai) for ~60 hours. See detailed hyperparameters below.
+
+| Parameter         | Value                             |
+|-------------------|-----------------------------------|
+| Sequence Length   | 8192 tokens                       |
+| Learning Rate     | 1.5e-5 to 1.5e-6 (cosine schedule)|
+| Batch Size        | 4194304 (512*8192) tokens         |
+| Micro Batch Size  | 4*8192 tokens                     |
+| Training Steps    | 15500                             |
+| Warmup Steps      | 155 (1%)                          |
+| Weight Decay      | 0.05                              |
+| Optimizer         | AdamW                             |
+
+
+## Data Collection and Preprocessing
+
+For pre-training, we used 65B German tokens from the [occiglot-fineweb-0.5](https://huggingface.co/datasets/occiglot/occiglot-fineweb-v0.5) dataset. 
+The data comprises multiple curated datasets from [LLM-Datasets](https://github.com/malteos/llm-datasets) as well as 12 [Common-Crawl](https://commoncrawl.org) releases that were processed with [OSCAR's Ungoliant pipeline](https://github.com/oscar-project/ungoliant). 
+
+All data was further filtered with a set of language-specific filters based on [Huggingface's fine-web](https://github.com/huggingface/datatrove/blob/main/examples/fineweb.py) and globally deduplicated. 
+
+For more information please refer to the [dataset card](https://huggingface.co/datasets/occiglot/occiglot-fineweb-v0.5) and corresponding [blog-post](https://occiglot.eu/posts/occiglot-fineweb/).
+
+## Evaluation and Results
+
+We evaluated the model using a suite of common English Benchmarks and their German counterparts with [GermanBench](https://github.com/bjoernpl/GermanBenchmark).
+
+The following figure shows the benchmark results in comparison to the base model [meta-llama/Meta-Llama3-8B](https://huggingface.co/meta-llama/Meta-Llama-3-8B) and two different hyperparameter configurations. 
+We swept different learning rates to identify a well-working setup. The final released model is the 1.5e-5 lr version.
+![alt text](base_model_evals.png)
+
+Find the detailed benchmark scores for the base and long-context models in this table.
+
+| Model                                | truthful_qa_de | truthfulqa_mc | arc_challenge | arc_challenge_de | hellaswag | hellaswag_de | MMLU   | MMLU-DE | mean       |
+|--------------------------------------|----------------|---------------|---------------|------------------|-----------|--------------|--------|---------|------------|
+| DiscoResearch/Llama3-German-8B       | **0.49499**    | 0.44838       | 0.55802       | **0.49829**      | 0.79924   | **0.65395**  | 0.62240| **0.54413** | **0.57743** |
+| DiscoResearch/Llama3-German-8B-32k   | 0.48920        | **0.45138**   | 0.54437       | 0.49232          | 0.79078   | 0.64310      | 0.58774| 0.47971  | 0.55982    |
+| meta-llama/Meta-Llama-3-8B-Instruct  | 0.47498        | 0.43923       | **0.59642**   | 0.47952          | **0.82025**| 0.60008      | **0.66658**| 0.53541  | 0.57656    |
+
+## Long-Context Extension
+
+In addition to the base model, we release a long-context version of Llama3-German-8B ([DiscoResearch/Llama3-German-8B-32k](https://huggingface.co/DiscoResearch/Llama3-German-8B-32k) capable of processing context lengths up to 65k tokens. This variant was trained on an additional 100 million tokens at 32k context length, using a rope_theta value of `1.5e6` and a learning rate of `1.5e-5` with a batch size of `256*8192` tokens and otherwise equal hyperparameters to the base model. 
+
+## Instruction Tuning
+
+We also provide an instruction-tuned version: [DiscoResearch/Llama3-DiscoLeo-Instruct-8B-v0.1](https://huggingface.co/DiscoResearch/Llama3-DiscoLeo-Instruct-8B-v0.1), utilizing the DiscoLM German dataset for fine-tuning (also available as a long-context model at [DiscoResearch/Llama3-DiscoLeo-Instruct-8B-32k-v0.1](https://huggingface.co/DiscoResearch/Llama3-DiscoLeo-Instruct-8B-v0.1)).
+Find more details in the respective model cards. Also check out our experimental merge ([DiscoResearch/Llama3-DiscoLeo-8B-DARE-Experimental](https://huggingface.co/DiscoResearch/Llama3-DiscoLeo-8B-DARE-Experimental)) between [meta-llama/Meta-Llama3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct) and our finetuned model in an attempt to keep the extraordinary capabilities of Llama3-Instruct and add exceptional German skills.
+
+## Document Packing
+
+We employed a more intelligent document packing strategy based on the ["Fewer Truncations Improve Language Modeling" paper by Ding et al.](https://arxiv.org/abs/2404.10830v2), using the first-fit-decreasing algorithm to pack documents into batches without truncation. 
+We packed our data in chunks of 10000 documents for more efficient processing while maintaining >99% packing efficiency. Documents longer than the sequence length are split into chunks of sequence length.
+
+This approach results in overall higher benchmark scores when training on the same data with equal hyperparameters. The following numbers are from initial experiments with `3e-5 lr` and 12k steps and show improvements comparable to those shown in the original paper.
+
+| Task              | Naive Packing | Fewer Truncations Packing | Percentage Increase |
+|-------------------|---------------|---------------------------|---------------------|
+| truthfulqa_mc     | 0.452648      | 0.467687                  | 3.32%               |
+| arc_challenge     | 0.517918      | 0.528157                  | 1.98%               |
+| truthful_qa_de    | 0.485529      | 0.492979                  | 1.53%               |
+| arc_challenge_de  | 0.480375      | 0.493174                  | 2.66%               |
+| hellaswag         | 0.776041      | 0.773352                  | -0.35%              |
+| hellaswag_de      | 0.655248      | 0.653356                  | -0.29%              |
+| MMLU              | 0.573719      | 0.579802                  | 1.06%               |
+| MMLU-DE           | 0.504509      | 0.503863                  | -0.13%              |
+
+The following is our simple implementation of the first-fit-decreasing algorithm described in the paper.
+```python
+def pack_documents(tokenized_documents):
+    # Sort documents by their length in descending order
+    sorted_docs = sorted(tokenized_documents, key=len, reverse=True)
+    
+    # Initialize bins
+    bins = []
+    
+    # Function to find the first bin that can accommodate the document
+    def find_bin(doc):
+        for b in bins:
+            if sum(len(d) for d in b) + len(doc) <= 8192:
+                return b
+        return None
+    
+    # Place each document in the first available bin or create a new bin
+    for doc in sorted_docs:
+        target_bin = find_bin(doc)
+        if target_bin is not None:
+            target_bin.append(doc)
+        else:
+            # Create a new bin with this document if no suitable bin is found
+            bins.append([doc])
+    
+    # Return results
+    return bins
+```
+
+## Model Configurations
+
+We release DiscoLeo-8B in the following configurations:
+1. [Base model with continued pretraining](https://huggingface.co/DiscoResearch/Llama3-German-8B)
+2. [Long-context version (32k context length)](https://huggingface.co/DiscoResearch/Llama3-German-8B-32k)
+3. [Instruction-tuned version of the base model](https://huggingface.co/DiscoResearch/Llama3-DiscoLeo-Instruct-8B-v0.1)
+4. [Instruction-tuned version of the long-context model](https://huggingface.co/DiscoResearch/Llama3-DiscoLeo-Instruct-8B-32k-v0.1)
+5. [Experimental `DARE-TIES` Merge with Llama3-Instruct](https://huggingface.co/DiscoResearch/Llama3-DiscoLeo-8B-DARE-Experimental)
+6. [Collection of Quantized versions](https://huggingface.co/collections/DiscoResearch/discoleo-8b-quants-6651bcf8f72c9a37ce485d42)
+
+## How to use:
+Here's how to use the model with transformers:
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
+
+device="cuda"
+
+model = AutoModelForCausalLM.from_pretrained(
+    "DiscoResearch/Llama3-DiscoLeo-Instruct-8B-v0.1",
+    torch_dtype="auto",
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained("DiscoResearch/Llama3-DiscoLeo-Instruct-8B-v0.1")
+
+prompt = "Schreibe ein Essay über die Bedeutung der Energiewende für Deutschlands Wirtschaft"
+messages = [
+    {"role": "system", "content": "Du bist ein hilfreicher Assistent."},
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(device)
+
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    max_new_tokens=512
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+```
+
+## Acknowledgements
+
+The model was trained and evaluated by [Björn Plüster](https://huggingface.co/bjoernp) ([DiscoResearch](https://huggingface.co/DiscoResearch), [ellamind](https://ellamind.com)) with data preparation and project supervision by [Manuel Brack](http://manuel-brack.eu) ([DFKI](https://www.dfki.de/web/), [TU-Darmstadt](https://www.tu-darmstadt.de/)). Initial work on dataset collection and curation was performed by [Malte Ostendorff](https://ostendorff.org) and [Pedro Ortiz Suarez](https://portizs.eu). Instruction tuning was done with the DiscoLM German dataset created by [Jan-Philipp Harries](https://huggingface.co/jphme) and [Daniel Auras](https://huggingface.co/rasdani) ([DiscoResearch](https://huggingface.co/DiscoResearch), [ellamind](https://ellamind.com)). We extend our gratitude to [LAION](https://laion.ai/) and friends, especially  [Christoph Schuhmann](https://entwickler.de/experten/christoph-schuhmann) and [Jenia Jitsev](https://huggingface.co/JJitsev), for initiating this collaboration.
+
+The model training was supported by a compute grant at the [42 supercomputer](https://hessian.ai/)  which is a central component in the development of [hessian AI](https://hessian.ai/), the [AI Innovation Lab](https://hessian.ai/infrastructure/ai-innovationlab/) (funded by the [Hessian Ministry of Higher Education, Research and the Art (HMWK)](https://wissenschaft.hessen.de) & the [Hessian Ministry of the Interior, for Security and Homeland Security (HMinD)](https://innen.hessen.de)) and the [AI Service Centers](https://hessian.ai/infrastructure/ai-service-centre/) (funded by the [German Federal Ministry for Economic Affairs and Climate Action (BMWK)](https://www.bmwk.de/Navigation/EN/Home/home.html)).
+The curation of the training data is partially funded by the [German Federal Ministry for Economic Affairs and Climate Action (BMWK)](https://www.bmwk.de/Navigation/EN/Home/home.html)
+through the project [OpenGPT-X](https://opengpt-x.de/en/) (project no. 68GX21007D).