Create README.md

README.md

@@ -0,0 +1,52 @@
+# Iranian Azerbaijani NLP Models
+
+## Github Repository: [iranian-azerbaijani-nlp](https://github.com/language-ml/iranian-azerbaijani-nlp)
+
+## Overview
+
+This model card provides information about the NLP models developed as part of the paper accepted for publication at AACL 2023. The models are designed to support Natural Language Processing (NLP) tasks for the Iranian Azerbaijani language (ISO code: azb). The models included in this repository are:
+
+1. **AzerBERT**
+   - Type: BERT-based language model transformer
+   - Description: AzerBERT is a pre-trained language model specifically tailored for the Iranian Azerbaijani language. It can be used for various NLP tasks, including text classification, named entity recognition, and more.
+   - Model Link: [AzerBERT Model](https://huggingface.co/language-ml-lab/AzerBert)
+
+2. **Language Model-based Embedding (FastText)**
+   - Type: FastText-based word embedding model
+   - Description: This model provides embeddings for Iranian Azerbaijani text using the FastText framework. It allows you to generate word embeddings for Iranian Azerbaijani words and phrases.
+   - Model Link: [FastText Embedding Model](https://huggingface.co/language-ml-lab/fasttext-azb)
+
+3. **Text Classification Model (Fine-tuned with AzerBERT)**
+   - Type: Fine-tuned BERT-based text classification model
+   - Description: This model has been fine-tuned using AzerBERT for text classification tasks. It is designed to categorize text into one of the following four categories: literature, sports, history, and geography.
+   - Model Link: [Text Classification Model](https://huggingface.co/language-ml-lab/classification-azb)
+
+4. **POS Tagger (Fine-tuned with AzerBERT)**
+   - Type: Fine-tuned BERT-based Part-of-Speech (POS) tagging model
+   - Description: This model has been fine-tuned using AzerBERT for part-of-speech tagging tasks in Iranian Azerbaijani text. It can be used to annotate text with 11 POS tags, which is essential for various downstream NLP applications.
+   - Model Link: [POS Tagger Model](https://huggingface.co/language-ml-lab/postagger-azb)
+
+5. **Translation Models (Persian to Azerbaijani and Vice Versa)**
+   - Type: Machine translation models
+   - Description: These models support translation between Persian (fa) and Iranian Azerbaijani (azb) languages. They enable bidirectional translation between the two languages, making them valuable for cross-language communication.
+   - Model Link: [Translation Models](https://huggingface.co/language-ml-lab/translation-azb-fa)
+
+## Model Training Data
+
+The details about the training data used to pre-train and fine-tune these models can be found in the associated research paper. Please refer to the paper for comprehensive information about the data sources and preprocessing steps.
+
+## Evaluation Metrics
+
+The evaluation metrics for each specific model, including accuracy, F1-score, BLEU score, or other relevant metrics, are provided in the associated research paper.
+
+## Acknowledgments
+
+Please acknowledge the authors and cite the associated research paper when using these models in your work. Proper attribution helps recognize the effort and contributions of the researchers involved in model development.
+
+## Citation
+
+If you use these models in your research or applications, please cite the following paper:
+
+[Include the citation for your AACL 2023 paper here]
+
+---