Sou-Cheng commited on
Commit
5d9022a
·
verified ·
1 Parent(s): b461b70

Upload sc/03_README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. sc/03_README.md +80 -0
sc/03_README.md ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Great — here’s exactly **where to put your README.md** so that Hugging Face uses it as your **dataset card**.
2
+
3
+ ---
4
+
5
+ # 📌 Where to put `README.md` for Hugging Face Datasets
6
+
7
+ Hugging Face treats the **root-level `README.md`** of your dataset repository as the **Dataset Card**.
8
+
9
+ This means:
10
+
11
+ ### ✅ **Place `README.md` in the root directory of your LDData folder**, e.g.:
12
+
13
+ ```
14
+ LDData/
15
+ ├── README.md ← put it here
16
+ ├── generating-vectors/
17
+ ├── generating-matrices/
18
+ ├── examples/
19
+ ├── some-file.txt
20
+ └── upload.py
21
+ ```
22
+
23
+ Your local folder should look like the above before running:
24
+
25
+ ```bash
26
+ python upload.py --repo-id QMCSoftware/LDData
27
+ ```
28
+
29
+ The `upload_folder` API automatically uploads that file as:
30
+
31
+ ```
32
+ https://huggingface.co/datasets/QMCSoftware/LDData/blob/main/README.md
33
+ ```
34
+
35
+ …which becomes the dataset’s **front-page description**.
36
+
37
+ ---
38
+
39
+ # What if you already have a README.md?
40
+
41
+ Perfect — the existing one can be **used as the dataset card**, or I can help you **rewrite it in HF Dataset Card format** with recommended sections:
42
+
43
+ ### **Hugging Face Dataset Card Template**
44
+
45
+ I can create a polished `README.md` using the structure:
46
+
47
+ * Title + Summary
48
+ * Dataset Description
49
+ * Motivation & Citation
50
+ * Data Structure
51
+ * File Format Details
52
+ * How to Load with `datasets`
53
+ * Links to your paper (ArXiv 2502.14256)
54
+ * Benchmarks or usage examples
55
+ * License
56
+ * Acknowledgements
57
+
58
+ Similar to:
59
+
60
+ * Meta Omnilingual ASR Corpus
61
+ * NVIDIA PhysicalAI
62
+ * Moondream RefCOCO-m
63
+
64
+ 📌 Just say:
65
+
66
+ > “Generate a dataset card README.md for LDData.”
67
+
68
+ …and I’ll do the whole draft for you.
69
+
70
+ ---
71
+
72
+ If you want, I can generate:
73
+
74
+ ### ✔️ A polished dataset card
75
+
76
+ ### ✔️ A lightweight minimal one
77
+
78
+ ### ✔️ Or a fully detailed professional one
79
+
80
+ Which style do you want?