From d8a6a968afe3c8be5d9418abac7f40941446e945 Mon Sep 17 00:00:00 2001
From: JB Polle <jbpolle83@gmail.com>
Date: Fri, 12 Mar 2021 14:41:22 +0000
Subject: [PATCH] Create README.md
---
README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 81 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1778ecb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+---
+language: fr
+widget:
+dataset: Jean-Baptiste/wikiner-fr
+- text: "Je m'appelle Jean-Baptiste et je vis à Paris"
+---
+
+# camembert-ner: model fine-tuned from camemBERT for NER task.
+
+## Introduction
+
+[camembert-ner] is a NER model that was fine-tuned from camemBERT on wikiner-fr dataset
+
+
+## How to use camembert-ner with HuggingFace
+
+##### Load camembert-ner and its sub-word tokenizer :
+
+```python
+from transformers import AutoTokenizer, AutoModelForTokenClassification
+
+tokenizer = AutoTokenizer.from_pretrained("Jean-Baptiste/camembert-ner")
+model = AutoModelForTokenClassification.from_pretrained("Jean-Baptiste/camembert-ner")
+
+
+##### Process text sample (from wikipedia)
+
+from transformers import pipeline
+
+nlp = pipeline('ner', model=model, tokenizer=tokenizer, grouped_entities=True)
+nlp("Apple est créée le 1er avril 1976 dans le garage de la maison d'enfance de Steve Jobs à Los Altos en Californie par Steve Jobs, Steve Wozniak et Ronald Wayne14, puis constituée sous forme de société le 3 janvier 1977 à l'origine sous le nom d'Apple Computer, mais pour ses 30 ans et pour refléter la diversification de ses produits, le mot « computer » est retiré le 9 janvier 2015.")
+
+
+[{'entity_group': 'ORG',
+ 'score': 0.9472818374633789,
+ 'word': 'Apple',
+ 'start': 0,
+ 'end': 5},
+ {'entity_group': 'PER',
+ 'score': 0.9838564991950989,
+ 'word': 'Steve Jobs',
+ 'start': 74,
+ 'end': 85},
+ {'entity_group': 'LOC',
+ 'score': 0.9831605950991312,
+ 'word': 'Los Altos',
+ 'start': 87,
+ 'end': 97},
+ {'entity_group': 'LOC',
+ 'score': 0.9834540486335754,
+ 'word': 'Californie',
+ 'start': 100,
+ 'end': 111},
+ {'entity_group': 'PER',
+ 'score': 0.9841555754343668,
+ 'word': 'Steve Jobs',
+ 'start': 115,
+ 'end': 126},
+ {'entity_group': 'PER',
+ 'score': 0.9843501806259155,
+ 'word': 'Steve Wozniak',
+ 'start': 127,
+ 'end': 141},
+ {'entity_group': 'PER',
+ 'score': 0.9841533899307251,
+ 'word': 'Ronald Wayne',
+ 'start': 144,
+ 'end': 157},
+ {'entity_group': 'ORG',
+ 'score': 0.9468960364659628,
+ 'word': 'Apple Computer',
+ 'start': 243,
+ 'end': 257}]
+
+```
+
+
+## Authors
+
+
+