Upload 4 files
Browse files- README.md +55 -0
- dataset.py +159 -0
- dataset_infos.json +26 -0
- metadata_sample.jsonl +24 -0
README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
tags:
|
| 4 |
+
- dataset
|
| 5 |
+
- document-ocr
|
| 6 |
+
- text-tabular
|
| 7 |
+
---
|
| 8 |
+
|
| 9 |
+
# Document OCR Text Tabular Data Notes
|
| 10 |
+
|
| 11 |
+
## Dataset summary
|
| 12 |
+
|
| 13 |
+
Preparation notes and schema examples for **Document OCR** tasks using **Text Tabular** data. Full source material is intentionally not bundled, so provenance and licensing remain explicit.
|
| 14 |
+
|
| 15 |
+
## Included material
|
| 16 |
+
|
| 17 |
+
- `dataset.py` — loading, cleaning, and split preparation code.
|
| 18 |
+
- `dataset_infos.json` — schema and split metadata.
|
| 19 |
+
- `metadata_sample.jsonl` — small, human-readable records for checking the schema.
|
| 20 |
+
- `README.md` — data card and usage notes.
|
| 21 |
+
|
| 22 |
+
## Processing choices
|
| 23 |
+
|
| 24 |
+
| Stage | Setting |
|
| 25 |
+
|---|---|
|
| 26 |
+
| Storage format | npy sharded |
|
| 27 |
+
| Preprocessing | minimal |
|
| 28 |
+
| Augmentation | mixup cutmix |
|
| 29 |
+
| Split strategy | stratified 90 10 |
|
| 30 |
+
| Sampling | balanced |
|
| 31 |
+
| Quality checks | strict |
|
| 32 |
+
| Labeling | pseudo label |
|
| 33 |
+
|
| 34 |
+
## Validation checklist
|
| 35 |
+
|
| 36 |
+
Before using the prepared data, verify source licenses, duplicates across splits, missing values, label balance, and modality-specific corruption. Record the source version and every filtering rule so a later run can reproduce the same rows.
|
| 37 |
+
|
| 38 |
+
## Intended use
|
| 39 |
+
|
| 40 |
+
The repository is suitable for testing the data pipeline, adapting it to a documented source, and preparing controlled research splits. Release status: **metadata sample; full source data not bundled**. The sample is for schema inspection only and should not be reported as a full training corpus.
|
| 41 |
+
|
| 42 |
+
## Risks and limitations
|
| 43 |
+
|
| 44 |
+
The loader cannot guarantee that an external source is representative, correctly licensed, or free of sensitive information. Users remain responsible for source review, privacy checks, and bias analysis before training or redistribution.
|
| 45 |
+
|
| 46 |
+
## Files
|
| 47 |
+
|
| 48 |
+
- `dataset.py` — primary artifact
|
| 49 |
+
- `README.md` — this documentation
|
| 50 |
+
- `dataset_infos.json` — schema metadata
|
| 51 |
+
- `metadata_sample.jsonl` — schema sample
|
| 52 |
+
|
| 53 |
+
## License
|
| 54 |
+
|
| 55 |
+
Released under **apache-2.0**. Review the source-data terms separately when this repository is used with external datasets.
|
dataset.py
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import json, os, hashlib, logging
|
| 2 |
+
from pathlib import Path
|
| 3 |
+
|
| 4 |
+
log = logging.getLogger(__name__)
|
| 5 |
+
|
| 6 |
+
# --- real data source: document_ocr ---
|
| 7 |
+
TV_DATASET = None
|
| 8 |
+
HF_CANDIDATES = ['nielsr/funsd', 'aharley/rvl_cdip']
|
| 9 |
+
IMAGE_FIELD = 'image'
|
| 10 |
+
TEXT_FIELD = 'words'
|
| 11 |
+
LABEL_FIELD = 'label'
|
| 12 |
+
PROMPT_TEMPLATE = 'a photo of a {label}'
|
| 13 |
+
DATASET_URL = 'https://guillaumejaume.github.io/FUNSD/'
|
| 14 |
+
|
| 15 |
+
def fetch_real_samples(max_samples=5000, cache_dir='./_cache'):
|
| 16 |
+
# 本地没有数据时自动下载真实公开数据集: torchvision -> HuggingFace -> 手动说明
|
| 17 |
+
out = []
|
| 18 |
+
if TV_DATASET is not None:
|
| 19 |
+
try:
|
| 20 |
+
import torchvision
|
| 21 |
+
ctor = getattr(torchvision.datasets, TV_DATASET)
|
| 22 |
+
try:
|
| 23 |
+
ds = ctor(root=cache_dir, split='train', download=True)
|
| 24 |
+
except TypeError:
|
| 25 |
+
try:
|
| 26 |
+
ds = ctor(root=cache_dir, train=True, download=True)
|
| 27 |
+
except TypeError:
|
| 28 |
+
ds = ctor(root=cache_dir, download=True)
|
| 29 |
+
classes = getattr(ds, 'classes', None)
|
| 30 |
+
os.makedirs(os.path.join(cache_dir, 'tv'), exist_ok=True)
|
| 31 |
+
for i, item in enumerate(ds):
|
| 32 |
+
if len(out) >= max_samples:
|
| 33 |
+
break
|
| 34 |
+
img, label = item[0], item[1]
|
| 35 |
+
name = classes[label] if classes else str(label)
|
| 36 |
+
p = os.path.join(cache_dir, 'tv', str(i) + '.png')
|
| 37 |
+
try:
|
| 38 |
+
img.save(p)
|
| 39 |
+
except Exception:
|
| 40 |
+
continue
|
| 41 |
+
out.append({'image': p, 'text': PROMPT_TEMPLATE.format(label=name)})
|
| 42 |
+
if out:
|
| 43 |
+
return out
|
| 44 |
+
except Exception as e:
|
| 45 |
+
print('torchvision load failed:', e)
|
| 46 |
+
for repo in HF_CANDIDATES:
|
| 47 |
+
try:
|
| 48 |
+
from datasets import load_dataset
|
| 49 |
+
try:
|
| 50 |
+
ds = load_dataset(repo, split='train', streaming=True)
|
| 51 |
+
except Exception:
|
| 52 |
+
ds = load_dataset(repo, split='train')
|
| 53 |
+
img_dir = os.path.join(cache_dir, 'hf_images')
|
| 54 |
+
os.makedirs(img_dir, exist_ok=True)
|
| 55 |
+
for i, ex in enumerate(ds):
|
| 56 |
+
if len(out) >= max_samples:
|
| 57 |
+
break
|
| 58 |
+
txt = None
|
| 59 |
+
if TEXT_FIELD is not None and TEXT_FIELD in ex:
|
| 60 |
+
v = ex[TEXT_FIELD]
|
| 61 |
+
txt = v if isinstance(v, str) else ' '.join(map(str, v if isinstance(v, (list, tuple)) else [v]))
|
| 62 |
+
if txt is None and LABEL_FIELD in ex:
|
| 63 |
+
txt = PROMPT_TEMPLATE.format(label=ex[LABEL_FIELD])
|
| 64 |
+
if txt is None:
|
| 65 |
+
continue
|
| 66 |
+
if IMAGE_FIELD not in ex or ex[IMAGE_FIELD] is None:
|
| 67 |
+
continue
|
| 68 |
+
p = os.path.join(img_dir, str(i) + '.jpg')
|
| 69 |
+
try:
|
| 70 |
+
ex[IMAGE_FIELD].convert('RGB').save(p)
|
| 71 |
+
except Exception:
|
| 72 |
+
continue
|
| 73 |
+
out.append({'image': p, 'text': txt})
|
| 74 |
+
if out:
|
| 75 |
+
return out
|
| 76 |
+
except Exception as e:
|
| 77 |
+
print('HF load failed for', repo, ':', e)
|
| 78 |
+
print('Automatic download failed. Please get the data manually from:')
|
| 79 |
+
print(' ' + DATASET_URL)
|
| 80 |
+
return out
|
| 81 |
+
|
| 82 |
+
|
| 83 |
+
def load(data_dir):
|
| 84 |
+
|
| 85 |
+
files = list(Path(data_dir).glob('*.jsonl'))
|
| 86 |
+
if not files:
|
| 87 |
+
files = list(Path(data_dir).glob('*.json'))
|
| 88 |
+
samples = []
|
| 89 |
+
for f in files:
|
| 90 |
+
with open(f, encoding="utf-8") as fp:
|
| 91 |
+
if f.suffix == '.json':
|
| 92 |
+
d = json.load(fp)
|
| 93 |
+
samples.extend(d if isinstance(d, list) else [d])
|
| 94 |
+
else:
|
| 95 |
+
samples.extend(json.loads(l) for l in fp if l.strip())
|
| 96 |
+
return samples
|
| 97 |
+
|
| 98 |
+
def filter_quality(samples, min_score=0.5):
|
| 99 |
+
|
| 100 |
+
results = []
|
| 101 |
+
for s in samples:
|
| 102 |
+
text = s.get("document_ocr", s.get("text", ""))
|
| 103 |
+
if len(text.split()) >= 3:
|
| 104 |
+
results.append(s)
|
| 105 |
+
return results
|
| 106 |
+
|
| 107 |
+
def dedup(samples):
|
| 108 |
+
seen = set()
|
| 109 |
+
out = []
|
| 110 |
+
for s in samples:
|
| 111 |
+
fp = s.get("image", s.get("audio", ""))
|
| 112 |
+
if fp and os.path.exists(fp):
|
| 113 |
+
h = hashlib.md5(open(fp, 'rb').read()).hexdigest()
|
| 114 |
+
if h in seen:
|
| 115 |
+
continue
|
| 116 |
+
seen.add(h)
|
| 117 |
+
out.append(s)
|
| 118 |
+
return out
|
| 119 |
+
|
| 120 |
+
def preprocess(samples, out_dir, img_size=224):
|
| 121 |
+
# 预处理
|
| 122 |
+
os.makedirs(out_dir, exist_ok=True)
|
| 123 |
+
processed = []
|
| 124 |
+
for s in samples:
|
| 125 |
+
item = {}
|
| 126 |
+
if "image" in s:
|
| 127 |
+
try:
|
| 128 |
+
from PIL import Image as IM
|
| 129 |
+
img = IM.open(s["image"]).convert("RGB")
|
| 130 |
+
img = img.resize((img_size, img_size))
|
| 131 |
+
p = os.path.join(out_dir, os.path.basename(s["image"]))
|
| 132 |
+
img.save(p, "JPEG", quality=95)
|
| 133 |
+
item["image"] = p
|
| 134 |
+
except Exception:
|
| 135 |
+
continue
|
| 136 |
+
text = s.get("document_ocr", s.get("text", ""))
|
| 137 |
+
item["text"] = text
|
| 138 |
+
item["domain"] = "document_ocr"
|
| 139 |
+
processed.append(item)
|
| 140 |
+
return processed
|
| 141 |
+
|
| 142 |
+
def save_jsonl(data, path):
|
| 143 |
+
with open(path, 'w', encoding="utf-8") as f:
|
| 144 |
+
for d in data:
|
| 145 |
+
f.write(json.dumps(d, ensure_ascii=False) + '\n')
|
| 146 |
+
|
| 147 |
+
def main():
|
| 148 |
+
import sys
|
| 149 |
+
data_dir = sys.argv[1] if len(sys.argv) > 1 else './data'
|
| 150 |
+
out = sys.argv[2] if len(sys.argv) > 2 else './output'
|
| 151 |
+
samples = load(data_dir) or fetch_real_samples()
|
| 152 |
+
samples = filter_quality(samples)
|
| 153 |
+
samples = dedup(samples)
|
| 154 |
+
result = preprocess(samples, out)
|
| 155 |
+
save_jsonl(result, os.path.join(out, 'dataset.jsonl'))
|
| 156 |
+
print(f'Done: {len(result)} samples')
|
| 157 |
+
|
| 158 |
+
if __name__ == '__main__':
|
| 159 |
+
main()
|
dataset_infos.json
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"description": "Metadata sample and preparation pipeline for document_ocr / text_tabular data",
|
| 3 |
+
"features": {
|
| 4 |
+
"id": {
|
| 5 |
+
"dtype": "string"
|
| 6 |
+
},
|
| 7 |
+
"description": {
|
| 8 |
+
"dtype": "string"
|
| 9 |
+
},
|
| 10 |
+
"label": {
|
| 11 |
+
"dtype": "int64"
|
| 12 |
+
},
|
| 13 |
+
"domain": {
|
| 14 |
+
"dtype": "string"
|
| 15 |
+
},
|
| 16 |
+
"modality": {
|
| 17 |
+
"dtype": "string"
|
| 18 |
+
}
|
| 19 |
+
},
|
| 20 |
+
"splits": {
|
| 21 |
+
"sample": {
|
| 22 |
+
"num_examples": 24
|
| 23 |
+
}
|
| 24 |
+
},
|
| 25 |
+
"release_status": "metadata sample; full source data not bundled"
|
| 26 |
+
}
|
metadata_sample.jsonl
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{"id": "sample-001", "description": "schema validation example", "label": 0, "domain": "document_ocr", "modality": "text_tabular"}
|
| 2 |
+
{"id": "sample-002", "description": "quality-control example", "label": 1, "domain": "document_ocr", "modality": "text_tabular"}
|
| 3 |
+
{"id": "sample-003", "description": "split inspection example", "label": 2, "domain": "document_ocr", "modality": "text_tabular"}
|
| 4 |
+
{"id": "sample-004", "description": "label review example", "label": 3, "domain": "document_ocr", "modality": "text_tabular"}
|
| 5 |
+
{"id": "sample-005", "description": "deduplication example", "label": 0, "domain": "document_ocr", "modality": "text_tabular"}
|
| 6 |
+
{"id": "sample-006", "description": "format conversion example", "label": 1, "domain": "document_ocr", "modality": "text_tabular"}
|
| 7 |
+
{"id": "sample-007", "description": "schema validation example", "label": 2, "domain": "document_ocr", "modality": "text_tabular"}
|
| 8 |
+
{"id": "sample-008", "description": "quality-control example", "label": 3, "domain": "document_ocr", "modality": "text_tabular"}
|
| 9 |
+
{"id": "sample-009", "description": "split inspection example", "label": 0, "domain": "document_ocr", "modality": "text_tabular"}
|
| 10 |
+
{"id": "sample-010", "description": "label review example", "label": 1, "domain": "document_ocr", "modality": "text_tabular"}
|
| 11 |
+
{"id": "sample-011", "description": "deduplication example", "label": 2, "domain": "document_ocr", "modality": "text_tabular"}
|
| 12 |
+
{"id": "sample-012", "description": "format conversion example", "label": 3, "domain": "document_ocr", "modality": "text_tabular"}
|
| 13 |
+
{"id": "sample-013", "description": "schema validation example", "label": 0, "domain": "document_ocr", "modality": "text_tabular"}
|
| 14 |
+
{"id": "sample-014", "description": "quality-control example", "label": 1, "domain": "document_ocr", "modality": "text_tabular"}
|
| 15 |
+
{"id": "sample-015", "description": "split inspection example", "label": 2, "domain": "document_ocr", "modality": "text_tabular"}
|
| 16 |
+
{"id": "sample-016", "description": "label review example", "label": 3, "domain": "document_ocr", "modality": "text_tabular"}
|
| 17 |
+
{"id": "sample-017", "description": "deduplication example", "label": 0, "domain": "document_ocr", "modality": "text_tabular"}
|
| 18 |
+
{"id": "sample-018", "description": "format conversion example", "label": 1, "domain": "document_ocr", "modality": "text_tabular"}
|
| 19 |
+
{"id": "sample-019", "description": "schema validation example", "label": 2, "domain": "document_ocr", "modality": "text_tabular"}
|
| 20 |
+
{"id": "sample-020", "description": "quality-control example", "label": 3, "domain": "document_ocr", "modality": "text_tabular"}
|
| 21 |
+
{"id": "sample-021", "description": "split inspection example", "label": 0, "domain": "document_ocr", "modality": "text_tabular"}
|
| 22 |
+
{"id": "sample-022", "description": "label review example", "label": 1, "domain": "document_ocr", "modality": "text_tabular"}
|
| 23 |
+
{"id": "sample-023", "description": "deduplication example", "label": 2, "domain": "document_ocr", "modality": "text_tabular"}
|
| 24 |
+
{"id": "sample-024", "description": "format conversion example", "label": 3, "domain": "document_ocr", "modality": "text_tabular"}
|