Update README.md

README.md

@@ -17,12 +17,23 @@ should probably proofread and complete it, then remove this comment. -->
 # span-marker-robert-base
 
 This model is a fine-tuned version of [roberta-base](https://huggingface.co/roberta-base) on [few-nerd](https://huggingface.co/datasets/DFKI-SLT/few-nerd) dataset using [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) an module for NER.
-It achieves the following results on the evaluation set:
-- Loss: 0.0214
-- Overall Precision: 0.7642
-- Overall Recall: 0.7947
-- Overall F1: 0.7791
-- Overall Accuracy: 0.9397
+
+# Usage
+
+```python
+test_query= [
+    "The 2022 FIFA World Cup was the 22nd FIFA World Cup, the quadrennial world championship for national football teams organized by FIFA.",
+    "Argentina were crowned the champions after winning the final against the title holder France 4-2 on penalties following a 3-3 draw after extra time.", 
+    "It was Argentina's third title and their first since 1986, as well being the first nation from outside of Europe to win the tournament since 2002.", 
+    "French player Kylian Mbappé became the first player to score a hat-trick in a World Cup final since Geoff Hurst in the 1966 final and won the Golden Boot as he scored the most goals (eight) during the tournament.", 
+    "Argentine captain Lionel Messi was voted the tournament's best player, winning the Golden Ball. Teammates Emiliano Martínez and Enzo Fernández won the Golden Glove, awarded to the tournament's best goalkeeper, and the Young Player Award, awarded to the tournament's best young player."
+]
+entities_per_query = model.predict(test_query)
+
+for entities in entities_per_query:
+    for entity in entities:
+        print(entity["span"], "=>", entity["label"])
+```
 
 ## Training and evaluation data
 
@@ -40,6 +51,15 @@ The following hyperparameters were used during training:
 - lr_scheduler_warmup_ratio: 0.1
 - num_epochs: 1
 
+### Evaluation
+
+It achieves the following results on the evaluation set:
+- Loss: 0.0214
+- Overall Precision: 0.7642
+- Overall Recall: 0.7947
+- Overall F1: 0.7791
+- Overall Accuracy: 0.9397
+- 
 ### Training results
 
 | Training Loss | Epoch | Step | Validation Loss | Overall Precision | Overall Recall | Overall F1 | Overall Accuracy |
@@ -63,4 +83,5 @@ The following hyperparameters were used during training:
 - Transformers 4.30.2
 - Pytorch 2.0.1+cu118
 - Datasets 2.13.1
-- Tokenizers 0.13.3
+- Tokenizers 0.13.3
+- span-marker 1.2.3