Updated README.md

README.md

@@ -1,3 +1,40 @@
----
-license: apache-2.0
----
+---
+base_model: unsloth/Llama-3.2-3B-Instruct-bnb-4bit
+language:
+- en
+- de
+license: apache-2.0
+tags:
+- text-generation-inference
+- transformers
+- unsloth
+- llama
+- trl
+- machine-translation
+- historical-language
+- early-modern-german
+- legal-texts
+- economic-history
+- open-source
+---
+
+# English to Early Modern Bohemian German Translation Model
+
+## Overview
+
+This model translates between English and Early Modern Bohemian German (EMBG). It was fine-tuned using LoRA on a unique historical dataset of 3,873 paragraph-level translation pairs sourced from legal court records. The dataset was meticulously transcribed and translated by the Chichele Professor of Economic History, **Sheilagh Ogilvie**, from All Souls College, University of Oxford.
+
+### Key Features
+
+- **Base Model**: `unsloth/Llama-3.2-3B-Instruct-bnb-4bit`  
+- **Fine-Tuning**: Performed using [LoRA](https://arxiv.org/abs/2106.09685) and [Unsloth](https://github.com/unslothai/unsloth), leveraging Hugging Face's [Transformers](https://github.com/huggingface/transformers) and [TRL](https://github.com/huggingface/trl) libraries.
+- **Languages Supported**:  
+  - Source: English 
+  - Target: Early Modern Bohemian German (EMBG)  
+- **Dataset**: Legal court records, manually transcribed and translated over five years. The dataset will be published in an upcoming [ACL](https://acl2024.org) paper.
+
+### Use Cases
+
+- Research in economic history and legal studies.
+- Exploration of historical dialects and their nuances.
+- Applications in language revitalisation and historical text analysis.