Update README.md

README.md

@@ -36,9 +36,6 @@ should probably proofread and complete it, then remove this comment. -->
 # hebert-finetuned-hebrew-squad
 
 This model fine-tunes avichr/heBERT model on SQuAD dataset auto-translated to Hebrew.
-## Model description
-
-More information needed
 
 ## Intended uses & limitations
 
@@ -46,7 +43,12 @@ Hebrew SQuAD
 
 ## Training and evaluation data
 
-More information needed
+
+| Dataset  | Split | # samples |
+| -------- | ----- | --------- |
+| Hebrew_Squad_v1| train | 52,405      |
+| Hebrew_Squad_v1| validation| 7,455     |
+
 
 ## Training procedure
 
@@ -61,6 +63,8 @@ The following hyperparameters were used during training:
 - lr_scheduler_type: linear
 - num_epochs: 15
 
+It took about 8 hours to finish training.
+
 ### Framework versions
 
 - Transformers 4.17.0
@@ -68,6 +72,36 @@ The following hyperparameters were used during training:
 - Datasets 1.18.4
 - Tokenizers 0.11.6
 
+### Results
+
+**Model size**: `418M`
+
+| Metric | # Value   | # Original ([Table 2](https://www.aclweb.org/anthology/N19-1423.pdf))|
+| ------ | --------- | --------- |
+| **Exact Match** | **42.6** | **80.8** |
+| **F1** | **55.9** | **88.5** |
+## Example Usage
+
+
+```python
+from transformers import pipeline
+
+model_checkpoint = "tdklab/hebert-finetuned-hebrew-squad"
+qa_pipeline = pipeline(
+    "question-answering",
+    model=model_checkpoint, 
+    )
+
+predictions = qa_pipeline({
+    'context': "ירושלים היא עיר הבירה של מדינת ישראל , והעיר הגדולה ביותר בישראל בגודל האוכלוסייה. נכון לשנת 2021, מתגוררים בה כ-957 אלף תושבים. בירושלים שוכנים מוסדות הממשל של ישראל: הכנסת, בית המשפט העליון, משכן הנשיא, בית ראש הממשלה ורוב משרדי הממשלה. ירושלים שוכנת בהרי יהודה, על קו פרשת המים הארצי של ארץ ישראל, בין הים התיכון וים המלח, ברום של 570 עד 857 מטרים מעל פני הים.",
+    'question': "מהי עיר הבירה של מדינת ישראל?"
+})
+
+print(predictions)
+# output:
+# {'score': 0.9999890327453613, 'start': 0, 'end': 7, 'answer': 'ירושלים'}
+```
+
 ### About Us
 Created by Matan Ben-chorin, May Flaster, Guided by Dr. Oren Mishali.
 This is our final project as part of computer engineering B.Sc studies in the Faculty of Electrical Engineering combined with Computer Science at Technion, Israel Institute of Technology.