model update

README.md

@@ -0,0 +1,142 @@
+---
+datasets:
+- tweebank_ner
+metrics:
+- f1
+- precision
+- recall
+model-index:
+- name: tner/roberta-large-tweebank-ner
+  results:
+  - task:
+      name: Token Classification
+      type: token-classification
+    dataset:
+      name: tweebank_ner
+      type: tweebank_ner
+      args: tweebank_ner
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.7439490445859872
+    - name: Precision
+      type: precision
+      value: 0.7121951219512195
+    - name: Recall
+      type: recall
+      value: 0.7786666666666666
+    - name: F1 (macro)
+      type: f1_macro
+      value: 0.7354319457314183
+    - name: Precision (macro)
+      type: precision_macro
+      value: 0.712928566565599
+    - name: Recall (macro)
+      type: recall_macro
+      value: 0.7620465365030582
+    - name: F1 (entity span)
+      type: f1_entity_span
+      value: 0.8178343949044585
+    - name: Precision (entity span)
+      type: precision_entity_span
+      value: 0.7829268292682927
+    - name: Recall (entity span)
+      type: recall_entity_span
+      value: 0.856
+
+pipeline_tag: token-classification
+widget:
+- text: "Jacob Collier is a Grammy awarded artist from England."
+  example_title: "NER Example 1"
+---
+# tner/roberta-large-tweebank-ner
+
+This model is a fine-tuned version of [roberta-large](https://huggingface.co/roberta-large) on the 
+[tner/tweebank_ner](https://huggingface.co/datasets/tner/tweebank_ner) 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.7439490445859872
+- Precision (micro): 0.7121951219512195
+- Recall (micro): 0.7786666666666666
+- F1 (macro): 0.7354319457314183
+- Precision (macro): 0.712928566565599
+- Recall (macro): 0.7620465365030582
+
+The per-entity breakdown of the F1 score on the test set are below:
+- location: 0.7782805429864253
+- organization: 0.7377049180327869
+- other: 0.5520581113801453
+- person: 0.8736842105263157 
+
+For F1 scores, the confidence interval is obtained by bootstrap as below:
+- F1 (micro): 
+    - 90%: [0.7156413818791614, 0.771698046498159]
+    - 95%: [0.7063867669973017, 0.7763088810979543] 
+- F1 (macro): 
+    - 90%: [0.7156413818791614, 0.771698046498159]
+    - 95%: [0.7063867669973017, 0.7763088810979543] 
+
+Full evaluation can be found at [metric file of NER](https://huggingface.co/tner/roberta-large-tweebank-ner/raw/main/eval/metric.json) 
+and [metric file of entity span](https://huggingface.co/tner/roberta-large-tweebank-ner/raw/main/eval/metric_span.json).
+
+### Usage
+This model can be used through the transformers library by 
+```python
+from transformers import AutoTokenizer, AutoModelForTokenClassification
+tokenizer = AutoTokenizer.from_pretrained("tner/roberta-large-tweebank-ner")
+model = AutoModelForTokenClassification.from_pretrained("tner/roberta-large-tweebank-ner")
+```
+but, since transformers do not support CRF layer, it is recommended to use the model via `T-NER` library. 
+Install the library via pip   
+```shell
+pip install tner
+```
+and activate model as below.
+```python
+from tner import TransformersNER
+model = TransformersNER("tner/roberta-large-tweebank-ner")
+model.predict("Jacob Collier is a Grammy awarded English artist from London".split(" "))
+```
+
+### Training hyperparameters
+
+The following hyperparameters were used during training:
+ - dataset: ['tner/tweebank_ner']
+ - 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: 1
+ - weight_decay: None
+ - lr_warmup_step_ratio: 0.1
+ - max_grad_norm: 10.0
+
+The full configuration can be found at [fine-tuning parameter file](https://huggingface.co/tner/roberta-large-tweebank-ner/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.",
+}
+
+```

config.json

@@ -1,5 +1,5 @@
 {
-  "_name_or_path": "tner_ckpt/tweebank_ner_roberta_large/best_model",
+  "_name_or_path": "tner_ckpt/tweebank_ner_roberta_large/model_rcsnba/epoch_5",
   "architectures": [
     "RobertaForTokenClassification"
   ],

eval/metric.json

@@ -0,0 +1 @@
+{"micro/f1": 0.7439490445859872, "micro/f1_ci": {"90": [0.7156413818791614, 0.771698046498159], "95": [0.7063867669973017, 0.7763088810979543]}, "micro/recall": 0.7786666666666666, "micro/precision": 0.7121951219512195, "macro/f1": 0.7354319457314183, "macro/f1_ci": {"90": [0.7059930933412133, 0.7627860392219387], "95": [0.6997186311074856, 0.7688112367513721]}, "macro/recall": 0.7620465365030582, "macro/precision": 0.712928566565599, "per_entity_metric": {"location": {"f1": 0.7782805429864253, "f1_ci": {"90": [0.7150234036694952, 0.8333333333333335], "95": [0.702970297029703, 0.8436386089046127]}, "precision": 0.7818181818181819, "recall": 0.7747747747747747}, "organization": {"f1": 0.7377049180327869, "f1_ci": {"90": [0.6842019543973942, 0.7849562191608911], "95": [0.6730100480559196, 0.7921452904613915]}, "precision": 0.7336956521739131, "recall": 0.7417582417582418}, "other": {"f1": 0.5520581113801453, "f1_ci": {"90": [0.4944454536946816, 0.609313399778516], "95": [0.4841075794621027, 0.6183398114521798]}, "precision": 0.4978165938864629, "recall": 0.6195652173913043}, "person": {"f1": 0.8736842105263157, "f1_ci": {"90": [0.8447106204595834, 0.9021852173913043], "95": [0.8363620187641541, 0.9090909090909091]}, "precision": 0.8383838383838383, "recall": 0.9120879120879121}}}

eval/metric_span.json

@@ -0,0 +1 @@
+{"micro/f1": 0.8178343949044585, "micro/f1_ci": {"90": [0.7946512020674701, 0.8391476596836752], "95": [0.790463656866032, 0.8430815891456205]}, "micro/recall": 0.856, "micro/precision": 0.7829268292682927, "macro/f1": 0.8178343949044585, "macro/f1_ci": {"90": [0.7946512020674701, 0.8391476596836752], "95": [0.790463656866032, 0.8430815891456205]}, "macro/recall": 0.856, "macro/precision": 0.7829268292682927}

pytorch_model.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:879d72007ec3da22de560efd256bd2d9862e0e1d05d27e9b6f09766b51098aa6
-size 1417408561
+oid sha256:c54f83b090b2d698514726367f99730837c704da4e67f1d652ebd72e2f1b315e
+size 1417414001

tokenizer_config.json

@@ -6,7 +6,7 @@
   "errors": "replace",
   "mask_token": "<mask>",
   "model_max_length": 512,
-  "name_or_path": "tner_ckpt/tweebank_ner_roberta_large/best_model",
+  "name_or_path": "tner_ckpt/tweebank_ner_roberta_large/model_rcsnba/epoch_5",
   "pad_token": "<pad>",
   "sep_token": "</s>",
   "special_tokens_map_file": "tner_ckpt/tweebank_ner_roberta_large/model_rcsnba/epoch_5/special_tokens_map.json",

trainer_config.json

@@ -0,0 +1 @@
+{"dataset": ["tner/tweebank_ner"], "dataset_split": "train", "dataset_name": null, "local_dataset": null, "model": "roberta-large", "crf": true, "max_length": 128, "epoch": 15, "batch_size": 64, "lr": 1e-05, "random_seed": 42, "gradient_accumulation_steps": 1, "weight_decay": null, "lr_warmup_step_ratio": 0.1, "max_grad_norm": 10.0}