Commit ·
0ba95fe
1
Parent(s): 4c07ad8
upload from github
Browse files- model_card_metadata +44 -0
model_card_metadata
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- {lang_0} # Example: fr
|
| 4 |
+
- {lang_1} # Example: en
|
| 5 |
+
license: {license} # Example: apache-2.0 or any license from https://hf.co/docs/hub/repositories-licenses
|
| 6 |
+
library_name: {library_name} # Optional. Example: keras or any library from https://github.com/huggingface/hub-docs/blob/main/js/src/lib/interfaces/Libraries.ts
|
| 7 |
+
tags:
|
| 8 |
+
- {tag_0} # Example: audio
|
| 9 |
+
- {tag_1} # Example: automatic-speech-recognition
|
| 10 |
+
- {tag_2} # Example: speech
|
| 11 |
+
- {tag_3} # Example to specify a library: allennlp
|
| 12 |
+
datasets:
|
| 13 |
+
- {dataset_0} # Example: common_voice. Use dataset id from https://hf.co/datasets
|
| 14 |
+
metrics:
|
| 15 |
+
- {metric_0} # Example: wer. Use metric id from https://hf.co/metrics
|
| 16 |
+
|
| 17 |
+
# Optional. Add this if you want to encode your eval results in a structured way.
|
| 18 |
+
model-index:
|
| 19 |
+
- name: {model_id}
|
| 20 |
+
results:
|
| 21 |
+
- task:
|
| 22 |
+
type: {task_type} # Required. Example: automatic-speech-recognition
|
| 23 |
+
name: {task_name} # Optional. Example: Speech Recognition
|
| 24 |
+
dataset:
|
| 25 |
+
type: {dataset_type} # Required. Example: common_voice. Use dataset id from https://hf.co/datasets
|
| 26 |
+
name: {dataset_name} # Required. A pretty name for the dataset. Example: Common Voice (French)
|
| 27 |
+
config: {dataset_config} # 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
|
| 28 |
+
split: {dataset_split} # Optional. Example: test
|
| 29 |
+
revision: {dataset_revision} # Optional. Example: 5503434ddd753f426f4b38109466949a1217c2bb
|
| 30 |
+
args:
|
| 31 |
+
{arg_0}: {value_0} # Optional. Additional arguments to `load_dataset()`. Example for wikipedia: language: en
|
| 32 |
+
{arg_1}: {value_1} # Optional. Example for wikipedia: date: 20220301
|
| 33 |
+
metrics:
|
| 34 |
+
- type: {metric_type} # Required. Example: wer. Use metric id from https://hf.co/metrics
|
| 35 |
+
value: {metric_value} # Required. Example: 20.90
|
| 36 |
+
name: {metric_name} # Optional. Example: Test WER
|
| 37 |
+
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
|
| 38 |
+
args:
|
| 39 |
+
{arg_0}: {value_0} # Optional. The arguments passed during `Metric.compute()`. Example for `bleu`: max_order: 4
|
| 40 |
+
verified: true # Optional. If true, indicates that evaluation was generated by Hugging Face (vs. self-reported).
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
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.md file.
|
| 44 |
+
Valid license identifiers can be found in [our docs](https://huggingface.co/docs/hub/repositories-licenses)
|