Update README.md
Browse files
README.md
CHANGED
@@ -9,9 +9,12 @@ widget:
|
|
9 |
## Model description
|
10 |
**CAMeLBERT-Mix NER Model** is a Named Entity Recognition (NER) model that was built by fine-tuning the [CAMeLBERT Mix](https://huggingface.co/CAMeL-Lab/bert-base-arabic-camelbert-mix/) model.
|
11 |
For the fine-tuning, we used the [ANERcorp](https://camel.abudhabi.nyu.edu/anercorp/) dataset.
|
12 |
-
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).
|
|
|
|
|
13 |
## Intended uses
|
14 |
You can use the CAMeLBERT-Mix 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.
|
|
|
15 |
#### How to use
|
16 |
To use the model with the [CAMeL Tools](https://github.com/CAMeL-Lab/camel_tools) NER component:
|
17 |
```python
|
@@ -52,7 +55,9 @@ You can also use the NER model directly with a transformers pipeline:
|
|
52 |
'start': 50,
|
53 |
'end': 57}]
|
54 |
```
|
55 |
-
*Note*: to download our models, you would need `transformers>=3.5.0`.
|
|
|
|
|
56 |
## Citation
|
57 |
```bibtex
|
58 |
@inproceedings{inoue-etal-2021-interplay,
|
|
|
9 |
## Model description
|
10 |
**CAMeLBERT-Mix NER Model** is a Named Entity Recognition (NER) model that was built by fine-tuning the [CAMeLBERT Mix](https://huggingface.co/CAMeL-Lab/bert-base-arabic-camelbert-mix/) model.
|
11 |
For the fine-tuning, we used the [ANERcorp](https://camel.abudhabi.nyu.edu/anercorp/) dataset.
|
12 |
+
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).
|
13 |
+
"* Our fine-tuning code can be found [here](https://github.com/CAMeL-Lab/CAMeLBERT).
|
14 |
+
|
15 |
## Intended uses
|
16 |
You can use the CAMeLBERT-Mix 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.
|
17 |
+
|
18 |
#### How to use
|
19 |
To use the model with the [CAMeL Tools](https://github.com/CAMeL-Lab/camel_tools) NER component:
|
20 |
```python
|
|
|
55 |
'start': 50,
|
56 |
'end': 57}]
|
57 |
```
|
58 |
+
*Note*: to download our models, you would need `transformers>=3.5.0`.
|
59 |
+
Otherwise, you could download the models manually.
|
60 |
+
|
61 |
## Citation
|
62 |
```bibtex
|
63 |
@inproceedings{inoue-etal-2021-interplay,
|