Update README.md

README.md

@@ -34,3 +34,80 @@ configs:
   - split: train
     path: uncleaned/train-*
 ---
+
+# Burmese OCR Dataset (Hugging Face Format)
+
+This is a reformatted version of [alexbeatson/burmese_ocr_data](https://huggingface.co/datasets/alexbeatson/burmese_ocr_data) converted into the native Hugging Face datasets format for easier loading and integration with modern OCR training pipelines.
+
+## Dataset Description
+
+This dataset contains Burmese text images and their corresponding ground truth text extracted from real-life documents, suitable for training Optical Character Recognition (OCR) models.
+
+### Source
+
+The original data was curated from the [Burma Library](https://www.burmalibrary.org/) archive, which collects and preserves government and NGO documents. Documents were processed using Google Document AI to extract text and bounding boxes, then cropped into single-line text images.
+
+## Dataset Structure
+
+The dataset consists of two subsets:
+
+| Subset | Samples | Description |
+|--------|---------|-------------|
+| `cleaned` | 9,065 | Manually validated by two individuals. Some errors may still be present. |
+| `uncleaned` | 162,863 | Raw images from Google Document AI output, without manual review. |
+
+### Features
+
+- `image`: Single-line text image in PNG format (RGB)
+- `text`: Corresponding ground truth text
+
+## Usage
+```python
+from datasets import load_dataset
+
+# Load the cleaned subset
+cleaned = load_dataset("chuuhtetnaing/burmese_ocr_dataset_hf", "cleaned")
+
+# Load the uncleaned subset
+uncleaned = load_dataset("chuuhtetnaing/burmese_ocr_dataset_hf", "uncleaned")
+
+# Load both subsets
+dataset = load_dataset("chuuhtetnaing/burmese_ocr_dataset_hf")
+
+# Access samples
+sample = cleaned["train"][0]
+print(sample["text"])
+sample["image"].show()
+```
+
+## Specifications
+
+- Images are in PNG format with RGB color encoding
+- Character range includes any characters supported by Google Document AI that appear in Burmese documents
+- May contain mixed scripts (Burmese with occasional English/numbers)
+
+## Training Recommendations
+
+For curriculum learning, consider training in the following order:
+1. Synthetic data (if available)
+2. `uncleaned` subset
+3. `cleaned` subset
+
+## Citation
+
+If you use this dataset, please cite the original source:
+```bibtex
+@dataset{burmese_ocr_data,
+  author = {Alex Beatson},
+  title = {Burmese OCR Data},
+  year = {2024},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/datasets/alexbeatson/burmese_ocr_data}
+}
+```
+
+## Acknowledgments
+
+- Original dataset by [alexbeatson](https://huggingface.co/alexbeatson)
+- Data sourced from [Burma Library](https://www.burmalibrary.org/)
+- Text extraction powered by Google Document AI