PetraAI commited on
Commit
c00fecb
1 Parent(s): 8175596

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +90 -1
README.md CHANGED
@@ -1,3 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # PETRA
2
 
3
  ## Overview
@@ -99,4 +159,33 @@ You can also add dataset metadata to your card. The metadata describes important
99
 
100
  ## Dataset card metadata
101
 
102
- A dataset repo will render its README.md as a dataset card. To control how the Hub displays the card, you should create a YAML section in the README file to define some metadata. Start by adding three --- at the top, then include all of the relevant metadata, and close the section with another group of --- like the example below:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ task_categories:
4
+ - text-classification
5
+ - token-classification
6
+ - table-question-answering
7
+ - question-answering
8
+ - zero-shot-classification
9
+ - translation
10
+ - summarization
11
+ - conversational
12
+ - feature-extraction
13
+ - text-generation
14
+ - text2text-generation
15
+ - fill-mask
16
+ - sentence-similarity
17
+ - text-to-speech
18
+ - automatic-speech-recognition
19
+ - audio-to-audio
20
+ - audio-classification
21
+ - voice-activity-detection
22
+ - depth-estimation
23
+ - image-classification
24
+ - object-detection
25
+ - image-segmentation
26
+ - text-to-image
27
+ - image-to-text
28
+ - image-to-image
29
+ - unconditional-image-generation
30
+ - video-classification
31
+ - reinforcement-learning
32
+ - robotics
33
+ - tabular-classification
34
+ - tabular-regression
35
+ - tabular-to-text
36
+ - table-to-text
37
+ - multiple-choice
38
+ - text-retrieval
39
+ - time-series-forecasting
40
+ - text-to-video
41
+ - visual-question-answering
42
+ - zero-shot-image-classification
43
+ - graph-ml
44
+ language:
45
+ - ar
46
+ - en
47
+ tags:
48
+ - chemistry
49
+ - biology
50
+ - finance
51
+ - legal
52
+ - music
53
+ - art
54
+ - code
55
+ - climate
56
+ - medical
57
+ pretty_name: PETRA
58
+ size_categories:
59
+ - 1M<n<10M
60
+ ---
61
  # PETRA
62
 
63
  ## Overview
 
159
 
160
  ## Dataset card metadata
161
 
162
+ A dataset repo will render its README.md as a dataset card. To control how the Hub displays the card, you should create a YAML section in the README file to define some metadata. Start by adding three --- at the top, then include all of the relevant metadata, and close the section with another group of --- like the example below:
163
+
164
+
165
+ The metadata that you add to the dataset card enables certain interactions on the Hub. For example:
166
+
167
+ - Allow users to filter and discover datasets at https://huggingface.co/datasets.
168
+
169
+ - If you choose a license using the keywords listed in the right column of this table, the license will be displayed on the dataset page.
170
+
171
+ When creating a README.md file in a dataset repository on the Hub, use Metadata UI to fill the main metadata:
172
+
173
+ To see metadata fields, see the detailed dataset card metadata specification here.
174
+
175
+ ### Dataset card creation guide
176
+
177
+ For a step-by-step guide on creating a dataset card, check out the Create a dataset card guide.
178
+
179
+ Reading through existing dataset cards, such as the ELI5 dataset card, is a great way to familiarize yourself with the common conventions.
180
+
181
+ ### Linking a Paper
182
+
183
+ If the dataset card includes a link to a paper on arXiv, the Hub will extract the arXiv ID and include it in the dataset tags with the format `arxiv:<PAPER ID>`. Clicking on the tag will let you:
184
+
185
+ - Visit the Paper page
186
+
187
+ - Filter for other models on the Hub that cite the same paper.
188
+
189
+ Read more about paper pages here.
190
+
191
+ https://huggingface.co/docs/hub/paper-pages