Duplicate from KLOBIP/OBIMD

Co-authored-by: yeyu <ghost0hand@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,63 @@
+*.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
+data.json filter=lfs diff=lfs merge=lfs -text
+Sub-character[[:space:]]to[[:space:]]Transcription[[:space:]]Mapping.xlsx filter=lfs diff=lfs merge=lfs -text
+Hierarchical[[:space:]]Character[[:space:]]Metadata[[:space:]]Supplement/Sub-character[[:space:]]to[[:space:]]Transcription[[:space:]]Mapping.xlsx filter=lfs diff=lfs merge=lfs -text
+Hierarchical[[:space:]]Character[[:space:]]Metadata[[:space:]]Supplement/Sub-character[[:space:]]to[[:space:]]Glyph[[:space:]]Code[[:space:]]Point[[:space:]]Mapping.xlsx filter=lfs diff=lfs merge=lfs -text

Hierarchical Character Metadata Supplement/Sub-character Images.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:55c53522e0d328ffcf7ff9da5a963c1193d03bae9f841a4028fbe4d0427f39fb
+size 40436910

Hierarchical Character Metadata Supplement/Sub-character to Glyph Code Point Mapping.xlsx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f8e0bd8b810565c5f2642f40d534aa4f35976d1edc27ee96829c151060aeb76c
+size 668208

LICENSE

@@ -0,0 +1,3 @@
+Creative Commons Attribution 4.0 International
+
+You must give appropriate credit to the author(s).

OBIMD.py

