Proposal : improve docs about metadata validation (#342)

* improve docs about metadata validation

* Update docs/hub/adding-a-library.md

Co-authored-by: Omar Sanseviero <[email protected]>

Co-authored-by: Omar Sanseviero <[email protected]>

Author: elishowk

docs/hub/adding-a-library.md

@@ -253,37 +253,41 @@ The full model card specification is  [here](https://github.com/huggingface/hugg
 language:
 - {lang_0}  # Example: fr
 - {lang_1}  # Example: en
-license: {license}  # Example: apache-2.0
+license: {license}  # 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:
-- {dataset_0}  # Example: common_voice
+- {dataset_0}  # Example: common_voice. Use dataset id from https://hf.co/datasets
 metrics:
-- {metric_0}  # Example: wer
+- {metric_0}  # Example: wer. Use metric id from https://hf.co/metrics
 
-model-index:  
+# Optional. Add this if you want to encode your eval results in a structured way.
+model-index:
 - name: {model_id}
   results:
   - task: 
-      name: {task_name}  # Example: Speech Recognition
-      type: {task_type}  # Example: automatic-speech-recognition
+      type: {task_type}  # Required. Example: automatic-speech-recognition
+      name: {task_name}  # Optional. Example: Speech Recognition
     dataset:
-      name: {dataset_name}  # Example: Common Voice zh-CN
-      type: {dataset_type}  # Example: common_voice
-      args: {arg_0}  # Example: zh-CN
+      type: {dataset_type}  # Required. Example: common_voice. Use dataset id from https://hf.co/datasets
+      name: {dataset_name}  # Required. Example: Common Voice zh-CN
+      args: {arg_0}         # Optional. Example: zh-CN
     metrics:
-      - name: {metric_name}  # Example: Test WER
-        type: {metric_type}  # Example: wer
-        value: {metric_value}  # Example: 20.90
-        args: {arg_0}  # Example for BLEU: max_order
+      - type: {metric_type}    # Required. Example: wer
+        value: {metric_value}  # Required. Example: 20.90
+        name: {metric_name}    # Optional. Example: Test WER
+        args: {arg_0}          # Optional. Example for BLEU: max_order
 ---
 ```
 
 None of the fields are required - but any added field will improve the discoverability of your model and open it to features such as the inference API. You can find more information on repos and model cards [here](/docs/hub/model-repos#model-card-metadata).
 
+When present, and only then, 'model-index', 'datasets' and 'license' contents will be verified when git pushing changes to your README.me file.
+Valid license identifiers can be found in [our docs](/docs/hub/model-repos#list-of-license-identifiers)
+
 ## Setting up the Inference API
 
 ### Docker image

modelcard.md

@@ -2,7 +2,7 @@
 language:
 - {lang_0}  # Example: fr
 - {lang_1}  # Example: en
-license: {license}  # Example: apache-2.0
+license: {license}  # Example: apache-2.0 or any license from https://huggingface.co/docs/hub/model-repos#list-of-license-identifiers
 tags:
 - {tag_0}  # Example: audio
 - {tag_1}  # Example: automatic-speech-recognition
@@ -31,4 +31,6 @@ model-index:
         args: {arg_0}          # Optional. Example for BLEU: max_order
 ---
 
-This markdown file contains the spec for the modelcard metadata regarding evaluation parameters.
+This markdown file contains the spec for the modelcard metadata regarding evaluation parameters.
+When present, and only then, 'model-index', 'datasets' and 'license' contents will be verified when git pushing changes to your README.me file.
+Valid license identifiers can be found in [our docs](https://huggingface.co/docs/hub/model-repos#list-of-license-identifiers)