metadata
datasets:
- tner/tweetner7
metrics:
- f1
- precision
- recall
model-index:
- name: tner/bertweet-large-tweetner7-2021
results:
- task:
name: Token Classification
type: token-classification
dataset:
name: tner/tweetner7
type: tner/tweetner7
args: tner/tweetner7
metrics:
- name: F1 (test_2021)
type: f1
value: 0.6289961994187345
- name: Precision (test_2021)
type: precision
value: 0.6087191691908265
- name: Recall (test_2021)
type: recall
value: 0.6506706753006476
- name: Macro F1 (test_2021)
type: f1_macro
value: 0.5812541319576294
- name: Macro Precision (test_2021)
type: precision_macro
value: 0.5735814298740157
- name: Macro Recall (test_2021)
type: recall_macro
value: 0.5939651947848222
- name: Entity Span F1 (test_2021)
type: f1_entity_span
value: 0.7649656251746688
- name: Entity Span Precision (test_2020)
type: precision_entity_span
value: 0.7402639549978365
- name: Entity Span Recall (test_2021)
type: recall_entity_span
value: 0.7913727304267376
- name: F1 (test_2020)
type: f1
value: 0.6161290322580646
- name: Precision (test_2020)
type: precision
value: 0.6391522587841606
- name: Recall (test_2020)
type: recall
value: 0.5947067981318112
- name: Macro F1 (test_2020)
type: f1_macro
value: 0.5683990688463066
- name: Macro Precision (test_2020)
type: precision_macro
value: 0.6097755448151788
- name: Macro Recall (test_2020)
type: recall_macro
value: 0.5400218465464566
- name: Entity Span F1 (test_2020)
type: f1_entity_span
value: 0.7446236559139785
- name: Entity Span Precision (test_2020)
type: precision_entity_span
value: 0.7724484104852203
- name: Entity Span Recall (test_2020)
type: recall_entity_span
value: 0.7187337830825117
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-2021
This model is a fine-tuned version of vinai/bertweet-large on the
tner/tweetner7 dataset (train_2021 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.6289961994187345
- Precision (micro): 0.6087191691908265
- Recall (micro): 0.6506706753006476
- F1 (macro): 0.5812541319576294
- Precision (macro): 0.5735814298740157
- Recall (macro): 0.5939651947848222
The per-entity breakdown of the F1 score on the test set are below:
- corporation: 0.48868253047011023
- creative_work: 0.42327272727272724
- event: 0.44868301544050865
- group: 0.5640022358859699
- location: 0.6620973269362577
- person: 0.8104852993269572
- product: 0.6715557883708747
For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro):
- 90%: [0.6203286893040556, 0.6380714998883444]
- 95%: [0.618788856392642, 0.6396755249087301]
- F1 (macro):
- 90%: [0.6203286893040556, 0.6380714998883444]
- 95%: [0.618788856392642, 0.6396755249087301]
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-2021")
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_2021
- dataset_name: None
- local_dataset: None
- model: vinai/bertweet-large
- crf: True
- max_length: 128
- epoch: 30
- batch_size: 32
- lr: 0.0001
- 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.",
}