upload README.md

README.md

@@ -1,3 +1,113 @@
 ---
 license: apache-2.0
+tags:
+- hanzi
+- chinese-characters
+- ocr
+- image-classification
+- webdataset
 ---
+
+# GlyphHan：跨历史来源汉字表征数据集
+
+> **状态：🚧 正在陆续打包上传中**
+>
+> 本仓库正在分批上传中（预计 688 个分片，约 687 GB）。上传进度实时可见于 `shards/` 目录，全部完成后将更新本说明并附上最终统计。
+
+## 数据集简介
+
+GlyphHan 是一个大规模汉字单字图像数据集，包含 **1 亿张**汉字字形图像，覆盖 **34,452 个**汉字与部首字形（含 CJK 扩展区、繁简异体等）。图像源自多个历史文献数字化项目，涵盖不同年代、字体与扫描条件，是汉字表征学习（字形识别、OCR、字体生成、古籍数字化研究等）的优质数据资源。
+
+## 规模与统计
+
+| 指标 | 数值 |
+|---|---|
+| 图像总数 | 100,019,698 张 |
+| 字符数 | 34,452 个 |
+| 单字图像数 | 中位数 59 张 / 最大 127,235 张（"不"） |
+| 数据总量 | 约 687 GB（tar 未压缩） |
+| 分片数 | 688 个（约 1 GB/片） |
+| 图像格式 | PNG（尺寸不一，源自不同扫描源） |
+
+## 目录结构
+
+```
+GlyphHan/
+├── README.md                  # 本文件
+├── labels.jsonl               # 完整标签（约 5 GB）：字符级元数据（权威主文件）
+├── shard_manifest.jsonl       # 分片清单：每片包含哪些字符
+├── checksums.txt              # 原始/修复后标签文件的 sha256
+└── shards/
+    ├── shard-000000.tar       # 每片约 1 GB，未压缩
+    ├── shard-000001.tar
+    └── ...
+```
+
+### labels.jsonl 格式
+
+每行一个字符对象：
+
+```json
+{"glyph":"安","unicode":"U+5B89","total":72239,
+ "sources":{"2_M5HisDoc":436, ...},
+ "images":[{"path":"安/00000001.png","source":"2_M5HisDoc"}, ...]}
+```
+
+- `glyph` / `unicode`：汉字字形及其码位
+- `total`：该字符图像总数
+- `sources`：按来源统计的图像数量
+- `images[].path`：相对仓库根目录的图片路径
+- `images[].source`：该图来源
+
+### tar 分片格式
+
+每个 `shard-*.tar` 内部：
+
+```
+shard-000000.tar
+├── metadata.jsonl             # 该片涉及字符的原始标签行（字符级完整）
+├── 安/00000001.png
+├── 安/00000002.png
+└── ...                        # 其余字符目录
+```
+
+> **打包保证**：单字的所有图像完整落在同一分片内，**不会跨片拆分**。使用 `labels.jsonl` 或 `shard_manifest.jsonl` 即可定位任意字符所在分片。
+
+## 数据来源
+
+图像来自多个历史文献数字化项目（`sources` 字段标注每个字符的图源），包括：
+
+- HisDoc1B（V1~V6，历史文档字符数据集）
+- M5HisDoc、STUST EECS MNIST、EVOBC、MCCD、AHCDB、TKHMTH2200、HCSU
+- 台湾研究院数据集、kkanji、mao、shidianguji_V1 等
+
+## 使用示例
+
+### 流式读取（webdataset，推荐）
+
+```python
+import webdataset as wds
+
+url = ("https://huggingface.co/datasets/MYTH-Lab/GlyphHan/resolve/main/"
+       "shards/shard-{000000..000687}.tar")
+ds = wds.WebDataset(url).decode("pil")
+for sample in ds:
+    image = sample["png"]      # PIL.Image
+    # 字符标签: 通过 labels.jsonl 或同片 metadata.jsonl 关联
+```
+
+### 按字符定位分片
+
+```bash
+# 从 shard_manifest.jsonl 查字符所在分片
+grep '"不"' shard_manifest.jsonl
+# 然后下载对应分片
+```
+
+## 许可
+
+Apache-2.0
+
+## 引用
+
+数据集持续完善中，正式引用信息将在上传完成后于本 README 更新。