Update sections/04_create_dataset_card.md
Browse files
sections/04_create_dataset_card.md
CHANGED
|
@@ -85,20 +85,21 @@ The `README.md` is a markdown file that is displayed when goes to the front page
|
|
| 85 |
|
| 86 |
### **Overview**
|
| 87 |
|
| 88 |
-
A the top of the
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
|
|
|
| 102 |
|
| 103 |
For the full spec, see the Dataset Card specification
|
| 104 |
|
|
@@ -107,13 +108,14 @@ For the full spec, see the Dataset Card specification
|
|
| 107 |
* [Dataset Card Template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md)
|
| 108 |
|
| 109 |
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)
|
| 110 |
-
configs:
|
| 111 |
-
dataset\_info:
|
| 112 |
|
| 113 |
-
|
|
|
|
| 114 |
|
| 115 |
-
|
| 116 |
-
|
|
|
|
|
|
|
| 117 |
|
| 118 |
### **Metadata fields**
|
| 119 |
|
|
@@ -125,10 +127,8 @@ While it is possible to create these by hand, it highly recommended allowing it
|
|
| 125 |
* Add the following to the dataset card:
|
| 126 |
|
| 127 |
license: other
|
| 128 |
-
|
| 129 |
-
|
| 130 |
-
|
| 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 |
|
|
@@ -142,9 +142,8 @@ While it is possible to create these by hand, it highly recommended allowing it
|
|
| 142 |
* Standard tags for searching for HuggingFace datasets
|
| 143 |
* typically:
|
| 144 |
|
| 145 |
-
|
| 146 |
-
|
| 147 |
-
\- chemistry
|
| 148 |
|
| 149 |
#### repo
|
| 150 |
|
|
|
|
| 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 |
|
|
|
|
| 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 |
|
|
|
|
| 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 |
|
|
|
|
| 142 |
* Standard tags for searching for HuggingFace datasets
|
| 143 |
* typically:
|
| 144 |
|
| 145 |
+
- biology
|
| 146 |
+
- chemistry
|
|
|
|
| 147 |
|
| 148 |
#### repo
|
| 149 |
|