Add README and git-lfs configuration

.gitattributes

@@ -1,59 +1,4 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.lz4 filter=lfs diff=lfs merge=lfs -text
-*.mds filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
-# Audio files - uncompressed
-*.pcm filter=lfs diff=lfs merge=lfs -text
-*.sam filter=lfs diff=lfs merge=lfs -text
-*.raw filter=lfs diff=lfs merge=lfs -text
-# Audio files - compressed
-*.aac filter=lfs diff=lfs merge=lfs -text
-*.flac filter=lfs diff=lfs merge=lfs -text
-*.mp3 filter=lfs diff=lfs merge=lfs -text
-*.ogg filter=lfs diff=lfs merge=lfs -text
-*.wav filter=lfs diff=lfs merge=lfs -text
-# Image files - uncompressed
-*.bmp filter=lfs diff=lfs merge=lfs -text
-*.gif filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
-*.tiff filter=lfs diff=lfs merge=lfs -text
-# Image files - compressed
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
-*.webp filter=lfs diff=lfs merge=lfs -text
-# Video files - compressed
-*.mp4 filter=lfs diff=lfs merge=lfs -text
-*.webm filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jsonl filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,78 @@
+---
+language:
+- zh
+language_bcp47:
+- zh-tw
+license: mit
+task_categories:
+- image-to-text
+- document-question-answering
+pretty_name: SynthDoG Traditional Chinese Dataset
+size_categories:
+- 10K<n<100K
+tags:
+- ocr
+- synthetic-data
+- traditional-chinese
+---
+
+# SynthDoG Traditional Chinese Dataset
+
+This dataset contains synthetic document-ground truth pairs for Traditional Chinese text recognition training. The dataset is generated using the SynthDoG (Synthetic Document Generation) framework, which creates realistic document images with Traditional Chinese text.
+
+## Dataset Structure
+
+The dataset is organized into three splits:
+- `train/`: Training data
+- `validation/`: Validation data
+- `test/`: Test data
+
+Each split contains:
+- Image files (*.jpg): Synthetic document images with Traditional Chinese text
+- metadata.jsonl: Ground truth annotations for each image in JSONL format
+
+## File Format
+
+### Images
+- Format: JPEG
+- Resolution: Various sizes, optimized for document recognition
+- Content: Synthetic documents with Traditional Chinese text
+- Features: Includes various document layouts, fonts, and text styles
+
+### Annotations (metadata.jsonl)
+The metadata file contains annotations for each image in JSONL format, including:
+- Text content
+- Text regions
+- Layout information
+
+## Usage
+
+This dataset is designed for:
+1. Training OCR models for Traditional Chinese text recognition
+2. Fine-tuning document understanding models
+3. Testing document layout analysis systems
+
+### Loading the Dataset
+You can load this dataset using the Hugging Face datasets library:
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("LeeTung/synthdoc-zh-tw-dataset")
+```
+
+## License
+
+MIT License. Please refer to the original SynthDoG repository for additional license information.
+
+## Citation
+
+If you use this dataset in your research, please cite the original SynthDoG paper and this dataset:
+
+```bibtex
+@misc{synthdoc-zh-tw-dataset,
+  title={SynthDoG Traditional Chinese Dataset},
+  author={Lee Tung},
+  year={2024},
+  publisher={Hugging Face}
+}
+```