maom commited on
Commit
c07119d
·
verified ·
1 Parent(s): 1a52aab

Update sections/04_create_dataset_card.md

Browse files
Files changed (1) hide show
  1. sections/04_create_dataset_card.md +0 -76
sections/04_create_dataset_card.md CHANGED
@@ -81,79 +81,3 @@ The `README.md` is a markdown file that is displayed when goes to the front page
81
  <NAME/INFO OF DATASET AUTHORS>
82
 
83
 
84
- ## **5 Add Metadata to the Dataset Card**
85
-
86
- ### **Overview**
87
-
88
- A the top of the `README.md` file include metadata about the dataset in yaml format
89
-
90
- ---
91
- language: ...
92
- license: ...
93
- size_categories: ...
94
- pretty_name: '...'
95
- tags: ...
96
- dataset_summary: ...
97
- dataset_description: ...
98
- acknowledgements: ...
99
- repo: ...
100
- citation_bibtex: ...
101
- citation_apa: ...
102
- ---
103
-
104
- For the full spec, see the Dataset Card specification
105
-
106
- * [Dataset Card Documentation](https://huggingface.co/docs/hub/en/datasets-cards)
107
- * [Dataset Card Specification](https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1)
108
- * [Dataset Card Template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md)
109
-
110
- To allow the datasets to be loaded automatically through the datasets python library, additional info needs to be in the header of the README.md. It should reflect how the [repository is structured](https://huggingface.co/docs/datasets/en/repository_structure)
111
-
112
- configs:
113
- dataset_info:
114
-
115
- While it is possible to create these by hand, it highly recommended allowing it to be created automatically when uploaded via loading the dataset locally with [datasets.load\_dataset(...)](https://huggingface.co/docs/datasets/en/loading), then pushing it to the hub with [`datasets.push_to_hub(...)`](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.DatasetDict.push_to_hub)
116
-
117
- * [Example of `uploading data using push_to_hub()`](https://huggingface.co/datasets/RosettaCommons/MegaScale/blob/main/src/03.1_upload_data.py)
118
- * See below for more details about how to use `push_to_hub(...)` for different common formats
119
-
120
- ### **Metadata fields**
121
-
122
- #### License
123
-
124
- * If the dataset is licensed under an existing standard license, then use it
125
- * If it is unclear, then the authors need to be contacted for clarification
126
- * Licensing it under the Rosetta License
127
- * Add the following to the dataset card:
128
-
129
- license: other
130
- license_name: rosetta-license-1.0
131
- license_link: LICENSE.md
132
-
133
- * Upload the Rosetta [LICENSE.md](https://github.com/RosettaCommons/rosetta/blob/main/LICENSE.md) to the Dataset
134
-
135
- #### Citation
136
-
137
- * If the dataset has a DOI (e.g. associated with a published paper), use [doi2bib.org](http://doi2bib.org)
138
- * [DOI → APA converter](https://paperpile.com/t/doi-to-apa-converter/):
139
-
140
- #### tags
141
-
142
- * Standard tags for searching for HuggingFace datasets
143
- * typically:
144
-
145
- - biology
146
- - chemistry
147
-
148
- #### repo
149
-
150
- * Github, repository, figshare, etc. URL for data or project
151
-
152
- #### citation\_bibtex
153
-
154
- * Citation in bibtex format
155
- * You can use https://www.doi2bib.org/
156
-
157
- #### citation\_apa
158
-
159
- * Citation in APA format
 
81
  <NAME/INFO OF DATASET AUTHORS>
82
 
83