Update README.md

README.md

@@ -1,3 +1,43 @@
----
-license: mit
----
+---
+license: mit
+language:
+- ar
+---
+
+
+# AraT5+DA Phrase CODAfication Model
+
+## Model description
+**AraT5+DA Phrase** is a text normalization model that normalizes dialectal Arabic text into the Conventional Orthography for Dialectal Arabic (CODA).
+The model was built by fine-tuning [AraT5-v2](https://huggingface.co/UBC-NLP/AraT5v2-base-1024) on the [MADAR CODA](https://camel.abudhabi.nyu.edu/madar-coda-corpus/) dataset.
+This model was trained with the DA Phrase dialect identification control token as we describe in our [paper](https://arxiv.org/abs/2407.03020).
+Our fine-tuning procedure and the hyperparameters we used can be found in our paper *"[Exploiting Dialect Identification
+in Automatic Dialectal Text Normalization](https://arxiv.org/abs/2407.03020)."* Our fine-tuning code and data can be found [here](https://github.com/CAMeL-Lab/codafication).
+
+
+## Intended uses
+You can use the **AraT5+DA Phrase** CODAfication model as part of Hugging Face's transformers >= 4.22.2.
+The model is intended to be used with the dialect identification system that is part of [CAMeL Tools](https://github.com/CAMeL-Lab/camel_tools).
+
+
+## How to use
+
+
+## Citation
+```bibtex
+@inproceedings{alhafni-etal-2024-exploiting,
+    title = "Exploiting Dialect Identification in Automatic Dialectal Text Normalization",
+    author = "Alhafni, Bashar  and
+      Al-Towaity, Sarah  and
+      Fawzy, Ziyad  and
+      Nassar, Fatema and
+      Eryani, Fadhl and
+      Bouamor, Houda and
+      Habash, Nizar",
+    booktitle = "Proceedings of ArabicNLP 2024"
+    month = "aug",
+    year = "2024",
+    address = "Bangkok, Thailand",
+    abstract = "Dialectal Arabic is the primary spoken language used by native Arabic speakers in daily communication. The rise of social media platforms has notably expanded its use as a written language. However, Arabic dialects do not have standard orthographies. This, combined with the inherent noise in user-generated content on social media, presents a major challenge to NLP applications dealing with Dialectal Arabic. In this paper, we explore and report on the task of CODAfication, which aims to normalize Dialectal Arabic into the Conventional Orthography for Dialectal Arabic (CODA). We work with a unique parallel corpus of multiple Arabic dialects focusing on five major city dialects. We benchmark newly developed pretrained sequence-to-sequence models on the task of CODAfication. We further show that using dialect identification information improves the performance across all dialects. We make our code, data, and pretrained models publicly available.",
+}
+```