@@ -0,0 +1,88 @@
+import json
+import os
+from datasets import DatasetInfo, BuilderConfig, GeneratorBasedBuilder, SplitGenerator, \
+    Split, Features, Value, Sequence, Image
+import zipfile
+
+class OBIMDConfig(BuilderConfig):
+    def __init__(self, **kwargs):
+        super().__init__(version="1.0.0", **kwargs)
+
+
+class OBIMDDataset(GeneratorBasedBuilder):
+    BUILDER_CONFIGS = [
+        OBIMDConfig(name="default", description="Oracle bone OBIMD dataset."),
+    ]
+
+    def _info(self):
+        return DatasetInfo(
+            description="Paired images of oracle bone rubbings and facsimiles with annotations.",
+            features=Features({
+                "Facsimile": Image(),
+                "Rubbing": Image(),
+                "RubbingName": Value("string"),
+                "RecordUtilSentenceGroupVoList": Sequence({
+                    "GroupCategory": Value("string"),
+                    "RecordUtilOracleCharVoList": Sequence({
+                        "Position": Value("string"),
+                        "OrderNumber": Value("int32"),
+                        "SeatFont": Value("int32"),
+                        "Mark": Value("int32"),
+                        "Label": Value("string"),
+                        "SubLabel": Value("string"),
+                    }),
+                }),
+            }),
+            supervised_keys=None,
+        )
+
+    def _split_generators(self, dl_manager):
+        if os.path.exists(self.base_path):
+            data_dir = self.base_path
+        else:
+            data_dir = dl_manager.download_and_extract(self.config.data_dir or ".")
+
+        return [
+            SplitGenerator(
+                name=Split.TRAIN,
+                gen_kwargs={
+                    "filepath": os.path.join(data_dir, "data.json"),
+                    "base_path": data_dir,
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepath, base_path):
+        with open(filepath, encoding="utf-8") as f:
+            data = json.load(f)
+        with zipfile.ZipFile(os.path.join(base_path, "rubbing.zip"), 'r') as rubbing_ref:
+            with zipfile.ZipFile(os.path.join(base_path, "facsimile.zip"), 'r') as facsimile_ref:
+                for idx, item in enumerate(data):
+                    
+                    with rubbing_ref.open(item["Rubbing"]) as file:
+                        rubbing_content = file.read()
+                    with facsimile_ref.open(item["Facsimile"]) as file:
+                        facsimile_content = file.read()
+                        
+                    yield idx, {
+                        "Facsimile": facsimile_content,
+                        "Rubbing": rubbing_content,
+                        "RubbingName": item["RubbingName"],
+                        "RecordUtilSentenceGroupVoList": [
+                            {
+                                "GroupCategory": group["GroupCategory"],
+                                "RecordUtilOracleCharVoList": [
+                                    {
+                                        "Position": char["Position"],
+                                        "OrderNumber": char["OrderNumber"],
+                                        "SeatFont": char["SeatFont"],
+                                        "Mark": char["Mark"],
+                                        "Label": char["Label"],
+                                        "SubLabel": char["SubLabel"],
+                                    }
+                                    for char in group["RecordUtilOracleCharVoList"]
+                                ],
+                            }
+                            for group in item["RecordUtilSentenceGroupVoList"]
+                        ],
+                    }

README.md

@@ -0,0 +1,91 @@
+---
+license: cc-by-4.0
+---
+# Oracle Bone Inscriptions Multi-modal Dataset (OBIMD)
+
+## Dataset Overview
+
+The Oracle Bone Inscriptions Multi-modal Dataset (OBIMD) is the first large-scale corpus providing pixel-aligned rubbings and facsimiles, character-level annotations, and sentence-level transcriptions and reading sequences for oracle bone inscription (OBI) research. This dataset enables multi-modal learning across visual, structural, and linguistic dimensions, laying the foundation for end-to-end OBI recognition and interpretation.
+<p align="center">
+<img src="figures/overview.png" alt="图片" width="80%" height="80%">
+</p>
+
+
+## Dataset Statistics
+
+- Total OBI images: 10,077 across five Shang Dynasty phases
+- Annotated characters: 93,652
+- Missing character positions: 21,667 (due to fragmentation)
+- Sentences: 21,941 syntactically validated
+- Non-sentential elements: 4,192
+
+## Data Structure
+
+The dataset follows a three-level hierarchy:
+
+1. Image-level: Contains rubbing and facsimile pairs
+2. Sentence-level: Groups characters into meaningful units
+3. Character-level: Detailed annotations for each character
+![图片](figures/data%20structure.png)
+
+## Data Fields
+
+|Field Name|Description|Example|
+|-|-|-|
+|Facsimile|Path to facsimile image|facsimile/h00002.jpg|
+|Rubbing|Path to rubbing image|rubbing/h00002.jpg|
+|RubbingName|Short identifier|H2|
+|GroupCategory|Sentence type|InscriptionSentence1|
+|Position|Bounding box (x,y,w,h)|558,581,80,218| 
+|OrderNumber|Character order in sentence|5|
+|Label|Main character label|xkubtjk815|
+|SubLabel|Secondary label|xkubtjk815|
+|SeatFont|Placeholder indicator|0|
+|Mark|Special marker|-1|
+
+## Data Modalities
+
+1. Rubbing images: Original scanned images of oracle bones
+2. Facsimile images: Expert reconstructions aligned with rubbings
+3. Character annotations: Bounding boxes and classifications
+4. Sentence groupings: Semantic organization of characters
+5. Reading sequences: Order of characters within sentences
+![图片](figures/pipeline%20for%20constructing.png)
+
+## Hierarchical Character Metadata Supplement
+
+This folder contains supporting materials for the character hierarchy used in OBIMD. It includes:
+
+1. Sub-character Images: Images of sub-character variants, stored in a two-level folder structure. The top-level directory is named by the main character UID, and each subfolder is named by the corresponding sub-character UID.
+2. Sub-character to Glyph Code Point Mapping (XLSX): Maps each sub-character UID to the platform-specific glyph code point used by the Oracular Digital Platform font.
+3. Sub-character to Main-character Mapping (XLSX): Maps each sub-character UID to its parent main character UID in the Oracular Digital Platform.
+4. Main-character → Reference Modern Character (JSON): For each main-character UID, the JSON provides a platform-provided reference modern Chinese character (a standardized surrogate used for lookup and navigation). Note: this mapping is for reference only and is not intended as a final philological interpretation, since oracle bone inscriptions decipherment remains ongoing.
+
+## Usage Notes
+
+The dataset is designed to support various research tasks:
+
+- Character detection and recognition
+- Sentence-level character clustering
+- Character reordering within sentences
+- Multi-modal analysis (rubbing vs. facsimile)
+
+## License
+
+This model is licensed under CC-BY 4.0.
+
+## Citation
+
+If you use this dataset in your research, please cite:
+
+<!-- ```bibtex
+@article{li2024obimd,
+  title={Oracle Bone Inscriptions Multi-modal Dataset},
+  author={Li, Bang and Luo, Donghao and Liang, Yujie and others},
+  journal={arXiv preprint arXiv:2407.03900},
+  year={2024},
+  url={https://doi.org/10.48550/arXiv.2407.03900}
+}
+```
+## License
+The dataset is released for academic research purposes only. Commercial use requires special permission from the authors. -->

data.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b504b0d4e7a0126d494c161f5445c5ee4225659ff5e94182685fce35d261aa19
+size 41732948

facsimile.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b1544e34ee1a6a34fc0a83475a227fd2141a67293f795eaa3c52760fedb50b0e
+size 210800641

rubbing.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4d07dca94e94c2d17edd7fa25be72b5673161c0c2d03dac4d2c094e5341b7747
+size 558367972