metadata
datasets:
- tner/tweetner7
metrics:
- f1
- precision
- recall
model-index:
- name: tner/bertweet-large-tweetner7-random
results:
- task:
name: Token Classification
type: token-classification
dataset:
name: tner/tweetner7/test_2021
type: tner/tweetner7/test_2021
args: tner/tweetner7/test_2021
metrics:
- name: F1
type: f1
value: 0.6486182247987844
- name: Precision
type: precision
value: 0.6318675293343569
- name: Recall
type: recall
value: 0.6662812210915818
- name: F1 (macro)
type: f1_macro
value: 0.604868641257225
- name: Precision (macro)
type: precision_macro
value: 0.589818811310092
- name: Recall (macro)
type: recall_macro
value: 0.6244372176840122
- name: F1 (entity span)
type: f1_entity_span
value: 0.7843071034560397
- name: Precision (entity span)
type: precision_entity_span
value: 0.7640092115363527
- name: Recall (entity span)
type: recall_entity_span
value: 0.8057129640337689
- task:
name: Token Classification
type: token-classification
dataset:
name: tner/tweetner7/test_2020
type: tner/tweetner7/test_2020
args: tner/tweetner7/test_2020
metrics:
- name: F1
type: f1
value: 0.6602409638554216
- name: Precision
type: precision
value: 0.6819690265486725
- name: Recall
type: recall
value: 0.6398546964193046
- name: F1 (macro)
type: f1_macro
value: 0.6271520713994495
- name: Precision (macro)
type: precision_macro
value: 0.652241965435762
- name: Recall (macro)
type: recall_macro
value: 0.6095524645700295
- name: F1 (entity span)
type: f1_entity_span
value: 0.7720332172515403
- name: Precision (entity span)
type: precision_entity_span
value: 0.7978959025470653
- name: Recall (entity span)
type: recall_entity_span
value: 0.7477944992215879
pipeline_tag: token-classification
widget:
- text: >-
Get the all-analog Classic Vinyl Edition of `Takin' Off` Album from
{{@Herbie Hancock@}} via {{USERNAME}} link below: {{URL}}
example_title: NER Example 1
tner/bertweet-large-tweetner7-random
This model is a fine-tuned version of vinai/bertweet-large on the
tner/tweetner7 dataset (train_random split).
Model fine-tuning is done via T-NER's hyper-parameter search (see the repository
for more detail). It achieves the following results on the test set of 2021:
- F1 (micro): 0.6486182247987844
- Precision (micro): 0.6318675293343569
- Recall (micro): 0.6662812210915818
- F1 (macro): 0.604868641257225
- Precision (macro): 0.589818811310092
- Recall (macro): 0.6244372176840122
The per-entity breakdown of the F1 score on the test set are below:
- corporation: 0.5359342915811088
- creative_work: 0.454661558109834
- event: 0.46186621218576907
- group: 0.6163606010016696
- location: 0.6615873015873016
- person: 0.8278614184654453
- product: 0.675809105869446
For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro):
- 90%: [0.6400171924527076, 0.6574431063551344]
- 95%: [0.6382155801831687, 0.6592086893227054]
- F1 (macro):
- 90%: [0.6400171924527076, 0.6574431063551344]
- 95%: [0.6382155801831687, 0.6592086893227054]
Full evaluation can be found at metric file of NER and metric file of entity span.
Usage
This model can be used through the tner library. Install the library via pip
pip install tner
and activate model as below.
from tner import TransformersNER
model = TransformersNER("tner/bertweet-large-tweetner7-random")
model.predict(["Jacob Collier is a Grammy awarded English artist from London"])
It can be used via transformers library but it is not recommended as CRF layer is not supported at the moment.
Training hyperparameters
The following hyperparameters were used during training:
- dataset: ['tner/tweetner7']
- dataset_split: train_random
- dataset_name: None
- local_dataset: None
- model: vinai/bertweet-large
- crf: True
- max_length: 128
- epoch: 30
- batch_size: 32
- lr: 1e-05
- random_seed: 0
- gradient_accumulation_steps: 1
- weight_decay: 1e-07
- lr_warmup_step_ratio: 0.3
- max_grad_norm: 1
The full configuration can be found at fine-tuning parameter file.
Reference
If you use any resource from T-NER, please consider to cite our paper.
@inproceedings{ushio-camacho-collados-2021-ner,
title = "{T}-{NER}: An All-Round Python Library for Transformer-based Named Entity Recognition",
author = "Ushio, Asahi and
Camacho-Collados, Jose",
booktitle = "Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics: System Demonstrations",
month = apr,
year = "2021",
address = "Online",
publisher = "Association for Computational Linguistics",
url = "https://aclanthology.org/2021.eacl-demos.7",
doi = "10.18653/v1/2021.eacl-demos.7",
pages = "53--62",
abstract = "Language model (LM) pretraining has led to consistent improvements in many NLP downstream tasks, including named entity recognition (NER). In this paper, we present T-NER (Transformer-based Named Entity Recognition), a Python library for NER LM finetuning. In addition to its practical utility, T-NER facilitates the study and investigation of the cross-domain and cross-lingual generalization ability of LMs finetuned on NER. Our library also provides a web app where users can get model predictions interactively for arbitrary text, which facilitates qualitative model evaluation for non-expert programmers. We show the potential of the library by compiling nine public NER datasets into a unified format and evaluating the cross-domain and cross- lingual performance across the datasets. The results from our initial experiments show that in-domain performance is generally competitive across datasets. However, cross-domain generalization is challenging even with a large pretrained LM, which has nevertheless capacity to learn domain-specific features if fine- tuned on a combined dataset. To facilitate future research, we also release all our LM checkpoints via the Hugging Face model hub.",
}