isaac0x53 commited on
Commit
7b1ee7f
·
verified ·
1 Parent(s): d7fa0f3

Update model card with hwmix CER/WER (50-sample eval)

Browse files
Files changed (1) hide show
  1. README.md +53 -184
README.md CHANGED
@@ -1,210 +1,79 @@
1
  ---
2
- base_model: unsloth/qwen3-vl-2b-instruct-unsloth-bnb-4bit
3
  library_name: peft
4
- pipeline_tag: text-generation
 
5
  tags:
6
- - base_model:adapter:unsloth/qwen3-vl-2b-instruct-unsloth-bnb-4bit
 
 
7
  - lora
8
- - sft
9
- - transformers
10
- - trl
11
  - unsloth
 
12
  ---
13
 
14
- # Model Card for Model ID
15
 
16
- <!-- Provide a quick summary of what the model is/does. -->
17
 
 
18
 
 
 
 
 
19
 
20
- ## Model Details
21
 
22
- ### Model Description
23
 
24
- <!-- Provide a longer summary of what this model is. -->
 
 
 
25
 
 
26
 
 
27
 
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
 
36
- ### Model Sources [optional]
37
 
38
- <!-- Provide the basic links for the model. -->
39
 
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
 
 
 
 
 
43
 
44
- ## Uses
45
 
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
 
48
- ### Direct Use
49
 
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
 
52
- [More Information Needed]
 
 
53
 
54
- ### Downstream Use [optional]
55
 
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
-
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Contact
206
-
207
- [More Information Needed]
208
- ### Framework versions
209
-
210
- - PEFT 0.20.0
 
1
  ---
2
+ base_model: unsloth/Qwen3-VL-2B-Instruct
3
  library_name: peft
4
+ license: apache-2.0
5
+ pipeline_tag: image-text-to-text
6
  tags:
7
+ - arabic
8
+ - ocr
9
+ - qwen3-vl
10
  - lora
 
 
 
11
  - unsloth
12
+ - document-ai
13
  ---
14
 
15
+ # Alhazen-OCR
16
 
17
+ QLoRA adapter on [`unsloth/Qwen3-VL-2B-Instruct`](https://huggingface.co/unsloth/Qwen3-VL-2B-Instruct) for Arabic institutional OCR: printed forms, invoices, and handwriting-heavy pages.
18
 
19
+ Named after Ibn al-Haytham (Alhazen), the 11th-century scholar who founded the science of optics.
20
 
21
+ - **Base:** Qwen3-VL-2B-Instruct (Apache-2.0)
22
+ - **Training data:** [`context212/context212-alhazen-ocr`](https://huggingface.co/datasets/context212/context212-alhazen-ocr)
23
+ - **Code:** [`github.com/context212/atlas-ocr`](https://github.com/context212/atlas-ocr)
24
+ - **Experiment sibling:** [`context212/alhazen-ocr-hwmix`](https://huggingface.co/context212/alhazen-ocr-hwmix) (same weights; promoted here after KHATT improved)
25
 
26
+ ## Results
27
 
28
+ CER / WER (lower is better), greedy decoding, **50 samples** each on the held-out eval split and on external [`ahmedheakl/arocrbench_khatt`](https://huggingface.co/datasets/ahmedheakl/arocrbench_khatt):
29
 
30
+ | Model | Eval CER | Eval WER | KHATT CER ↓ | KHATT WER ↓ |
31
+ |---|---:|---:|---:|---:|
32
+ | Qwen3-VL-2B-Instruct (base) | 0.792 | 0.947 | 1.893 | 1.801 |
33
+ | **Alhazen-OCR** | **0.281** | **0.448** | **1.121** | **1.215** |
34
 
35
+ Held-out character error drops from **0.79 → 0.28**. On external KHATT handwriting, CER/WER also improve versus the untuned base (**1.89 → 1.12** CER) — the previous synthetic-heavy mix had *regressed* on KHATT; this release uses a handwriting-heavier mix (~45% KHATT paragraphs, ~35% synthetic printed, ~20% invoices, plus a small historical set; KHATT-bench transcript overlap removed from train).
36
 
37
+ ## Training
38
 
39
+ - **Objective:** QLoRA SFT, one epoch (second epoch previously diverged)
40
+ - **LR:** 2e-5 cosine, warmup 5%
41
+ - **Effective batch:** 16 (8 × grad accum 2) on A100 80GB
42
+ - **LoRA:** r=16, RSLoRA, vision + language layers
43
+ - **Mix:** handwriting-heavy rebuild of `context212/context212-alhazen-ocr` (~15k rows after mix)
 
 
44
 
45
+ ## Usage
46
 
47
+ Serve the base with the adapter attached (vLLM example):
48
 
49
+ ```bash
50
+ vllm serve Qwen/Qwen3-VL-2B-Instruct \
51
+ --enable-lora \
52
+ --lora-modules alhazen=context212/alhazen-ocr \
53
+ --limit-mm-per-prompt '{"image": 1}' \
54
+ --mm-processor-cache-gb 0 \
55
+ --no-enable-prefix-caching
56
+ ```
57
 
58
+ Prompt:
59
 
60
+ > Extract all the text from this image, preserving the original reading order.
61
 
62
+ Keep `temperature=0` for transcription.
63
 
64
+ ## Limitations
65
 
66
+ - Tuned for Arabic institutional paperwork; not a general multilingual OCR.
67
+ - KHATT remains harder than printed forms — scores above 1.0 CER mean many lines are still wrong.
68
+ - Eval above is capped at 50 samples per split; treat as directional until a full-split rerun.
69
 
70
+ ## Citation
71
 
72
+ ```bibtex
73
+ @misc{alhazen-ocr-2026,
74
+ title = {Alhazen-OCR},
75
+ author = {Context212},
76
+ year = {2026},
77
+ howpublished = {\url{https://huggingface.co/context212/alhazen-ocr}}
78
+ }
79
+ ```