rzh123 commited on
Commit
19cffd2
·
verified ·
1 Parent(s): 9a9095d

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +210 -0
README.md ADDED
@@ -0,0 +1,210 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ # Hugging Face Dataset Card 元数据(YAML frontmatter)。
3
+ # 注意:`license: mit` 是占位值,仓库尚未正式声明许可证,发布前请确认后修改。
4
+ language:
5
+ - en
6
+ - zh
7
+ license: mit
8
+ pretty_name: Numbers
9
+ task_categories:
10
+ - other
11
+ size_categories:
12
+ - n<1K
13
+ tags:
14
+ - numbers
15
+ - tabular
16
+ - multilingual
17
+ - test-fixture
18
+ configs:
19
+ - config_name: default
20
+ data_files:
21
+ - split: train
22
+ path: nums/1.json
23
+ dataset_info:
24
+ features:
25
+ - name: name
26
+ dtype: string
27
+ - name: value
28
+ dtype: int64
29
+ splits:
30
+ - name: train
31
+ num_bytes: 212
32
+ num_examples: 6
33
+ download_size: 212
34
+ dataset_size: 212
35
+ ---
36
+
37
+ # dataset-test
38
+
39
+ 一个极简的数字名称数据集,用于测试数据集仓库的结构、加载链路与 Dataset Card 渲染。
40
+
41
+ ## Dataset Description / 数据集描述
42
+
43
+ ### 数据集简介
44
+
45
+ 本仓库只包含一个数据文件 [nums/1.json](nums/1.json):它是一个 JSON 数组,每条记录把 1–6 的数字与其名称配对。
46
+ 其中 1–3 使用英文单词(`one`、`two`、`three`),4–6 使用中文汉字(`四`、`五`、`六`),因此该数据集是**英中混排**的。
47
+
48
+ - **Curated by:** 仓库维护者(见 Git 提交历史)
49
+ - **Language(s):** English (`en`), Chinese (`zh`)
50
+ - **License:** MIT(占位,待确认)
51
+ - **Size:** 6 条记录 / 1 个分片 / 212 字节
52
+
53
+ ### 支持的任务 / Supported Tasks
54
+
55
+ 该数据集**不针对任何具体建模任务**,主要用于:
56
+
57
+ - 测试 `load_dataset` 对本地 JSON 数据文件的加载;
58
+ - 测试 Dataset Card 的 YAML 元数据(`configs` / `dataset_info`)能否被 Hub 正确解析;
59
+ - 作为小型多语言表格数据的最小样例(fixture)。
60
+
61
+ ### 语言 / Languages
62
+
63
+ | 记录范围 | 语言 | 说明 |
64
+ | --- | --- | --- |
65
+ | 1–3 | `en` | 英文数词(one / two / three) |
66
+ | 4–6 | `zh` | 中文数词(四 / 五 / 六) |
67
+
68
+ ## Dataset Structure / 数据集结构
69
+
70
+ ### 数据实例 / Data Instance
71
+
72
+ ```json
73
+ {"name": "one", "value": 1}
74
+ ```
75
+
76
+ ### 数据字段 / Data Fields
77
+
78
+ | 字段 | 类型 | 说明 |
79
+ | --- | --- | --- |
80
+ | `name` | `string` | 数字的名称,英文单词或中文汉字 |
81
+ | `value` | `int64` | 对应的阿拉伯数字数值 |
82
+
83
+ ### 数据划分 / Data Splits
84
+
85
+ | Split | 文件 | 记录数 | 字节数 |
86
+ | --- | --- | --- | --- |
87
+ | `train` | [nums/1.json](nums/1.json) | 6 | 212 |
88
+
89
+ > 目前不存在验证集/测试集;全部数据都归入 `train`。上表中的 `num_bytes` / `dataset_size` 记录的是**源文件大小**,Hub 在转换后显示的 Arrow 文件大小可能与之略有差异。
90
+
91
+ ## Dataset Creation / 数据集构建
92
+
93
+ ### 数据来源
94
+
95
+ 数据由仓库维护者手工录入,没有外部数据源、爬取或派生过程。
96
+
97
+ ### 标注 / 处理流程
98
+
99
+ 无标注环节。唯一的人工约定是:每个数字使用一种语言的名称书写,1–3 用英文、4–6 用中文。
100
+
101
+ ### 个人隐私信息
102
+
103
+ 不含任何个人信息,也不含敏感内容。
104
+
105
+ ## Usage / 使用方式
106
+
107
+ ### 通过 Hugging Face `datasets` 加载
108
+
109
+ ```python
110
+ from datasets import load_dataset
111
+
112
+ ds = load_dataset("json", data_files="nums/1.json", split="train")
113
+ print(ds)
114
+ # Dataset({
115
+ # features: ['name', 'value'],
116
+ # num_rows: 6
117
+ # })
118
+
119
+ print(ds[:3])
120
+ # {'name': ['one', 'two', 'three'], 'value': [1, 2, 3]}
121
+ ```
122
+
123
+ 如果仓库已推送到 Hub,也可以直接加载:
124
+
125
+ ```python
126
+ ds = load_dataset("<your-username>/dataset-test", split="train")
127
+ ```
128
+
129
+ ### 不依赖第三方库
130
+
131
+ ```python
132
+ import json
133
+
134
+ with open("nums/1.json", encoding="utf-8") as f:
135
+ records = json.load(f) # list[dict[str, str | int]]
136
+
137
+ print(len(records)) # 6
138
+ ```
139
+
140
+ ### 仓库结构 / Repository Layout
141
+
142
+ ```text
143
+ dataset-test/
144
+ ├── README.md # 本文件,顶部为 Hugging Face Dataset Card 元数据
145
+ └── nums/
146
+ └── 1.json # 唯一的数据分片,JSON 数组
147
+ ```
148
+
149
+ ### 校验与扩展 / Validation & Adding Data
150
+
151
+ `nums/*.json` 的约定是:**UTF-8 编码的 JSON 数组**,每个元素都是含且仅含 `name`(string)与 `value`(int)两个键的对象。
152
+ 新增分片时,请同步更新本文件顶部 YAML 中的 `configs.data_files`、`dataset_info.splits` 与 `num_bytes` 等字段。
153
+
154
+ 快速校验:
155
+
156
+ ```bash
157
+ python - <<'PY'
158
+ import json, pathlib
159
+
160
+ for p in sorted(pathlib.Path("nums").glob("*.json")):
161
+ data = json.loads(p.read_text(encoding="utf-8"))
162
+ assert isinstance(data, list) and data, f"{p}: 需要非空数组"
163
+ for i, row in enumerate(data):
164
+ assert set(row) == {"name", "value"}, f"{p}[{i}]: 字段应为 name/value"
165
+ assert isinstance(row["name"], str), f"{p}[{i}]: name 必须是字符串"
166
+ assert isinstance(row["value"], int) and not isinstance(row["value"], bool), f"{p}[{i}]: value 必须是整数"
167
+ print(f"{p}: OK ({len(data)} 条)")
168
+ PY
169
+ ```
170
+
171
+ ### 推送到 Hub / Pushing to the Hub
172
+
173
+ ```bash
174
+ hf upload <your-username>/dataset-test . --repo-type dataset
175
+ ```
176
+
177
+ ## Considerations for Using the Data / 使用注意事项
178
+
179
+ ### 已知局限
180
+
181
+ - **语言不统一**:同一列 `name` 中混用了英文单词与中文汉字,直接用于模型训练或评测会产生标签体系不一致的问题。
182
+ - **规模极小**:仅 6 条记录,任何统计结论都不可靠,仅适合作为冒烟测试或格式 fixture。
183
+ - **无重复值检查之外的约束**:数据未声明 `value` 的唯一性/连续性保证,扩展时需自行约定。
184
+
185
+ ### 社会影响
186
+
187
+ 数据规模与内容都不足以产生社会影响,仅用于工程测试。
188
+
189
+ ## Additional Information / 附加信息
190
+
191
+ ### 许可 / Licensing
192
+
193
+ 仓库暂未正式声明许可证,卡片中的 `license: mit` 为占位值。若要以 MIT 发布,请在仓库根目录补充 `LICENSE` 文件;否则请把 YAML 中的字段改为实际许可证标识(例如 `apache-2.0`、`cc-by-4.0` 或 `other`)。
194
+
195
+ ### 引用 / Citation
196
+
197
+ 暂无关联论文,无需引用。若需在作品中标明来源,请引用本仓库:
198
+
199
+ ```bibtex
200
+ @misc{dataset-test,
201
+ title = {dataset-test: a minimal numbers dataset},
202
+ author = {Repository maintainers},
203
+ note = {Git repository},
204
+ year = {2026}
205
+ }
206
+ ```
207
+
208
+ ### 贡献 / Contributing
209
+
210
+ 这是一个测试仓库,欢迎通过 Issue 或 Pull Request 提交修正。修改数据时请遵守上文「校验与扩展」中的格式约定,并同步更新 Dataset Card 元数据。