From 86b3ded812928b4eb419c4c78f7ad177f3e87e88 Mon Sep 17 00:00:00 2001
From: tiedeman <jorg.tiedemann@helsinki.fi>
Date: Thu, 14 Jul 2022 08:56:40 +0000
Subject: [PATCH] Model Card (#1)

- Model Card (0161e478c48dbb4dd22fb4a03a04816533fb56f2)


Co-authored-by: Ezi Ozoani <Ezi@users.noreply.huggingface.co>
---
 README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 78 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index ac26a3c..907f690 100644
--- a/README.md
+++ b/README.md
@@ -6,18 +6,63 @@ license: apache-2.0
 
 ### opus-mt-en-de
 
-* source languages: en
-* target languages: de
-*  OPUS readme: [en-de](https://github.com/Helsinki-NLP/OPUS-MT-train/blob/master/models/en-de/README.md)
 
-*  dataset: opus
-* model: transformer-align
+## Table of Contents
+- [Model Details](#model-details)
+- [Uses](#uses)
+- [Risks, Limitations and Biases](#risks-limitations-and-biases)
+- [Training](#training)
+- [Evaluation](#evaluation)
+- [Citation Information](#citation-information)
+- [How to Get Started With the Model](#how-to-get-started-with-the-model)
+
+## Model Details
+**Model Description:**
+- **Developed by:** Language Technology Research Group at the University of Helsinki
+- **Model Type:** Translation
+- **Language(s):**  
+  - Source Language: English
+  - Target Language: German 
+- **License:** Apache-2.0
+- **Resources for more information:**
+  - [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
+  
+
+## Uses
+
+#### Direct Use
+
+This model can be used for translation and text-to-text generation.
+
+
+## Risks, Limitations and Biases
+
+
+
+**CONTENT WARNING: Readers should be aware this section contains content that is disturbing, offensive, and can propagate historical and current stereotypes.**
+
+Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)).
+
+Further details about the dataset for this model can be found in the OPUS readme: [en-de](https://github.com/Helsinki-NLP/OPUS-MT-train/blob/master/models/en-de/README.md)
+
+
+#### Training Data
+##### Preprocessing
 * pre-processing: normalization + SentencePiece
+
+* dataset: [opus](https://github.com/Helsinki-NLP/Opus-MT)
 * download original weights: [opus-2020-02-26.zip](https://object.pouta.csc.fi/OPUS-MT-models/en-de/opus-2020-02-26.zip)
+
 * test set translations: [opus-2020-02-26.test.txt](https://object.pouta.csc.fi/OPUS-MT-models/en-de/opus-2020-02-26.test.txt)
+
+## Evaluation
+
+#### Results
+
 * test set scores: [opus-2020-02-26.eval.txt](https://object.pouta.csc.fi/OPUS-MT-models/en-de/opus-2020-02-26.eval.txt)
 
-## Benchmarks
+
+#### Benchmarks
 
 | testset               | BLEU  | chr-F |
 |-----------------------|-------|-------|
@@ -35,3 +80,30 @@ license: apache-2.0
 | newstest2019-ende.en.de 	| 40.9 	| 0.654 |
 | Tatoeba.en.de 	| 47.3 	| 0.664 |
 
+
+
+## Citation Information
+
+```bibtex
+@InProceedings{TiedemannThottingal:EAMT2020,
+  author = {J{\"o}rg Tiedemann and Santhosh Thottingal},
+  title = {{OPUS-MT} — {B}uilding open translation services for the {W}orld},
+  booktitle = {Proceedings of the 22nd Annual Conferenec of the European Association for Machine Translation (EAMT)},
+  year = {2020},
+  address = {Lisbon, Portugal}
+ }
+```
+
+## How to Get Started With the Model
+```python
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
+
+tokenizer = AutoTokenizer.from_pretrained("Helsinki-NLP/opus-mt-en-de")
+
+model = AutoModelForSeq2SeqLM.from_pretrained("Helsinki-NLP/opus-mt-en-de")
+
+```
+
+
+
+