German-RAG-LLAMA-3.1-8B-MERGED-HESSIAN-AI

German-RAG (German Retrieval Augmented Generation) models are designed for the German-speaking market, enabling innovation and AI solutions to drive German research collaboration in business-focused Generative AI by 2025

Model Details

The core models released in this batch are the following:

Model Description

• Developed by: Avemio AI Team
• Supported by: Hessian AI
• Model type: a Transformer style autoregressive language model.
• Language(s) (NLP): German, English
• License: The code and model are released under Apache 2.0.
• Contact: German-RAG@avemio.digital

Model Sources

• Training Study: Training Study
• Repositories:
  • Training: Colab-Notebook
  • Evaluation code:
    • German-RAG-LLM-HARD-BENCHMARK
    • German-RAG-LLM-EASY-BENCHMARK
• Technical blog post:

Uses

Inference

Quickly get inference running with the following required installation: Now, proceed as usual with HuggingFace:

from transformers import AutoModelForCausalLM, AutoTokenizer
 
model_name = "avemio/German-RAG-LLAMA-3.1-8B-MERGED-HESSIAN-AI"
 
model = AutoModelForCausalLM.from_pretrained(
    model_name,
    torch_dtype="auto",
    device_map="auto"
)
tokenizer = AutoTokenizer.from_pretrained(model_name)
im_end_token_id = tokenizer.convert_tokens_to_ids('<|im_end|>')
im_start_token_id = tokenizer.convert_tokens_to_ids('<|im_start|>')
 
messages = [
    {"role": "system", "content": "Folge den Anweisungen des Benutzers. Bevor du deine finale Antwort gibst, schildere deine Überlegungen zur Lösung des Problems."},
    {"role": "user", "content": "Ferdinand steht vor der Herausforderung, eine faire Besuchsregelung für seine drei Kinder zu finden, die den Bedürfnissen jedes einzelnen Kindes gerecht wird. Jedes Kind hat unterschiedliche Vorlieben und Bedürfnisse, die in den Besuchsplan integriert werden müssen. Er muss sicherstellen, dass die Regelung sowohl den Interessen der Kinder als auch den rechtlichen Vorgaben entspricht. Ferdinand hat eine Woche Zeit, um einen Vorschlag zu erarbeiten, den er mit seinem Anwalt besprechen kann."}
]
text = tokenizer.apply_chat_template(
    messages,
    tokenize=False,
    add_generation_prompt=False
)
model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
 
generated_ids = model.generate(
    **model_inputs,
    max_length=2024,
    temperature=0.01,
    do_sample=False,
    #bos_token_id=im_start_token_id,
    eos_token_id=im_end_token_id,
    pad_token_id=tokenizer.eos_token_id,
    repetition_penalty=1.1,
    num_return_sequences=1,
    top_k=40,
    top_p=0.95,
)
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]
 

Fine-tuning

We are providing a comprehensive Google Colab notebook to guide users through the process of fine-tuning our model, complete with detailed instructions, essential dependencies, and configurable settings. Colab-Notebook.

Evaluation

The evaluation was performed using seven subsets, focusing on extraction recall, question answering (QA) with multiple references, and time difference reasoning. Relevant context and summarization were treated as distinct subsets, each playing a crucial role in the evaluation process. For relevant context, the model's ability to identify and extract pertinent information from the source material was assessed. In contrast, the summarization subset evaluated the model's capability to generate concise and accurate summaries based on the relevant context.

Four evaluation metrics were employed across all subsets: language quality, overall correctness, instruction following, and an overall score.

• Language quality: This metric focused on the overall linguistic quality of the outputs, considering factors such as grammar, fluency, and clarity.
• Overall correctness: The accuracy and correctness of the content were evaluated under this metric.
• Instruction following: This metric assessed the model's ability to follow specific instructions provided for each task.
• Overall score: This metric combined the results from the previous three metrics, offering a comprehensive evaluation of the model's capabilities across all subsets.

Hard Benchmark Eval

Merge Details

This model was merged using the SLERP merge method.

Models Merged

The following models were included in the merge:

• avemio/German-RAG-LLAMA-3.1-8B-ORPO-HESSIAN-AI
• avemio/German-RAG-LLAMA-3.1-8B-SFT-HESSIAN-AI

Configuration

The following YAML configuration was used to produce this model:

slices:
  - sources:
      - model: avemio/German-RAG-LLAMA-3.1-8B-SFT-HESSIAN-AI
        layer_range: [0, 32]
      - model: avemio/German-RAG-LLAMA-3.1-8B-ORPO-HESSIAN-AI
        layer_range: [0, 32]
merge_method: slerp
base_model: avemio/German-RAG-LLAMA-3.1-8B-ORPO-HESSIAN-AI
parameters:
  t:
    - filter: self_attn
      value: [0, 0.5, 0.3, 0.7, 1]
    - filter: mlp
      value: [1, 0.5, 0.7, 0.3, 0]
    - value: 0.5
dtype: bfloat16

Architecture

Hyperparameters

Bias, Risks, and Limitations

Like any base language model or fine-tuned model without safety filtering, it is relatively easy for a user to prompt these models to generate harmful and generally sensitive content. Such content can also be produced unintentionally, especially in the case of bias, so we recommend users consider the risks of applications of this technology.

Otherwise, many facts from German-RAG-LLAMA-MERGED or any LLM will often not be true, so they should be checked.

The German-RAG AI Team

Marcel Rosiak Soumya Paul Siavash Mollaebrahim Zain ul Haq