Add model

README.md

@@ -0,0 +1,44 @@
+---
+language: 
+- ar
+license: apache-2.0
+widget:
+ - text: 'إمارة أبوظبي هي إحدى إمارات دولة الإمارات العربية المتحدة السبع'
+---
+# CAMeLBERT-MSA POS-MSA Model
+## Model description
+**CAMeLBERT-MSA POS-MSA Model** is a Modern Standard Arabic (MSA) POS tagging model that was built by fine-tuning the [CAMeLBERT-MSA](https://huggingface.co/CAMeL-Lab/bert-base-arabic-camelbert-msa/) model.
+For the fine-tuning, we used the [PATB](https://dl.acm.org/doi/pdf/10.5555/1621804.1621808) dataset .
+Our fine-tuning procedure and the hyperparameters we used can be found in our paper *"[The Interplay of Variant, Size, and Task Type in Arabic Pre-trained Language Models](https://arxiv.org/abs/2103.06678)."* Our fine-tuning code can be found [here](https://github.com/CAMeL-Lab/CAMeLBERT).
+
+## Intended uses
+You can use the CAMeLBERT-MSA POS-MSA model as part of the transformers pipeline.
+This model will also be available in [CAMeL Tools](https://github.com/CAMeL-Lab/camel_tools) soon.
+
+#### How to use
+To use the model with a transformers pipeline:
+```python
+>>> from transformers import pipeline
+>>> pos = pipeline('text-classification', model='CAMeL-Lab/bert-base-arabic-camelbert-msa-pos-msa')
+>>> text = 'إمارة أبوظبي هي إحدى إمارات دولة الإمارات العربية المتحدة السبع'
+>>> pos(text)
+[{'entity': 'noun', 'score': 0.9999764, 'index': 1, 'word': 'إمارة', 'start': 0, 'end': 5}, {'entity': 'noun_prop', 'score': 0.99991846, 'index': 2, 'word': 'أبوظبي', 'start': 6, 'end': 12}, {'entity': 'pron', 'score': 0.9998356, 'index': 3, 'word': 'هي', 'start': 13, 'end': 15}, {'entity': 'noun', 'score': 0.99368894, 'index': 4, 'word': 'إحدى', 'start': 16, 'end': 20}, {'entity': 'noun', 'score': 0.9999426, 'index': 5, 'word': 'إما', 'start': 21, 'end': 24}, {'entity': 'noun', 'score': 0.9999339, 'index': 6, 'word': '##رات', 'start': 24, 'end': 27}, {'entity': 'noun', 'score': 0.99996775, 'index': 7, 'word': 'دولة', 'start': 28, 'end': 32}, {'entity': 'noun', 'score': 0.99996895, 'index': 8, 'word': 'الإمارات', 'start': 33, 'end': 41}, {'entity': 'adj', 'score': 0.99990183, 'index': 9, 'word': 'العربية', 'start': 42, 'end': 49}, {'entity': 'adj', 'score': 0.9999347, 'index': 10, 'word': 'المتحدة', 'start': 50, 'end': 57}, {'entity': 'noun_num', 'score': 0.99931145, 'index': 11, 'word': 'السبع', 'start': 58, 'end': 63}]
+```
+*Note*: to download our models, you would need `transformers>=3.5.0`. Otherwise, you could download the models 
+## Citation
+```bibtex
+@inproceedings{inoue-etal-2021-interplay,
+    title = "The Interplay of Variant, Size, and Task Type in {A}rabic Pre-trained Language Models",
+    author = "Inoue, Go  and
+      Alhafni, Bashar  and
+      Baimukan, Nurpeiis  and
+      Bouamor, Houda  and
+      Habash, Nizar",
+    booktitle = "Proceedings of the Sixth Arabic Natural Language Processing Workshop",
+    month = apr,
+    year = "2021",
+    address = "Kyiv, Ukraine (Online)",
+    publisher = "Association for Computational Linguistics",
+    abstract = "In this paper, we explore the effects of language variants, data sizes, and fine-tuning task types in Arabic pre-trained language models. To do so, we build three pre-trained language models across three variants of Arabic: Modern Standard Arabic (MSA), dialectal Arabic, and classical Arabic, in addition to a fourth language model which is pre-trained on a mix of the three. We also examine the importance of pre-training data size by building additional models that are pre-trained on a scaled-down set of the MSA variant. We compare our different models to each other, as well as to eight publicly available models by fine-tuning them on five NLP tasks spanning 12 datasets. Our results suggest that the variant proximity of pre-training data to fine-tuning data is more important than the pre-training data size. We exploit this insight in defining an optimized system selection model for the studied tasks.",
+}
+```

config.json

@@ -0,0 +1,93 @@
+{
+  "_name_or_path": "/Users/gi372/Research/bert-base-arabic-camelbert-msa-pos-msa",
+  "architectures": [
+    "BertModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "classifier_dropout": null,
+  "gradient_checkpointing": false,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "id2label": {
+    "0": "abbrev",
+    "1": "adj",
+    "2": "adj_comp",
+    "3": "adj_num",
+    "4": "adv",
+    "5": "adv_interrog",
+    "6": "adv_rel",
+    "7": "conj",
+    "8": "conj_sub",
+    "9": "digit",
+    "10": "interj",
+    "11": "noun",
+    "12": "noun_num",
+    "13": "noun_prop",
+    "14": "noun_quant",
+    "15": "part",
+    "16": "part_det",
+    "17": "part_focus",
+    "18": "part_fut",
+    "19": "part_interrog",
+    "20": "part_neg",
+    "21": "part_restrict",
+    "22": "part_verb",
+    "23": "part_voc",
+    "24": "prep",
+    "25": "pron",
+    "26": "pron_dem",
+    "27": "pron_interrog",
+    "28": "pron_rel",
+    "29": "punc",
+    "30": "verb",
+    "31": "verb_pseudo"
+  },
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "label2id": {
+    "abbrev": 0,
+    "adj": 1,
+    "adj_comp": 2,
+    "adj_num": 3,
+    "adv": 4,
+    "adv_interrog": 5,
+    "adv_rel": 6,
+    "conj": 7,
+    "conj_sub": 8,
+    "digit": 9,
+    "interj": 10,
+    "noun": 11,
+    "noun_num": 12,
+    "noun_prop": 13,
+    "noun_quant": 14,
+    "part": 15,
+    "part_det": 16,
+    "part_focus": 17,
+    "part_fut": 18,
+    "part_interrog": 19,
+    "part_neg": 20,
+    "part_restrict": 21,
+    "part_verb": 22,
+    "part_voc": 23,
+    "prep": 24,
+    "pron": 25,
+    "pron_dem": 26,
+    "pron_interrog": 27,
+    "pron_rel": 28,
+    "punc": 29,
+    "verb": 30,
+    "verb_pseudo": 31
+  },
+  "layer_norm_eps": 1e-12,
+  "max_position_embeddings": 512,
+  "model_type": "bert",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 0,
+  "position_embedding_type": "absolute",
+  "transformers_version": "4.11.3",
+  "type_vocab_size": 2,
+  "use_cache": true,
+  "vocab_size": 30000
+}

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:996b457c94c7e73fe995308fe6bba3219e74698264b16367892e4601b9dd2cf7
+size 436478373

special_tokens_map.json

@@ -0,0 +1 @@
+{"unk_token": "[UNK]", "sep_token": "[SEP]", "pad_token": "[PAD]", "cls_token": "[CLS]", "mask_token": "[MASK]"}

tf_model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:449a8fadf02a53574888a8d307683197ec10d60d1b06f55deacb376f1cf95148
+size 436592640

tokenizer_config.json

@@ -0,0 +1 @@
+{"do_lower_case": false, "special_tokens_map_file": null, "full_tokenizer_file": null}

training_args.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:edd886f9e2d32fcf63682260e228c087832e1eecafded4916c8915a701d5f257
+size 1355