Update README.md

README.md

@@ -14,16 +14,27 @@ metrics:
 datasets:
 - sst
 - sst2
+
+model-index:
+- name: rttl-ai/SentyBert
   results:
-    - task:
-          type: text-classification
-          name: Text Classification
-        dataset:
-          name: sst2
-          type: sst2
-          config: default
-          split: train
-        metrics:
-          - type: accuracy
-            value: 0.9992
-            name: F1 Macro
+  - task:
+      type: task-classification             # Required. Example: automatic-speech-recognition
+      name: Text Classification             # Optional. Example: Speech Recognition
+    dataset:
+      type: sst2          # Required. Example: common_voice. Use dataset id from https://hf.co/datasets
+      name: sst2          # Required. A pretty name for the dataset. Example: Common Voice (French)
+      config: default     # 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
+      revision: {dataset_revision}  # Optional. Example: 5503434ddd753f426f4b38109466949a1217c2bb
+      args:
+        {arg_0}: {value_0}          # Optional. Additional arguments to `load_dataset()`. Example for wikipedia: language: en
+        {arg_1}: {value_1}          # Optional. Example for wikipedia: date: 20220301
+    metrics:
+      - type: f1         # Required. Example: wer. Use metric id from https://hf.co/metrics
+        value: 0.9992       # Required. Example: 20.90
+        name: f1 Macro         # Optional. Example: Test WER
+        config: {metric_config}     # Optional. The name of the metric configuration used in `load_metric()`. Example: bleurt-large-512 in `load_metric("bleurt", "bleurt-large-512")`. See the `datasets` docs for more info: https://huggingface.co/docs/datasets/v2.1.0/en/loading#load-configurations
+        args:
+          {arg_0}: {value_0}        # Optional. The arguments passed during `Metric.compute()`. Example for `bleu`: max_order: 4
+        verified: true