Update README.md

README.md

@@ -1,3 +1,32 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+datasets:
+- guymorlan/levanti
+language:
+- ar
+- en
+pipeline_tag: translation
+widget:
+- text: بدي أروح ع الدكان بكرا
+---
+
+# Levanti (colloquial Levantine Arabic -> English) translator
+
+Trained on the [Levanti](https://huggingface.co/datasets/guymorlan/levanti) dataset by fine-tuning [Helsinki-NLP/opus-mt-ar-en](https://huggingface.co/Helsinki-NLP/opus-mt-ar-en) for 8 epochs.
+The model supports Palestinian, Jordanian, Syrian, Lebanese and Egyptian dialects.
+
+
+# Example usage
+
+```python
+from transformers import pipeline
+trans = pipeline("translation", "guymorlan/levanti_translate_ar_en")
+trans("بدي أروح ع الدكان بكرا")
+```
+```
+Out[1]: [{'translation_text': 'I want to go to the store tomorrow'}]
+```
+
+# Attribution
+Created by Guy Mor-Lan.<br>
+Contact: guy.mor AT mail.huji.ac.il