Create README.md

README.md

@@ -0,0 +1,46 @@
+---
+license: apache-2.0
+datasets:
+- Helsinki-NLP/tatoeba
+- openlanguagedata/flores_plus
+- facebook/bouquet
+language:
+- en
+- de
+metrics:
+- bleu
+- comet
+- chrf
+pipeline_tag: translation
+---
+
+# OPUS-MT-tiny-deu-eng
+
+Distilled model from a Tatoeba-MT Teacher: [OPUS-MT-models/de-en/opus-2020-02-26](https://object.pouta.csc.fi/OPUS-MT-models/de-en/opus-2020-02-26.zip), which has been trained on the [Tatoeba](https://github.com/Helsinki-NLP/Tatoeba-Challenge/tree/master/data) dataset.
+
+We used the [OpusDistillery](https://github.com/Helsinki-NLP/OpusDistillery) to train new a new student with the tiny architecture, with a regular transformer decoder.
+For training data, we used [Tatoeba](https://github.com/Helsinki-NLP/Tatoeba-Challenge/tree/master/data).
+The configuration file fed into OpusDistillery can be found [here](https://github.com/Helsinki-NLP/OpusDistillery/blob/main/configs/opustranslate_hf/config.op.de-en.yml).
+
+## How to run
+```python
+>>> from transformers import pipeline
+>>> pipe = pipeline("translation", model="Helsinki-NLP/opus-mt_tiny_deu-eng", max_length=256)
+>>> pipe("Hallo, wie geht's dir?")
+```
+
+## Benchmarks
+### Teacher
+| testset               | BLEU  | chr-F | COMET| 
+|-----------------------|-------|-------|-------|
+| Flores+ 	| 40.6 | 66.7 | 0.8559 |
+| Bouquet 	| 42.5 	| 63.5 | 0.8674|
+
+### Student
+
+| testset               | BLEU  | chr-F | COMET |
+|-----------------------|-------|-------|-------|
+| Flores+ 	| - 	| - | - |
+| Bouquet 	| - 	| - |- |
+
+