transformers pytorch safetensors bert token-classification it arxiv:1810.04805 license:apache-2.0 autotrain_compatible endpoints_compatible region:us
---
language:
- it
license: apache-2.0
widget:
- text: mi chiamo marco rossi, vivo a roma e lavoro per l'agenzia spaziale italiana
  example_title: Example 1
---

--------------------------------------------------------------------------------------------------

<body>
<span class="vertical-text" style="background-color:lightgreen;border-radius: 3px;padding: 3px;"> </span>
<br>
<span class="vertical-text" style="background-color:orange;border-radius: 3px;padding: 3px;">    Task: Named Entity Recognition</span>
<br>
<span class="vertical-text" style="background-color:lightblue;border-radius: 3px;padding: 3px;">    Model: BERT</span>
<br>
<span class="vertical-text" style="background-color:tomato;border-radius: 3px;padding: 3px;">    Lang: IT</span>
<br>
<span class="vertical-text" style="background-color:lightgrey;border-radius: 3px;padding: 3px;">  Type: Uncased</span>
<br>
<span class="vertical-text" style="background-color:#CF9FFF;border-radius: 3px;padding: 3px;"> </span>
</body>

--------------------------------------------------------------------------------------------------

<h3>Model description</h3>

This is a <b>BERT</b> <b>[1]</b> uncased model for the <b>Italian</b> language, fine-tuned for <b>Named Entity Recognition</b> (<b>Person</b>, <b>Location</b>, <b>Organization</b> and <b>Miscellanea</b> classes) on the [WikiNER](https://figshare.com/articles/dataset/Learning_multilingual_named_entity_recognition_from_Wikipedia/5462500) dataset <b>[2]</b>, using the uncased <b>BERT-ITALIAN</b> ([bert-base-italian-uncased](https://huggingface.co/osiria/bert-base-italian-uncased)) as a pre-trained model.

This is an uncased, base size BERT model. If you are looking for a cased model, you can refer to: https://huggingface.co/osiria/bert-italian-cased-ner

<h3>Training and Performances</h3>

The model is trained to perform entity recognition over 4 classes: <b>PER</b> (persons), <b>LOC</b> (locations), <b>ORG</b> (organizations), <b>MISC</b> (miscellanea, mainly events, products and services). It has been fine-tuned for Named Entity Recognition, using the WikiNER Italian dataset plus an additional custom dataset of manually annotated Wikipedia paragraphs.
The WikiNER dataset has been splitted in 102.352 training instances and 25.588 test instances, and the model has been trained for 1 epoch with a constant learning rate of 1e-5.

The performances on the test set are reported in the following table:

| Recall | Precision | F1 |
| ------ | ------ |  ------ |
| 90.10 | 90.56 | 90.32 |

The metrics have been computed at the token level and then macro-averaged over the 4 classes.

Then, since WikiNER is an automatically annotated (silver standard) dataset, which sometimes contains imperfect annotations, an additional fine-tuning on ~3.500 manually annotated paragraphs has been performed.

<h3>Quick usage</h3>

```python
from transformers import BertTokenizerFast, BertForTokenClassification

tokenizer = BertTokenizerFast.from_pretrained("osiria/bert-italian-uncased-ner")
model = BertForTokenClassification.from_pretrained("osiria/bert-italian-uncased-ner")

from transformers import pipeline
ner = pipeline("ner", model = model, tokenizer = tokenizer, aggregation_strategy="first")

ner("mi chiamo marco rossi, vivo a roma e lavoro per l'agenzia spaziale italiana nella missione prisma")

[{'entity_group': 'PER',
  'score': 0.9984422,
  'word': 'marco rossi',
  'start': 10,
  'end': 21},
 {'entity_group': 'LOC',
  'score': 0.9976732,
  'word': 'roma',
  'start': 30,
  'end': 34},
 {'entity_group': 'ORG',
  'score': 0.99747753,
  'word': 'agenzia spaziale italiana',
  'start': 50,
  'end': 75},
 {'entity_group': 'MISC',
  'score': 0.96949625,
  'word': 'prisma',
  'start': 91,
  'end': 97}]
```

You can also try the model online using this web app: https://huggingface.co/spaces/osiria/bert-italian-uncased-ner

<h3>References</h3>

[1] https://arxiv.org/abs/1810.04805

[2] https://www.sciencedirect.com/science/article/pii/S0004370212000276

<h3>Limitations</h3>

This model is mainly trained on Wikipedia, so it's particularly suitable for natively digital text from the world wide web, written in a correct and fluent form (like wikis, web pages, news, etc.). However, it may show limitations when it comes to chaotic text, containing errors and slang expressions
(like social media posts) or when it comes to domain-specific text (like medical, financial or legal content).

<h3>License</h3>

The model is released under <b>Apache-2.0</b> license

