scb10x
/

typhoon-ocr1.5-3b-qat

@@ -1,199 +1,124 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+language:
+  - en
+  - th
+base_model:
+  - Qwen/Qwen2.5-VL-3B
+tags:
+  - OCR
+  - vision-language
+  - document-understanding
+  - multilingual
+  - QAT
+license: apache-2.0
 ---
+# Typhoon-OCR-1.5-3B-QAT
+A quantization-aware trained (QAT) version of [**Typhoon OCR v1.5**](https://huggingface.co/scb10x/typhoon-ocr1.5-2b), designed for robust and efficient on-device vision-language OCR in English and Thai.
+This release maintains strong accuracy while significantly improving performance when running under low-bit quantization (e.g., 4-bit), making it ideal for lightweight environments.
+This model is released in **bfloat16** and is intended to be used as the **pre-quantization base** before converting to low-bit formats.
+For the 4-bit model, please use the Ollama build here:
+**https://ollama.com/scb10x/typhoon-ocr1.5-3b**
+QAT is applied on top of **Qwen2.5-VL-3B**, enabling improved stability and reduced degradation when deployed below 16-bit precision.
+**4-bit Ollama version:** https://ollama.com/scb10x/typhoon-ocr1.5-3b
+**Base FP16 model:** https://huggingface.co/scb10x/typhoon-ocr1.5-2b
+**Try our demo available on [Demo](https://ocr.opentyphoon.ai/)**
+**Code / Examples available on [Github](https://github.com/scb-10x/typhoon-ocr)**
+**Release Blog available on [OpenTyphoon Blog](https://opentyphoon.ai/blog/en/typhoon-ocr-release)**
+---
+## Highlights
+- **Quantization-Aware Training (QAT):** Maintains strong OCR accuracy even under aggressive quantization.
+- **Optimized for On-Device Inference:** Faster and more consistent performance on low-resource hardware.
+- **Enhanced Handwriting & Form Parsing:** Retains the v1.5 improvements in handling handwritten notes, forms, irregular layouts, and structured documents.
+- **Supports Text-Rich & Image-Rich Documents:** Effective on tables, diagrams, annotated pages, charts, receipts, and dense reports.
+- **Thai + English Multilingual OCR:** Trained for reliable extraction across bilingual real-world documents.
+---
+## Intended Use
+This is a **task-specific OCR model** and is intended to be used **only with the provided prompt format**.
+It does **not** include general VQA or safety guardrails.
+Some hallucination may still occur, and users should validate outputs for production scenarios.
+---
+## Quick Links
+- **Demo:** https://ocr.opentyphoon.ai
+- **Code / Examples:** https://github.com/scb-10x/typhoon-ocr
+- **Release Blog:** https://opentyphoon.ai/blog/en/typhoon-ocr-release
+---
+## Prompting
+```python
+prompt = """Extract all text from the image.
+Instructions:
+- Only return the clean Markdown.
+- Do not include any explanation or extra text.
+- You must include all information on the page.
+Formatting Rules:
+- Tables: Render tables using <table>...</table> in clean HTML format.
+- Equations: Render equations using LaTeX syntax with inline ($...$) and block ($$...$$).
+- Images/Charts/Diagrams: Wrap any clearly defined visual areas (e.g. charts, diagrams, pictures) in:
+<figure>
+Describe the image's main elements (people, objects, text), note any contextual clues (place, event, culture), mention visible text and its meaning, provide deeper analysis when relevant (especially for financial charts, graphs, or documents), comment on style or architecture if relevant, then give a concise overall summary. Describe in Thai.
+</figure>
+- Page Numbers: Wrap page numbers in <page_number>...</page_number> (e.g., <page_number>14</page_number>).
+- Checkboxes: Use ☐ for unchecked and ☑ for checked boxes."""
+```
+---
+## Quickstart (Ollama)
+```
+ollama run scb10x/typhoon-ocr1.5-3b
+```
+---
+## Support & Community
+* Twitter: [https://twitter.com/opentyphoon](https://twitter.com/opentyphoon)
+* Discord: [https://discord.gg/us5gAYmrxw](https://discord.gg/us5gAYmrxw)
+---
+## Citation
+If you use Typhoon OCR or Typhoon models, please cite:
+```
+@misc{typhoon2,
+  title={Typhoon 2: A Family of Open Text and Multimodal Thai Large Language Models},
+  author={Kunat Pipatanakul et al.},
+  year={2024},
+  eprint={2412.13702},
+  archivePrefix={arXiv},
+  primaryClass={cs.CL}
+}
+@misc{nonesung2025thaiocrbench,
+  title={ThaiOCRBench: A Task-Diverse Benchmark for Vision-Language Understanding in Thai},
+  author={Surapon Nonesung et al.},
+  year={2025},
+  eprint={2511.04479},
+  archivePrefix={arXiv},
+  primaryClass={cs.CL}
+}
+```