Update README.md

README.md

@@ -1,8 +1,10 @@
 ---
-license: mit
+license: cc-by-sa-4.0
 base_model: numind/NuNER-v1.0
 tags:
-- generated_from_trainer
+- token-classification
+- ner
+- named-entity-recognition
 metrics:
 - precision
 - recall
@@ -10,33 +12,95 @@ metrics:
 - accuracy
 model-index:
 - name: nuner-v1_orgs
-  results: []
+  results:
+  - task:
+      type: token-classification
+      name: Named Entity Recognition
+    dataset:
+      name: FewNERD, CoNLL2003, and OntoNotes v5
+      type: tomaarsen/ner-orgs
+      split: test
+    metrics:
+    - type: f1
+      value: 0.7798010380622837
+      name: F1
+    - type: precision
+      value: 0.7605247616637139
+      name: Precision
+    - type: recall
+      value: 0.800079879293512
+      name: Recall
+    - type: accuracy
+      value: 0.9769673789973878
+      name: Accuracy
+datasets:
+- tomaarsen/ner-orgs
+language:
+- en
+library_name: transformers
+pipeline_tag: token-classification
+widget:
+- text: Concern and scepticism surround Niger uranium mining waste storage plans. Towering mounds dot the desert landscape in northern Niger's Arlit region, but they are heaps of partially radioactive waste left from four decades of operations at one of the world's biggest uranium mines. An ambitious 10-year scheme costing $160 million is underway to secure the waste and avoid risks to health and the environment, but many local people are worried or sceptical. France's nuclear giant Areva, now called Orano, worked the area under a subsidiary, the Akouta Mining Company (Cominak). Cominak closed the site in 2021 after extracting 75,000 tonnes of uranium, much of which went to fuelling the scores of nuclear reactors that provide the backbone of France's electricity supply. Cominak's director general Mahaman Sani Abdoulaye showcased the rehabilitation project to the first French journalists to visit the site since 2010, when seven Areva employees were kidnapped by jihadists.
+- text: SE Michigan counties allege insulin gouging; Localities file lawsuit against pharmaceutical makers. Four metro Detroit counties filed federal lawsuits Wednesday against some of the nation's biggest pharmaceutical manufacturers and pharmacy benefit managers alleging illegal price fixing for insulin products. Macomb, Monroe, Wayne and Washtenaw counties filed the lawsuits in U.S. District Court in New Jersey against more than a dozen companies, including Lilly, Sanofi Aventis, Novo Nordisk, Express Scripts, Optum Rx and CVS Caremark, per their attorneys. "These are the first such lawsuits that have been filed in the state of Michigan and probably more to come," said attorney Melvin Butch Hollowell of the Miller Law Firm. He described the allegations during a news conference, saying that nationally "the pharmacies and manufacturers get together. They control about 90% of the market each, of the insulin market. They talk to each other secretly. And they jack up the prices through anticompetitive means. And what we've seen is over the past 20 years, when we talk about jacking up the prices, they jack them up 1,500% in the last 20 years. 1,500%."
+- 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.
+- text: Tech giants ‘could severely disable UK spooks from stopping online harms’. Silicon Valley tech giants’ actions could “severely disable” UK spooks from preventing harm caused by online paedophiles and fraudsters, Suella Braverman  has suggested. The Conservative former home secretary named Facebook owner Meta , and Apple, and their use of technologies such as end-to-end encryption as a threat to attempts to tackle digital crimes. She claimed the choice to back these technologies without “safeguards” could “enable and indeed facilitate some of the worst atrocities that our brave men and women in law enforcement agencies deal with every day”, as MPs  began considering changes to investigatory powers laws. The Investigatory Powers (Amendment) Bill  includes measures to make it easier for agencies to examine and retain bulk datasets, such as publicly available online telephone records, and would allow intelligence agencies to use internet connection records to aid detection of their targets. We know that the terrorists, the serious organised criminals, and fraudsters, and the online paedophiles, all take advantage of the dark web and encrypted spaces
+- text: Camargo Corrêa asks Toffoli to suspend the fine agreed with Lava Jato. The Camargo Corrêa group has asked Justice Dias Toffoli to suspend the R$1.4 billion fine it agreed to pay in its leniency agreement under Operation Car Wash. The company asked for an extension of the minister's decisions that benefited J&F and Odebrecht. Like the other companies, it claimed that it suffered undue pressure from members of the Federal Public Prosecutor's Office (MPF) to close the deal. Much of the request is based on messages exchanged between prosecutors from the Curitiba task force and former judge Sergio Moro - Camargo Corrêa requested full access to the material, seized in Operation Spoofing, which arrested the hackers who broke into cell phones. The dialogues, according to the group's defense, indicate that the executives did not freely agree to the deal, since they were the targets of lawsuits and pre-trial detentions.
 ---
 
-<!-- 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_orgs
-
-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.0631
-- Precision: 0.7912
-- Recall: 0.8045
-- F1: 0.7978
-- Accuracy: 0.9790
-
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
+# numind/NuNER-v1.0 fine-tuned on FewNERD-fine-supervised
+
+This is a [NuNER](https://arxiv.org/abs/2402.15343) model fine-tuned on the [NER-ORGS](https://huggingface.co/datasets/tomaarsen/ner-orgs) 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: ORG
+
+## 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_orgs",
+    grouped_entities=True
+)
+>>> classifier(text)
+
+[{'entity_group': 'ORG',
+  'score': 0.9821347,
+  'word': 'CNN',
+  'start': 94,
+  'end': 97},
+ {'entity_group': 'ORG',
+  'score': 0.99382174,
+  'word': ' Apple',
+  'start': 288,
+  'end': 293},
+ {'entity_group': 'ORG',
+  'score': 0.99351865,
+  'word': ' Google',
+  'start': 298,
+  'end': 304},
+ {'entity_group': 'ORG',
+  'score': 0.992792,
+  'word': ' Apple',
+  'start': 449,
+  'end': 454},
+ {'entity_group': 'ORG',
+  'score': 0.99385214,
+  'word': ' Google',
+  'start': 459,
+  'end': 465}]
+```
 
 ## Training procedure
 
@@ -70,3 +134,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}
+}
+```