Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,46 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
language:
|
| 5 |
+
- {lang_0} # Example: fr
|
| 6 |
+
- {lang_1} # Example: en
|
| 7 |
+
license: {license} # Example: apache-2.0 or any license from https://hf.co/docs/hub/repositories-licenses
|
| 8 |
+
license_name: {license_name} # If license = other (license not in https://hf.co/docs/hub/repositories-licenses), specify an id for it here, like `my-license-1.0`.
|
| 9 |
+
license_link: {license_link} # If license = other, specify "LICENSE" or "LICENSE.md" to link to a file of that name inside the repo, or a URL to a remote file.
|
| 10 |
+
license_details: {license_details} # Legacy, textual description of a custom license.
|
| 11 |
+
tags:
|
| 12 |
+
- {tag_0} # Example: audio
|
| 13 |
+
- {tag_1} # Example: bio
|
| 14 |
+
- {tag_2} # Example: natural-language-understanding
|
| 15 |
+
- {tag_3} # Example: birds-classification
|
| 16 |
+
annotations_creators:
|
| 17 |
+
- {creator} # Example: crowdsourced, found, expert-generated, machine-generated
|
| 18 |
+
language_creators:
|
| 19 |
+
- {creator} # Example: crowdsourced, ...
|
| 20 |
+
language_details:
|
| 21 |
+
- {bcp47_lang_0} # Example: fr-FR
|
| 22 |
+
- {bcp47_lang_1} # Example: en-US
|
| 23 |
+
pretty_name: {pretty_name} # Example: SQuAD
|
| 24 |
+
size_categories:
|
| 25 |
+
- {number_of_elements_in_dataset} # Example: n<1K, 100K<n<1M, …
|
| 26 |
+
source_datasets:
|
| 27 |
+
- {source_dataset_0} # Example: wikipedia
|
| 28 |
+
- {source_dataset_1} # Example: laion/laion-2b
|
| 29 |
+
task_categories: # Full list at https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/pipelines.ts
|
| 30 |
+
- {task_0} # Example: question-answering
|
| 31 |
+
- {task_1} # Example: image-classification
|
| 32 |
+
task_ids:
|
| 33 |
+
- {subtask_0} # Example: extractive-qa
|
| 34 |
+
- {subtask_1} # Example: multi-class-image-classification
|
| 35 |
+
paperswithcode_id: {paperswithcode_id} # Dataset id on PapersWithCode (from the URL). Example for SQuAD: squad
|
| 36 |
+
configs: # Optional. This can be used to pass additional parameters to the dataset loader, such as `data_files`, `data_dir`, and any builder-specific parameters
|
| 37 |
+
- config_name: {config_name_0} # Name of the dataset subset, if applicable. Example: default
|
| 38 |
+
data_files:
|
| 39 |
+
- split: {split_name_0} # Example: train
|
| 40 |
+
path: {file_path_0} # Example: data.csv
|
| 41 |
+
- split: {split_name_1} # Example: test
|
| 42 |
+
path: {file_path_1} # Example: holdout.csv
|
| 43 |
+
- config_name: {config_name_1} # Name of the dataset subset. Example: processed
|
| 44 |
+
data_files:
|
| 45 |
+
- split: {split_name_3} # Example: train
|
| 46 |
+
path: {file_path_3} # Example: data_processed.csv
|