updated
Browse files
README.md
CHANGED
|
@@ -1,24 +1,4 @@
|
|
| 1 |
-
Hugging Face's logo
|
| 2 |
-
---
|
| 3 |
-
language:
|
| 4 |
-
- ar
|
| 5 |
-
- de
|
| 6 |
-
- en
|
| 7 |
-
- es
|
| 8 |
-
- fr
|
| 9 |
-
- it
|
| 10 |
-
- lv
|
| 11 |
-
- nl
|
| 12 |
-
- pt
|
| 13 |
-
- zh
|
| 14 |
-
- multilingual
|
| 15 |
|
| 16 |
-
---
|
| 17 |
-
# xlm-roberta-large-ner-hrl
|
| 18 |
-
## Model description
|
| 19 |
-
**xlm-roberta-large-ner-hrl** is a **Named Entity Recognition** model for 10 high resourced languages (Arabic, German, English, Spanish, French, Italian, Latvian, Dutch, Portuguese and Chinese) based on a fine-tuned XLM-RoBERTa large model. It has been trained to recognize three types of entities: location (LOC), organizations (ORG), and person (PER).
|
| 20 |
-
Specifically, this model is a *xlm-roberta-large* model that was fine-tuned on an aggregation of 10 high-resourced languages
|
| 21 |
-
## Intended uses & limitations
|
| 22 |
#### How to use
|
| 23 |
You can use this model with Transformers *pipeline* for NER.
|
| 24 |
```python
|
|
@@ -33,33 +13,12 @@ print(ner_results)
|
|
| 33 |
```
|
| 34 |
#### Limitations and bias
|
| 35 |
This model is limited by its training dataset of entity-annotated news articles from a specific span of time. This may not generalize well for all use cases in different domains.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
## Training data
|
| 37 |
-
The training data for the 10 languages are from:
|
| 38 |
|
| 39 |
Language|Dataset
|
| 40 |
-|-
|
| 41 |
Arabic | [ANERcorp](https://camel.abudhabi.nyu.edu/anercorp/)
|
| 42 |
-
German | [conll 2003](https://www.clips.uantwerpen.be/conll2003/ner/)
|
| 43 |
-
English | [conll 2003](https://www.clips.uantwerpen.be/conll2003/ner/)
|
| 44 |
-
Spanish | [conll 2002](https://www.clips.uantwerpen.be/conll2002/ner/)
|
| 45 |
-
French | [Europeana Newspapers](https://github.com/EuropeanaNewspapers/ner-corpora/tree/master/enp_FR.bnf.bio)
|
| 46 |
-
Italian | [Italian I-CAB](https://ontotext.fbk.eu/icab.html)
|
| 47 |
-
Latvian | [Latvian NER](https://github.com/LUMII-AILab/FullStack/tree/master/NamedEntities)
|
| 48 |
-
Dutch | [conll 2002](https://www.clips.uantwerpen.be/conll2002/ner/)
|
| 49 |
-
Portuguese |[Paramopama + Second Harem](https://github.com/davidsbatista/NER-datasets/tree/master/Portuguese)
|
| 50 |
-
Chinese | [MSRA](https://huggingface.co/datasets/msra_ner)
|
| 51 |
-
|
| 52 |
-
The training dataset distinguishes between the beginning and continuation of an entity so that if there are back-to-back entities of the same type, the model can output where the second entity begins. As in the dataset, each token will be classified as one of the following classes:
|
| 53 |
-
Abbreviation|Description
|
| 54 |
-
-|-
|
| 55 |
-
O|Outside of a named entity
|
| 56 |
-
B-PER |Beginning of a person’s name right after another person’s name
|
| 57 |
-
I-PER |Person’s name
|
| 58 |
-
B-ORG |Beginning of an organisation right after another organisation
|
| 59 |
-
I-ORG |Organisation
|
| 60 |
-
B-LOC |Beginning of a location right after another location
|
| 61 |
-
I-LOC |Location
|
| 62 |
-
## Training procedure
|
| 63 |
-
This model was trained on NVIDIA V100 GPU with recommended hyperparameters from HuggingFace code.
|
| 64 |
-
|
| 65 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
#### How to use
|
| 3 |
You can use this model with Transformers *pipeline* for NER.
|
| 4 |
```python
|
|
|
|
| 13 |
```
|
| 14 |
#### Limitations and bias
|
| 15 |
This model is limited by its training dataset of entity-annotated news articles from a specific span of time. This may not generalize well for all use cases in different domains.
|
| 16 |
+
|
| 17 |
+
=======
|
| 18 |
+
#### Limitations and bias
|
| 19 |
+
This model is limited by its training dataset of entity-annotated news articles from a specific span of time. This may not generalize well for all use cases in different domains.
|
| 20 |
## Training data
|
|
|
|
| 21 |
|
| 22 |
Language|Dataset
|
| 23 |
-|-
|
| 24 |
Arabic | [ANERcorp](https://camel.abudhabi.nyu.edu/anercorp/)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|