Update README.md

README.md

@@ -1,3 +1,35 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+datasets:
+- guymorlan/levanti
+language:
+- ar
+- he
+pipeline_tag: translation
+widget:
+- text: P אני רוצה ללכת מחר לחנות
+---
+
+# Levanti Hebrew -> colloquial Levantine Arabic translator
+
+Trained on the [Levanti](https://huggingface.co/datasets/guymorlan/levanti) dataset by fine-tuning [Helsinki-NLP/opus-mt-he-ar](https://huggingface.co/Helsinki-NLP/opus-mt-ar-he) for 8 epochs.
+This model is trained to support dialect conditional generation by utilizing the first token (followed by a space) as an indicator of the desired dialect:
+* **P** for Palestinian
+* **L** for Lebanese
+* **S** for Syrian
+* **E** for Egyptian
+
+# Example usage
+
+```python
+from transformers import pipeline
+trans = pipeline("translation", "guymorlan/levanti_translate_he_ar")
+trans("P אני רוצה ללכת מחר לחנות")
+```
+```
+Out[1]: [{'translation_text': 'بدي أروح ع الدكان بكرا'}]
+```
+
+# Attribution
+Created by Guy Mor-Lan.<br>
+Contact: guy.mor AT mail.huji.ac.il