-
Notifications
You must be signed in to change notification settings - Fork 556
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Dataset card template overhaul (#1708)
* Dataset card template overhaul * Add Privacy Considerations subsection * Apply suggestions from code review Co-authored-by: meg <90473723+meg-huggingface@users.noreply.github.com> * Address more comments --------- Co-authored-by: meg <90473723+meg-huggingface@users.noreply.github.com> Co-authored-by: Lucain <lucainp@gmail.com>
- Loading branch information
1 parent
f752932
commit 6dd7ee8
Showing
3 changed files
with
90 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,103 +1,143 @@ | ||
--- | ||
# For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1 | ||
# For reference on dataset card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1 | ||
# Doc / guide: https://huggingface.co/docs/hub/datasets-cards | ||
{{ card_data }} | ||
--- | ||
|
||
# Dataset Card for {{ pretty_name | default("Dataset Name", true) }} | ||
|
||
## Dataset Description | ||
<!-- Provide a quick summary of the dataset. --> | ||
|
||
- **Homepage:** {{ homepage_url | default("", true)}} | ||
- **Repository:** {{ repo_url | default("", true)}} | ||
- **Paper:** {{ paper_url | default("", true)}} | ||
- **Leaderboard:** {{ leaderboard_url | default("", true)}} | ||
- **Point of Contact:** {{ point_of_contact | default("", true)}} | ||
{{ dataset_summary | default("", true) }} | ||
|
||
### Dataset Summary | ||
## Dataset Details | ||
|
||
{{ dataset_summary | default("[More Information Needed]", true)}} | ||
### Dataset Description | ||
|
||
### Supported Tasks and Leaderboards | ||
<!-- Provide a longer summary of what this dataset is. --> | ||
|
||
{{ supported_tasks_and_leaderboards_section | default("[More Information Needed]", true)}} | ||
{{ dataset_description | default("", true) }} | ||
|
||
### Languages | ||
- **Curated by:** {{ curators | default("[More Information Needed]", true)}} | ||
- **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}} | ||
- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}} | ||
- **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}} | ||
- **License:** {{ license | default("[More Information Needed]", true)}} | ||
|
||
{{ languages_section | default("[More Information Needed]", true)}} | ||
### Dataset Sources [optional] | ||
|
||
## Dataset Structure | ||
<!-- Provide the basic links for the dataset. --> | ||
|
||
- **Repository:** {{ repo | default("[More Information Needed]", true)}} | ||
- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}} | ||
- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}} | ||
|
||
## Uses | ||
|
||
### Data Instances | ||
<!-- Address questions around how the dataset is intended to be used. --> | ||
|
||
{{ data_instances_section | default("[More Information Needed]", true)}} | ||
### Direct Use | ||
|
||
### Data Fields | ||
<!-- This section describes suitable use cases for the dataset. --> | ||
|
||
{{ data_fields_section | default("[More Information Needed]", true)}} | ||
{{ direct_use | default("[More Information Needed]", true)}} | ||
|
||
### Data Splits | ||
### Out-of-Scope Use | ||
|
||
{{ data_splits_section | default("[More Information Needed]", true)}} | ||
<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. --> | ||
|
||
{{ out_of_scope_use | default("[More Information Needed]", true)}} | ||
|
||
## Dataset Structure | ||
|
||
<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. --> | ||
|
||
{{ dataset_structure | default("[More Information Needed]", true)}} | ||
|
||
## Dataset Creation | ||
|
||
### Curation Rationale | ||
|
||
<!-- Motivation for the creation of this dataset. --> | ||
|
||
{{ curation_rationale_section | default("[More Information Needed]", true)}} | ||
|
||
### Source Data | ||
|
||
#### Initial Data Collection and Normalization | ||
<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). --> | ||
|
||
#### Data Collection and Processing | ||
|
||
<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. --> | ||
|
||
{{ data_collection_section | default("[More Information Needed]", true)}} | ||
{{ data_collection_and_processing_section | default("[More Information Needed]", true)}} | ||
|
||
#### Who are the source language producers? | ||
#### Who are the source data producers? | ||
|
||
{{ source_language_producers_section | default("[More Information Needed]", true)}} | ||
<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. --> | ||
|
||
### Annotations | ||
{{ source_data_producers_section | default("[More Information Needed]", true)}} | ||
|
||
### Annotations [optional] | ||
|
||
<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. --> | ||
|
||
#### Annotation process | ||
|
||
<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. --> | ||
|
||
{{ annotation_process_section | default("[More Information Needed]", true)}} | ||
|
||
#### Who are the annotators? | ||
|
||
<!-- This section describes the people or systems who created the annotations. --> | ||
|
||
{{ who_are_annotators_section | default("[More Information Needed]", true)}} | ||
|
||
### Personal and Sensitive Information | ||
#### Personal and Sensitive Information | ||
|
||
<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. --> | ||
|
||
{{ personal_and_sensitive_information | default("[More Information Needed]", true)}} | ||
|
||
## Bias, Risks, and Limitations | ||
|
||
<!-- This section is meant to convey both technical and sociotechnical limitations. --> | ||
|
||
{{ bias_risks_limitations | default("[More Information Needed]", true)}} | ||
|
||
### Recommendations | ||
|
||
{{ personal_and_sensitive_information_section | default("[More Information Needed]", true)}} | ||
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. --> | ||
|
||
## Considerations for Using the Data | ||
{{ bias_recommendations | default("Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.", true)}} | ||
|
||
### Social Impact of Dataset | ||
## Citation [optional] | ||
|
||
{{ social_impact_section | default("[More Information Needed]", true)}} | ||
<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. --> | ||
|
||
### Discussion of Biases | ||
**BibTeX:** | ||
|
||
{{ discussion_of_biases_section | default("[More Information Needed]", true)}} | ||
{{ citation_bibtex | default("[More Information Needed]", true)}} | ||
|
||
### Other Known Limitations | ||
**APA:** | ||
|
||
{{ known_limitations_section | default("[More Information Needed]", true)}} | ||
{{ citation_apa | default("[More Information Needed]", true)}} | ||
|
||
## Additional Information | ||
## Glossary [optional] | ||
|
||
### Dataset Curators | ||
<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. --> | ||
|
||
{{ dataset_curators_section | default("[More Information Needed]", true)}} | ||
{{ glossary | default("[More Information Needed]", true)}} | ||
|
||
### Licensing Information | ||
## More Information [optional] | ||
|
||
{{ licensing_information_section | default("[More Information Needed]", true)}} | ||
{{ more_information | default("[More Information Needed]", true)}} | ||
|
||
### Citation Information | ||
## Dataset Card Authors [optional] | ||
|
||
{{ citation_information_section | default("[More Information Needed]", true)}} | ||
{{ dataset_card_authors | default("[More Information Needed]", true)}} | ||
|
||
### Contributions | ||
## Dataset Card Contact | ||
|
||
{{ contributions_section | default("[More Information Needed]", true)}} | ||
{{ dataset_card_contact | default("[More Information Needed]", true)}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters