# tner/roberta-large-btc

This model is a fine-tuned version of [roberta-large](https://huggingface.co/roberta-large) on the 
[tner/btc](https://huggingface.co/datasets/tner/btc) dataset.
Model fine-tuning is done via [T-NER](https://github.com/asahi417/tner)'s hyper-parameter search (see the repository
for more detail). It achieves the following results on the test set:
- F1 (micro): 0.8367557645979121
- Precision (micro): 0.8401290025339784
- Recall (micro): 0.8334095063985375
- F1 (macro): 0.7830389304099722
- Precision (macro): 0.7911560677795398
- Recall (macro): 0.7756024849498971

The per-entity breakdown of the F1 score on the test set are below:
- location: 0.736756316218419
- organization: 0.6927985414767548
- person: 0.9195619335347431 

For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 
- F1 (macro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 

Full evaluation can be found at [metric file of NER](https://huggingface.co/tner/roberta-large-btc/raw/main/eval/metric.json) 
and [metric file of entity span](https://huggingface.co/tner/roberta-large-btc/raw/main/eval/metric_span.json).

### Usage
This model can be used through the [tner library](https://github.com/asahi417/tner). Install the library via pip   
```shell
pip install tner
```
and activate model as below.
```python
from tner import TransformersNER
model = TransformersNER("tner/roberta-large-btc")
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/btc']
 - dataset_split: train
 - dataset_name: None
 - local_dataset: None
 - model: roberta-large
 - crf: True
 - max_length: 128
 - epoch: 15
 - batch_size: 64
 - lr: 1e-05
 - random_seed: 42
 - gradient_accumulation_steps: 2
 - weight_decay: 1e-07
 - lr_warmup_step_ratio: 0.1
 - max_grad_norm: None

The full configuration can be found at [fine-tuning parameter file](https://huggingface.co/tner/roberta-large-btc/raw/main/trainer_config.json).

### Reference
If you use any resource from T-NER, please consider to cite our [paper](https://aclanthology.org/2021.eacl-demos.7/).

```

@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.",
}

```

{"datasets": ["tner/btc"], "metrics": ["f1", "precision", "recall"], "pipeline_tag": "token-classification", "widget": [{"text": "Jacob Collier is a Grammy awarded artist from England.", "example_title": "NER Example 1"}], "model-index": [{"name": "tner/roberta-large-btc", "results": [{"task": {"type": "token-classification", "name": "Token Classification"}, "dataset": {"name": "tner/btc", "type": "tner/btc", "args": "tner/btc"}, "metrics": [{"type": "f1", "value": 0.8367557645979121, "name": "F1"}, {"type": "precision", "value": 0.8401290025339784, "name": "Precision"}, {"type": "recall", "value": 0.8334095063985375, "name": "Recall"}, {"type": "f1_macro", "value": 0.7830389304099722, "name": "F1 (macro)"}, {"type": "precision_macro", "value": 0.7911560677795398, "name": "Precision (macro)"}, {"type": "recall_macro", "value": 0.7756024849498971, "name": "Recall (macro)"}, {"type": "f1_entity_span", "value": 0.9113227027647126, "name": "F1 (entity span)"}, {"type": "precision_entity_span", "value": 0.9149965445749827, "name": "Precision (entity span)"}, {"type": "recall_entity_span", "value": 0.9076782449725777, "name": "Recall (entity span)"}]}]}]}
transformers pytorch roberta token-classification dataset:tner/btc model-index autotrain_compatible endpoints_compatible region:us
TAGS
#transformers #pytorch #roberta #token-classification #dataset-tner/btc #model-index #autotrain_compatible #endpoints_compatible #region-us 

# tner/roberta-large-btc

This model is a fine-tuned version of roberta-large on the 
tner/btc dataset.
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:
- F1 (micro): 0.8367557645979121
- Precision (micro): 0.8401290025339784
- Recall (micro): 0.8334095063985375
- F1 (macro): 0.7830389304099722
- Precision (macro): 0.7911560677795398
- Recall (macro): 0.7756024849498971

The per-entity breakdown of the F1 score on the test set are below:
- location: 0.736756316218419
- organization: 0.6927985414767548
- person: 0.9195619335347431 

For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 
- F1 (macro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 

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   

and activate model as below.

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/btc']
 - dataset_split: train
 - dataset_name: None
 - local_dataset: None
 - model: roberta-large
 - crf: True
 - max_length: 128
 - epoch: 15
 - batch_size: 64
 - lr: 1e-05
 - random_seed: 42
 - gradient_accumulation_steps: 2
 - weight_decay: 1e-07
 - lr_warmup_step_ratio: 0.1
 - max_grad_norm: None

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.



# tner/roberta-large-btc

This model is a fine-tuned version of roberta-large on the 
tner/btc dataset.
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:
- F1 (micro): 0.8367557645979121
- Precision (micro): 0.8401290025339784
- Recall (micro): 0.8334095063985375
- F1 (macro): 0.7830389304099722
- Precision (macro): 0.7911560677795398
- Recall (macro): 0.7756024849498971

The per-entity breakdown of the F1 score on the test set are below:
- location: 0.736756316218419
- organization: 0.6927985414767548
- person: 0.9195619335347431 

For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 
- F1 (macro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 

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   

and activate model as below.

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/btc']
 - dataset_split: train
 - dataset_name: None
 - local_dataset: None
 - model: roberta-large
 - crf: True
 - max_length: 128
 - epoch: 15
 - batch_size: 64
 - lr: 1e-05
 - random_seed: 42
 - gradient_accumulation_steps: 2
 - weight_decay: 1e-07
 - lr_warmup_step_ratio: 0.1
 - max_grad_norm: None

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.
TAGS
#transformers #pytorch #roberta #token-classification #dataset-tner/btc #model-index #autotrain_compatible #endpoints_compatible #region-us 
 # tner/roberta-large-btc

This model is a fine-tuned version of roberta-large on the 
tner/btc dataset.
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:
- F1 (micro): 0.8367557645979121
- Precision (micro): 0.8401290025339784
- Recall (micro): 0.8334095063985375
- F1 (macro): 0.7830389304099722
- Precision (macro): 0.7911560677795398
- Recall (macro): 0.7756024849498971

The per-entity breakdown of the F1 score on the test set are below:
- location: 0.736756316218419
- organization: 0.6927985414767548
- person: 0.9195619335347431 

For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 
- F1 (macro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 

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   

and activate model as below.

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/btc']
 - dataset_split: train
 - dataset_name: None
 - local_dataset: None
 - model: roberta-large
 - crf: True
 - max_length: 128
 - epoch: 15
 - batch_size: 64
 - lr: 1e-05
 - random_seed: 42
 - gradient_accumulation_steps: 2
 - weight_decay: 1e-07
 - lr_warmup_step_ratio: 0.1
 - max_grad_norm: None

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.
passage: TAGS
#transformers #pytorch #roberta #token-classification #dataset-tner/btc #model-index #autotrain_compatible #endpoints_compatible #region-us 
# tner/roberta-large-btc

This model is a fine-tuned version of roberta-large on the 
tner/btc dataset.
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:
- F1 (micro): 0.8367557645979121
- Precision (micro): 0.8401290025339784
- Recall (micro): 0.8334095063985375
- F1 (macro): 0.7830389304099722
- Precision (macro): 0.7911560677795398
- Recall (macro): 0.7756024849498971

The per-entity breakdown of the F1 score on the test set are below:
- location: 0.736756316218419
- organization: 0.6927985414767548
- person: 0.9195619335347431 

For F1 scores, the confidence interval is obtained by bootstrap as below:
- F1 (micro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 
- F1 (macro): 
    - 90%: [0.8263755823738717, 0.8472678708881698]
    - 95%: [0.8238362631404713, 0.8498613485265176] 

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   

and activate model as below.

It can be used via transformers library but it is not recommended as CRF layer is not supported at the moment.