Update README.md

README.md

@@ -32,4 +32,154 @@ configs:
     path: data/dev-*
   - split: test
     path: data/test-*
+
+license: cc-by-nc-4.0
+datasets:
+- bpmn
+language:
+- en
+tags:
+- vision
+- multimodal
+- diagrams
+- business-process
+- bpmn
+- xml
+- vlm
+- structured-output
+- ocr
+task_categories:
+- image-to-text
+- structured-prediction
+pretty_name: BPMN Diagram ↔ BPMN XML Paired Dataset
+size_categories:
+- 1K<n<10K
 ---
+
+# 🏗️ BPMN Diagram → BPMN XML Paired Dataset  
+### Structured Extraction from Business Process Diagrams using Vision-Language Models
+
+This dataset contains **Business Process Model and Notation (BPMN)** diagrams paired with their corresponding `.bpmn` XML ground truth files.  
+The dataset is designed for **training, evaluation, and benchmarking** multimodal models that perform *structured extraction from diagrams*, including OCR-enhanced pipelines and vision-language models (VLMs).
+
+---
+
+# 📦 Dataset Contents
+
+Each example includes:
+
+| Field | Description |
+|-------|-------------|
+| `image` | BPMN diagram image (PNG/JPEG), uploaded directly to HF |
+| `bpmn` | Text content of the corresponding `.bpmn` XML file |
+| `image_filename` | Original image filename |
+| `bpmn_filename` | Original BPMN filename |
+| `split` | One of: `train`, `dev`, `test` |
+
+Folder structure used during creation:
+
+```
+dataset/
+├── train/
+│   ├── images/
+│   ├── bpmn/
+├── dev/
+│   ├── images/
+│   ├── bpmn/
+├── test/
+    ├── images/
+    ├── bpmn/
+```
+
+---
+
+# 🖼️ Example Images
+
+Replace these after dataset upload:
+
+### **Example 1**
+![Example BPMN Image](examples/process_001.png)
+
+### Ground Truth BPMN (excerpt)
+```xml
+<definitions ... >
+    <process id="Process_1">
+        ...
+    </process>
+</definitions>
+```
+
+---
+
+# 🔧 Usage
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("pritamdeka/BPMN-VLM")
+
+example = ds["train"][0]
+
+image = example["image"]               # PIL image object
+bpmn_text = example["bpmn"]           # XML content as string
+image_name = example["image_filename"]
+bpmn_name = example["bpmn_filename"]
+```
+
+---
+
+# 🎯 Applications
+
+This dataset is suitable for:
+
+- BPMN diagram understanding and parsing  
+- OCR + VLM multimodal pipelines  
+- Structured JSON extraction  
+- Diagram-to-XML reconstruction  
+- Fine-tuning Pixtral, Qwen2-VL, LLaMA 3.2 Vision, Aya Vision, Phi multimodal, Gemma-VLM  
+- Evaluation against ground truth `.bpmn` files  
+
+Ideal for research in:
+
+- Vision-language reasoning  
+- Diagram understanding  
+- Business process modelling automation  
+
+---
+
+# 📜 Citation
+
+If you use this dataset, please cite:
+
+```bibtex
+@misc{deka2025structuredextractionbusinessprocess,
+      title={Structured Extraction from Business Process Diagrams Using Vision-Language Models}, 
+      author={Pritam Deka and Barry Devereux},
+      year={2025},
+      eprint={2511.22448},
+      archivePrefix={arXiv},
+      primaryClass={cs.AI},
+      url={https://arxiv.org/abs/2511.22448}, 
+}
+```
+
+---
+
+# 📄 License
+
+This dataset is released under **CC BY-NC 4.0** —  
+You may use it for **research and non-commercial purposes** with attribution.
+
+---
+
+# 🙏 Acknowledgements
+
+Developed at the **Advanced Research Centre (ARC), Queen’s University Belfast**, as part of research into multimodal structured extraction from business process diagrams.
+
+---
+
+# 📬 Contact
+
+For questions, contact:  
+**Pritam Deka** — *p.deka@qub.ac.uk*
+