Updating README
Browse files
README.md
CHANGED
|
@@ -10,10 +10,21 @@ widget:
|
|
| 10 |
**CAMeLBERT MSA NER Model** is a Named Entity Recognition (NER) model that was built by fine-tuning the [CAMeLBERT Modern Standard Arabic (MSA)](https://huggingface.co/CAMeL-Lab/bert-base-arabic-camelbert-msa/) model. For the fine-tuning, we used the [ANERcorp](https://camel.abudhabi.nyu.edu/anercorp/) 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).
|
| 11 |
|
| 12 |
## Intended uses
|
| 13 |
-
You can use the CAMeLBERT MSA NER model directly as part of
|
| 14 |
|
| 15 |
#### How to use
|
| 16 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
```python
|
| 18 |
>>> from transformers import pipeline
|
| 19 |
>>> ner = pipeline('ner', model='CAMeL-Lab/bert-base-arabic-camelbert-msa-ner')
|
|
@@ -43,16 +54,6 @@ You can use this model directly with a pipeline to do NER:
|
|
| 43 |
'start': 50,
|
| 44 |
'end': 57}]
|
| 45 |
```
|
| 46 |
-
|
| 47 |
-
Here is how to use this model with our CAMeLTools toolkit:
|
| 48 |
-
```python
|
| 49 |
-
>>> from camel_tools.ner import NERecognizer
|
| 50 |
-
>>> ner = NERecognizer('CAMeL-Lab/bert-base-arabic-camelbert-msa-ner')
|
| 51 |
-
>>> sentence = 'إمارة أبوظبي هي إحدى إمارات دولة الإمارات العربية المتحدة السبع'.split()
|
| 52 |
-
>>> ner.predict_sentence(sentence)
|
| 53 |
-
>>> ['O', 'B-LOC', 'O', 'O', 'O', 'O', 'B-LOC', 'I-LOC', 'I-LOC', 'O']
|
| 54 |
-
```
|
| 55 |
-
|
| 56 |
*Note*: to download our models, you would need `transformers>=3.5.0`. Otherwise, you could download the models
|
| 57 |
|
| 58 |
|
|
|
|
| 10 |
**CAMeLBERT MSA NER Model** is a Named Entity Recognition (NER) model that was built by fine-tuning the [CAMeLBERT Modern Standard Arabic (MSA)](https://huggingface.co/CAMeL-Lab/bert-base-arabic-camelbert-msa/) model. For the fine-tuning, we used the [ANERcorp](https://camel.abudhabi.nyu.edu/anercorp/) 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).
|
| 11 |
|
| 12 |
## Intended uses
|
| 13 |
+
You can use the CAMeLBERT MSA NER model directly as part of our [CAMeL Tools](https://github.com/CAMeL-Lab/camel_tools) NER component (*recommended*) or as part of the transformers pipeline.
|
| 14 |
|
| 15 |
#### How to use
|
| 16 |
+
To use the model with the [CAMeL Tools](https://github.com/CAMeL-Lab/camel_tools) NER component:
|
| 17 |
+
```python
|
| 18 |
+
>>> from camel_tools.ner import NERecognizer
|
| 19 |
+
>>> from camel_tools.tokenizers.word import simple_word_tokenize
|
| 20 |
+
>>> ner = NERecognizer('CAMeL-Lab/bert-base-arabic-camelbert-msa-ner')
|
| 21 |
+
>>> sentence = simple_word_tokenize('إمارة أبوظبي هي إحدى إمارات دولة الإمارات العربية المتحدة السبع')
|
| 22 |
+
>>> ner.predict_sentence(sentence)
|
| 23 |
+
>>> ['O', 'B-LOC', 'O', 'O', 'O', 'O', 'B-LOC', 'I-LOC', 'I-LOC', 'O']
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
|
| 27 |
+
You can also use the NER model directly with a transformers pipeline:
|
| 28 |
```python
|
| 29 |
>>> from transformers import pipeline
|
| 30 |
>>> ner = pipeline('ner', model='CAMeL-Lab/bert-base-arabic-camelbert-msa-ner')
|
|
|
|
| 54 |
'start': 50,
|
| 55 |
'end': 57}]
|
| 56 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
*Note*: to download our models, you would need `transformers>=3.5.0`. Otherwise, you could download the models
|
| 58 |
|
| 59 |
|