oddadmix commited on
Commit
ea280e6
·
verified ·
1 Parent(s): d64bf11

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -21
README.md CHANGED
@@ -30,14 +30,25 @@ Qaari 0.1 Urdu is a fine-tuned version of [Qwen/Qwen2-VL-2B](https://huggingface
30
  | vs. Qwen Base | 97.35% | 98.32% | 91.55% |
31
  | vs. Tesseract | 86.25% | 87.11% | 82.60% |
32
 
33
- ## Use Cases
34
 
35
- - Document digitization for Urdu texts
36
- - Historical manuscript preservation
37
- - Automated data entry from Urdu documents
38
- - Academic research on Urdu texts
39
- - Government document processing
40
- - Digital libraries for Urdu literature
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
  ## Usage
43
 
@@ -64,10 +75,12 @@ print(text)
64
 
65
  ## Limitations
66
 
67
- - Designed specifically for Urdu text recognition; may not perform optimally for other languages
68
- - Performance may vary with image quality, font styles, and background noise
69
- - Works best with clear, well-lit images of printed Urdu text
70
- - May struggle with handwritten Urdu text with significant variations
 
 
71
 
72
  ## Training Details
73
 
@@ -76,15 +89,14 @@ This model was fine-tuned from Qwen2-VL-2B using a dataset of Urdu text images w
76
  ### Training Dataset
77
 
78
  - **Dataset Type**: Paired Urdu text images with ground truth transcriptions
79
- - **Size**: [Insert dataset size]
80
- - **Source**: [Insert source information if public]
81
 
82
  ### Training Configuration
83
 
84
  - **Base Model**: Qwen/Qwen2-VL-2B
85
- - **Training Framework**: [Insert framework used, e.g., HuggingFace Transformers]
86
- - **Hardware**: [Insert training hardware details]
87
- - **Training Time**: [Insert approximate training time]
88
 
89
  ## Citation
90
 
@@ -92,11 +104,11 @@ If you use this model in your research, please cite:
92
 
93
  ```
94
  @misc{qaari-0.1-urdu,
95
- author = {[Your name]},
96
  title = {Qaari 0.1 Urdu: OCR Model for Urdu Language},
97
  year = {2025},
98
  publisher = {HuggingFace},
99
- howpublished = {\url{https://huggingface.co/your-username/qaari-0.1-urdu}}
100
  }
101
  ```
102
 
@@ -104,6 +116,3 @@ If you use this model in your research, please cite:
104
 
105
  This model is subject to the [license terms](https://huggingface.co/Qwen/Qwen2-VL-2B/blob/main/LICENSE) of the base Qwen2-VL-2B model.
106
 
107
- ## Contact
108
-
109
- [Your contact information or preferred way for users to reach out with questions or feedback]
 
30
  | vs. Qwen Base | 97.35% | 98.32% | 91.55% |
31
  | vs. Tesseract | 86.25% | 87.11% | 82.60% |
32
 
 
33
 
34
+ ## Supported Fonts
35
+ The model was fine-tuned on the following fonts:
36
+ - AlQalam Taj Nastaleeq Regular
37
+ - Alvi Nastaleeq Regular
38
+ - Gandhara Suls Regular
39
+ - Jameel Noori Nastaleeq Regular
40
+ - NotoNastaliqUrdu-Regular
41
+
42
+ ## Supported Font Sizes
43
+ The model has been tested and optimized for the following font sizes:
44
+ - 14pt
45
+ - 16pt
46
+ - 18pt
47
+ - 20pt
48
+ - 24pt
49
+ - 32pt
50
+ - 40pt
51
+
52
 
53
  ## Usage
54
 
 
75
 
76
  ## Limitations
77
 
78
+ - Performance may degrade when using fonts not included in the fine-tuning dataset
79
+ - Font sizes outside the supported range may result in suboptimal rendering
80
+ - The model may not handle complex ligatures in non-Nastaleeq scripts effectively
81
+ - Performance on digital-only displays has not been fully optimized
82
+ - Low-resolution print environments might experience quality degradation
83
+ - Custom font modifications or non-standard Nastaleeq variants might not render as expected
84
 
85
  ## Training Details
86
 
 
89
  ### Training Dataset
90
 
91
  - **Dataset Type**: Paired Urdu text images with ground truth transcriptions
92
+ - **Size**: 10,000
93
+ - **Source**: Syntehtic Dataset
94
 
95
  ### Training Configuration
96
 
97
  - **Base Model**: Qwen/Qwen2-VL-2B
98
+ - **Hardware**: A6000 GPU
99
+ - **Training Time**: 24 Hours
 
100
 
101
  ## Citation
102
 
 
104
 
105
  ```
106
  @misc{qaari-0.1-urdu,
107
+ author = {Ahmed Wasfy},
108
  title = {Qaari 0.1 Urdu: OCR Model for Urdu Language},
109
  year = {2025},
110
  publisher = {HuggingFace},
111
+ howpublished = {\url{https://huggingface.co/oddadmix/Qaari-0.1-Urdu-OCR-Qwen2VL-2B}}
112
  }
113
  ```
114
 
 
116
 
117
  This model is subject to the [license terms](https://huggingface.co/Qwen/Qwen2-VL-2B/blob/main/LICENSE) of the base Qwen2-VL-2B model.
118