Update README.md

README.md

@@ -7,9 +7,26 @@ datasets:
 metrics:
 - f1
 - exact_match
+
+# Optional. Add this if you want to encode your eval results in a structured way.
 model-index:
 - name: spanbert-base-finetuned-squad
-  results: []
+  results:
+  - task:
+      type: question-answering             # Required. Example: automatic-speech-recognition
+      name: Closed-Domain 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)
+      config: squad      # Optional. The name of the dataset configuration used in `load_dataset()`. Example: fr in `load_dataset("common_voice", "fr")`. See the `datasets` docs for more info: https://huggingface.co/docs/datasets/package_reference/loading_methods#datasets.load_dataset.name
+      split: validation        # Optional. Example: test
+    metrics:
+      - type: exact_match         # Required. Example: wer. Use metric id from https://hf.co/metrics
+        value: 84.6168       # Required. Example: 20.90
+        name: Exact Match         # Optional. Example: Test WER
+      - type: f1         # Required. Example: wer. Use metric id from https://hf.co/metrics
+        value: 91.6134       # Required. Example: 20.90
+        name: F1         # Optional. Example: Test WER
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You