Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alignment on modelcard metadata specification #39

Merged
merged 3 commits into from
May 21, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions modelcard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
language:
- {lang_0} # Example: fr
- {lang_1} # Example: en
license: {license} # Example: apache-2.0
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
metrics:
- {metric_0} # Example: wer

model-index:
- name: {model_id}
results:
- task:
name: {task_name} # Example: Speech Recognition
type: {task_type} # Example: automatic-speech-recognition
dataset:
name: {dataset_name} # Example: Common Voice zh-CN
type: {dataset_type} # Example: common_voice
args: {arg_0} # 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
---

This markdown file contains the spec for the modelcard metadata regarding evaluation parameters.