Update README.md

README.md

@@ -22,9 +22,9 @@ You can use this model with Transformers *pipeline* for NER.
 
 <!-- Provide a longer summary of what this model is. -->
 ```python
-# Import necessary modules from the transformers library
-from transformers import pipeline
+# Import necessary Python modules from the Transformers library
 from transformers import AutoModelForTokenClassification, AutoTokenizer
+from transformers import pipeline
 
 # Define the model name to be used for token classification, we use the Impresso NER
 # that can be found at "https://huggingface.co/impresso-project/ner-stacked-bert-multilingual"
@@ -37,28 +37,25 @@ ner_pipeline = pipeline("generic-ner", model=MODEL_NAME,
                         tokenizer=ner_tokenizer, 
                         trust_remote_code=True,
                         device='cpu')
-sentences = ["""In the year 1789, King Louis XVI, ruler of France, convened the Estates-General at the Palace of Versailles, 
-                where Marie Antoinette, the Queen of France, alongside Maximilien Robespierre, a leading member of the National Assembly, 
-                debated with Jean-Jacques Rousseau, the famous philosopher, and Charles de Talleyrand, the Bishop of Autun, 
-                regarding the future of the French monarchy. At the same time, across the Atlantic in Philadelphia, 
-                George Washington, the first President of the United States, and Thomas Jefferson, the nation's Secretary of State, 
-                were drafting policies for the newly established American government following the signing of the Constitution."""]
-
-print(sentences[0])
-
-# Helper function to print entities one per row
-def print_nicely(entities):
-    for entity in entities:
-        print(f"Entity: {entity['entity']} | Confidence: {entity['score']:.2f}% | Text: {entity['word'].strip()} | Start: {entity['start']} | End: {entity['end']}")
-
-# Visualize stacked entities for each sentence
-for sentence in sentences:
-    results = ner_pipeline(sentence)
-
-    # Extract coarse and fine entities
-    for key in results.keys():
-        # Visualize the coarse entities
-        print_nicely(results[key])
+
+sentence = "En l'an 1348, au plus fort des ravages de la peste noire à travers l'Europe, le Royaume de France se trouvait à la fois au bord du désespoir et face à une opportunité. À la cour du roi Philippe VI, les murs du Louvre étaient animés par les rapports sombres venus de Paris et des villes environnantes. La peste ne montrait aucun signe de répit, et le chancelier Guillaume de Nogaret, le conseiller le plus fidèle du roi, portait le lourd fardeau de gérer la survie du royaume."
+
+entities = ner_pipeline(sentence)
+print(entities)
+```
+
+```
+[
+  {'type': 'time.date.abs', 'score': 85.0, 'index': (0, 5), 'surface': "En l'an 1348", 'start': 0, 'end': 12, 'lOffset': 0, 'rOffset': 12},
+  {'type': 'loc.adm.nat', 'score': 90.75, 'index': (19, 20), 'surface': 'Europe', 'start': 69, 'end': 75, 'lOffset': 0, 'rOffset': 6},
+  {'type': 'loc', 'score': 75.45, 'index': (22, 25), 'surface': 'Royaume de France', 'start': 80, 'end': 97, 'lOffset': 0, 'rOffset': 17},
+  {'type': 'pers.ind', 'score': 85.27, 'index': (44, 47), 'surface': 'roi Philippe VI', 'start': 181, 'end': 196, 'lOffset': 0, 'rOffset': 15, 'title': 'roi', 'name': 'roi Philippe VI'},
+  {'type': 'loc.adm.town', 'score': 30.59, 'index': (51, 52), 'surface': 'Louvre', 'start': 210, 'end': 216, 'lOffset': 0, 'rOffset': 6},
+  {'type': 'loc.adm.town', 'score': 94.46, 'index': (60, 61), 'surface': 'Paris', 'start': 266, 'end': 271, 'lOffset': 0, 'rOffset': 5},
+  {'type': 'pers.ind', 'score': 96.1, 'index': (77, 81), 'surface': 'chancelier Guillaume de Nogaret', 'start': 350, 'end': 381, 'lOffset': 0, 'rOffset': 31, 'title': 'chancelier', 'name': 'chancelier Guillaume de Nogaret'},
+  {'type': 'loc.adm.nat', 'score': 49.35, 'index': (22, 23), 'surface': 'Royaume', 'start': 80, 'end': 87, 'lOffset': 0, 'rOffset': 7},
+  {'type': 'loc.adm.nat', 'score': 24.18, 'index': (24, 25), 'surface': 'France', 'start': 91, 'end': 97, 'lOffset': 0, 'rOffset': 6}]
+
 ```