Update README.md

README.md

@@ -1,8 +1,10 @@
 ---
-license: mit
+license: apache-2.0
 base_model: numind/NuNER-v1.0
 tags:
-- generated_from_trainer
+- token-classification
+- ner
+- named-entity-recognition
 metrics:
 - precision
 - recall
@@ -10,35 +12,142 @@ metrics:
 - accuracy
 model-index:
 - name: nuner-v1_ontonotes5
-  results: []
+  results:
+  - task:
+      type: token-classification
+      name: Named Entity Recognition
+    dataset:
+      name: OntoNotes5
+      type: tner/ontonotes5
+      split: eval
+    metrics:
+    - type: f1
+      value: 0.890930568316052
+      name: F1
+    - type: precision
+      value: 0.8777586206896552
+      name: Precision
+    - type: recall
+      value: 0.9045038642622368
+      name: Recall
+    - type: accuracy
+      value: 0.9818887790313181
+      name: Accuracy
+datasets:
+- tner/ontonotes5
+language:
+- en
+library_name: transformers
+pipeline_tag: token-classification
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
-# nuner-v1_ontonotes5
-
-This model is a fine-tuned version of [numind/NuNER-v1.0](https://huggingface.co/numind/NuNER-v1.0) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.0728
-- Precision: 0.8712
-- Recall: 0.9000
-- F1: 0.8853
-- Accuracy: 0.9811
-
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
+# numind/NuNER-v1.0 fine-tuned on OntoNotes5
+
+This is a [NuNER](https://arxiv.org/abs/2402.15343) model fine-tuned on the [OntoNotes5](https://huggingface.co/datasets/tner/ontonotes5) dataset that can be used for Named Entity Recognition. NuNER model uses [RoBERTa-base](https://huggingface.co/FacebookAI/roberta-base) as the backbone encoder and it was trained on the [NuNER dataset](https://huggingface.co/datasets/numind/NuNER), which is a large and diverse dataset synthetically labeled by gpt-3.5-turbo-0301 of 1M sentences. This further pre-training phase allowed the generation of high quality token embeddings, a good starting point for fine-tuning on more specialized datasets.
+
+## Model Details
+
+The model was fine-tuned as a regular BERT-based model for NER task using HuggingFace Trainer class.
+
+## Model labels
+
+Entity Types: CARDINAL, DATE, PERSON, NORP, GPE, LAW, PERCENT, ORDINAL, MONEY, WORK_OF_ART, FAC, TIME, QUANTITY, PRODUCT, LANGUAGE, ORG, LOC, EVENT
+
+## Uses
+
+### Direct Use for Inference
+
+```python
+>>> from transformers import pipeline
+
+>>> text = """Foreign governments may be spying on your smartphone notifications, senator says. Washington (CNN) — Foreign governments have reportedly attempted to spy on iPhone and Android users through the mobile app notifications they receive on their smartphones - and the US government has forced Apple and Google to keep quiet about it, according to a top US senator. Through legal demands sent to the tech giants, governments have allegedly tried to force Apple and Google to turn over sensitive information that could include the contents of a notification - such as previews of a text message displayed on a lock screen, or an update about app activity, Oregon Democratic Sen. Ron Wyden said in a new report. Wyden's report reflects the latest example of long-running tensions between tech companies and governments over law enforcement demands, which have stretched on for more than a decade. Governments around the world have particularly battled with tech companies over encryption, which provides critical protections to users and businesses while in some cases preventing law enforcement from pursuing investigations into messages sent over the internet."""
+
+>>> classifier = pipeline(
+    "ner",
+    model="guishe/nuner-v1_ontonotes5",
+    grouped_entities=True
+)
+>>> classifier(text)
+
+[{'entity_group': 'GPE',
+  'score': 0.99179757,
+  'word': ' Washington',
+  'start': 82,
+  'end': 92},
+ {'entity_group': 'ORG',
+  'score': 0.9535868,
+  'word': 'CNN',
+  'start': 94,
+  'end': 97},
+ {'entity_group': 'PRODUCT',
+  'score': 0.6833637,
+  'word': ' iPhone',
+  'start': 157,
+  'end': 163},
+ {'entity_group': 'PRODUCT',
+  'score': 0.5540275,
+  'word': ' Android',
+  'start': 168,
+  'end': 175},
+ {'entity_group': 'GPE',
+  'score': 0.98848885,
+  'word': ' US',
+  'start': 263,
+  'end': 265},
+ {'entity_group': 'ORG',
+  'score': 0.9939406,
+  'word': ' Apple',
+  'start': 288,
+  'end': 293},
+ {'entity_group': 'ORG',
+  'score': 0.9933014,
+  'word': ' Google',
+  'start': 298,
+  'end': 304},
+ {'entity_group': 'GPE',
+  'score': 0.99083686,
+  'word': ' US',
+  'start': 348,
+  'end': 350},
+ {'entity_group': 'ORG',
+  'score': 0.99349517,
+  'word': ' Apple',
+  'start': 449,
+  'end': 454},
+ {'entity_group': 'ORG',
+  'score': 0.99239254,
+  'word': ' Google',
+  'start': 459,
+  'end': 465},
+ {'entity_group': 'GPE',
+  'score': 0.99598336,
+  'word': ' Oregon',
+  'start': 649,
+  'end': 655},
+ {'entity_group': 'NORP',
+  'score': 0.99030787,
+  'word': ' Democratic',
+  'start': 656,
+  'end': 666},
+ {'entity_group': 'PERSON',
+  'score': 0.9957912,
+  'word': ' Ron Wyden',
+  'start': 672,
+  'end': 681},
+ {'entity_group': 'PERSON',
+  'score': 0.83941424,
+  'word': ' Wyden',
+  'start': 704,
+  'end': 709},
+ {'entity_group': 'DATE',
+  'score': 0.87746465,
+  'word': ' more than a decade',
+  'start': 869,
+  'end': 887}]
+```
+
+
+## Training Details
 
 ### Training hyperparameters
 
@@ -70,3 +179,17 @@ The following hyperparameters were used during training:
 - Pytorch 2.0.0+cu117
 - Datasets 2.18.0
 - Tokenizers 0.15.2
+
+- ## Citation
+
+### BibTeX
+```
+@misc{bogdanov2024nuner,
+      title={NuNER: Entity Recognition Encoder Pre-training via LLM-Annotated Data}, 
+      author={Sergei Bogdanov and Alexandre Constantin and Timothée Bernard and Benoit Crabbé and Etienne Bernard},
+      year={2024},
+      eprint={2402.15343},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```