Update README.md

README.md

@@ -1 +1,34 @@
-# Hugging-face testing
+# Hugging-face testing
+
+---
+language:
+- {lang_0}  # Example: fr
+- {lang_1}  # Example: en
+license: apache-2.0  # Example: apache-2.0 or any license from https://hf.co/docs/hub/model-repos#list-of-license-identifiers
+tags:
+- {tag_0}  # Example: audio
+- {tag_1}  # Example: automatic-speech-recognition
+- {tag_2}  # Example: speech
+- {tag_3}  # Example to specify a library: allennlp
+datasets:
+- test  # Example: common_voice. Use dataset id from https://hf.co/datasets
+metrics:
+- test  # Example: wer. Use metric id from https://hf.co/metrics
+
+# Optional. Add this if you want to encode your eval results in a structured way.
+model-index:
+- name: test
+  results:
+  - task: 
+      type: test  # Required. Example: automatic-speech-recognition
+      name: test  # Optional. Example: Speech Recognition
+    dataset:
+      type: test  # Required. Example: common_voice. Use dataset id from https://hf.co/datasets
+      name: test  # Required. Example: Common Voice zh-CN
+      args: {arg_0}         # Optional. Example: zh-CN
+    metrics:
+      - type: test    # Required. Example: wer
+        value: {metric_value}  # Required. Example: 20.90
+        name: test    # Optional. Example: Test WER
+        args: {arg_0}          # Optional. Example for BLEU: max_order
+---