Kiri OCR 📄
Kiri OCR is a lightweight OCR library for English and Khmer documents. It provides document-level text detection, recognition, and rendering capabilities.
🚀 Try the Live Demo | 📚 Full Documentation
✨ Key Features
- High Accuracy: Transformer model with hybrid CTC + attention decoder
- Bi-lingual: Native support for English and Khmer (and mixed text)
- Document Processing: Automatic text line and word detection
- Streaming: Real-time character-by-character output (like LLM streaming)
- Easy to Use: Simple Python API and CLI
📦 Installation
pip install kiri-ocr
💻 Quick Start
CLI Tool
kiri-ocr document.jpg
Python API
from kiri_ocr import OCR
# Initialize (auto-downloads from Hugging Face)
ocr = OCR()
# Extract text from document
text, results = ocr.extract_text('document.jpg')
print(text)
# Get detailed box-by-box results
for line in results:
print(f"{line['text']} (confidence: {line['confidence']:.1%})")
Decoding Methods
Choose the decoding method based on your speed/quality tradeoff:
# Fast (CTC) - Fastest, good for batch processing
ocr = OCR(decode_method="fast")
# Accurate (Decoder) - Balanced speed and quality (default)
ocr = OCR(decode_method="accurate")
# Beam Search - Best quality, slowest
ocr = OCR(decode_method="beam")
Streaming Recognition
Get character-by-character output like LLM streaming:
from kiri_ocr import OCR
ocr = OCR(decode_method="accurate")
# Stream characters as they're decoded
for chunk in ocr.extract_text_stream_chars('document.jpg'):
print(chunk['token'], end='', flush=True)
if chunk['document_finished']:
print() # Done!
📚 Documentation
Full documentation is available on the Wiki:
- Installation
- Quick Start Guide
- Python API Reference
- CLI Reference
- Training Guide
- Detector API
- Architecture
📊 Benchmark
Results on synthetic test images (10 popular fonts):
📁 Project Structure
kiri_ocr/
├── core.py # OCR class
├── model.py # Transformer model
├── training.py # Training code
├── cli.py # Command-line interface
└── detector/ # Text detection
├── db/ # DB detector
└── craft/ # CRAFT detector
☕ Support
If you find this project useful:
- ⭐ Star this repository
- Buy Me a Coffee
- ABA Payway
Join our Discord Community](https://discord.gg/Vcrw274RVC)
⚖️ License
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kiri_ocr-0.2.15.tar.gz.
File metadata
- Download URL: kiri_ocr-0.2.15.tar.gz
- Upload date:
- Size: 84.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
feb4ef5b65cd862551abc44da760d4ad07b96f595b6353920c65b6485dc08aab
|
|
| MD5 |
34c51df324cfbfa86a64442d48c49e75
|
|
| BLAKE2b-256 |
03736c0de25d338ec3748b78cece30ca8d121fbc82197a38a27aa3953502d1e6
|
File details
Details for the file kiri_ocr-0.2.15-py3-none-any.whl.
File metadata
- Download URL: kiri_ocr-0.2.15-py3-none-any.whl
- Upload date:
- Size: 89.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd15330d2cebf787f43bb1df6802fcb6f011c5f03a289089b7bc079bb1826ac1
|
|
| MD5 |
90a22adb8f5d59234779c409e1fd6a37
|
|
| BLAKE2b-256 |
2d0bcde4028cb9a3bfb37d2fc8a04177990330e13dfc9055e490cca8fa90ac1c
|
