Update README.md

README.md

@@ -2,14 +2,22 @@
 license: mit
 tags:
 - generated_from_trainer
-datasets:
-- squad
+
 model-index:
 - name: roberta-base-finetuned-squad-v1
-  results: []
-metrics:
-- f1
-- exact_match
+  results:
+  - task:
+      type: question-answering             # Required. Example: automatic-speech-recognition
+      name: Question Answering             # Optional. Example: Speech Recognition
+    dataset:
+      type: squad          # Required. Example: common_voice. Use dataset id from https://hf.co/datasets
+      name: SQUAD          # Required. A pretty name for the dataset. Example: Common Voice (French)
+    metrics:
+      - type: f1         # Required. Example: wer. Use metric id from https://hf.co/metrics
+        value: 92.296       # Required. Example: 20.90
+      - type: exact_match 
+        value: 86.045
+
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -21,19 +29,9 @@ This model is a fine-tuned version of [roberta-base](https://huggingface.co/robe
 
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
+Given a context / content, the model answers to a question by searching the content and extracting the relavant information.
 
-### Training hyperparameters
+## Training hyperparameters
 
 The following hyperparameters were used during training:
 - learning_rate: 2e-05
@@ -47,13 +45,11 @@ The following hyperparameters were used during training:
 - num_epochs: 3
 - mixed_precision_training: Native AMP
 
-### Training results
+## Training results
 
 - training loss: 0.77257
-- f1 = 92.296
-- exact_match = 86.045
 
-### Framework versions
+## Framework versions
 
 - Transformers 4.27.4
 - Pytorch 1.13.1+cu116