Skip to main content

Python Tamil OCR package

Project description

OCR Tamil - Easy, Accurate and Simple to use Tamil OCR - (ஒளி எழுத்துணரி)

❤️️❤️️Please star✨ it if you like❤️️❤️️

LICENSE HuggingSpace colab

OCR Tamil can help you extract text from signboard, nameplates, storefronts etc., from Natural Scenes with high accuracy. This version of OCR is much more robust to tilted text compared to the Tesseract, Paddle OCR and Easy OCR as they are primarily built to work on the documents texts and not on natural scenes.

Languages Supported 🔛

➡️ English

➡️ Tamil (தமிழ்)

Accuracy 🎯

✔️ English > 98%

✔️ Tamil > 95%

Comparison between Tesseract OCR, EasyOCR and OCR Tamil ⚖️

🏎️ 10-40% faster inference time than EasyOCR and Tesseract

Input Image OCR TAMIL 🏆 Tesseract EasyOCR
teaser வாழ்கவளமுடன்✅ க்‌ க்கஸாரகளள௮ஊகஎளமுடன்‌ ❌ வாழக வளமுடன்❌
teaser தமிழ்வாழ்க✅ NO OUTPUT தமிழ்வாழ்க✅
teaser கோபி ✅ NO OUTPUT ப99❌
teaser தாம்பரம் ✅ NO OUTPUT தாம்பரம❌
teaser நெடுஞ்சாலைத் ✅ NO OUTPUT நெடுஞ்சாலைத் ✅
teaser அண்ணாசாலை ✅ NO OUTPUT ல@I9❌
teaser ரெடிமேட்ஸ் ✅ NO OUTPUT ரெடிமேடஸ் ❌

Obtained Tesseract and EasyOCR results using the Colab notebook with Tamil and english as language

Handwritten Text (Experimental)🧪

teaser
MODEL OUTPUT: நிமிர்ந்த நன்னடை மேற்கொண்ட பார்வையும் 
நிலத்தில் யார்க் கும் அஞ்சாத நெறிகளும் 
திமிர்ந்த ஞானச் செருக்கும் இருப்பதால் 
செம்மை மாதர் திறம்புவ தில்லையாம் 
அமிழ்ந்து பேரிரு ளாமறி யாமையில் 
அவல மெய்திக் கலையின்  வாழ்வதை 
உமிழ்ந்து தள்ளுதல் பெண்ணற மாகுமாம் 
உதய கன்ன உரைப்பது கேட்டிரோ 
பாரதியார் 
ஹேமந்த் ம 

How to Install and Use OCR Tamil 👨🏼‍💻

Quick links🌐

📔 Detailed explanation on Medium article.

✍️ Experiment in Colab notebook

🤗 Test it in Huggingface spaces

Pip install instructions🐍

In your command line, run the following command pip install ocr_tamil

If you are using jupyter notebook , install like !pip install ocr_tamil

Python Usage - Single image inference

Text Recognition only

from ocr_tamil.ocr import OCR

image_path = r"test_images\1.jpg" # insert your own path here
ocr = OCR()
text_list = ocr.predict(image_path)
print(text_list[0])

## OUTPUT : நெடுஞ்சாலைத்
teaser

Text Detect + Recognition

from ocr_tamil.ocr import OCR

image_path = r"test_images\0.jpg" # insert your own image path here
ocr = OCR(detect=True)
texts = ocr.predict(image_path)
print(" ".join(texts))

## OUTPUT : கொடைக்கானல் Kodaikanal 
teaser

Batch inference mode 💻

Text Recognition only

from ocr_tamil.ocr import OCR

image_path = [r"test_images\1.jpg",r"test_images\2.jpg"] # insert your own image paths here
ocr = OCR()
text_list = ocr.predict(image_path)

for text in text_list:
    print(text)

## OUTPUT : நெடுஞ்சாலைத்
## OUTPUT : கோபி

Text Detect + Recognition

from ocr_tamil.ocr import OCR

image_path = [r"test_images\0.jpg",r"test_images\tamil_sentence.jpg"] # insert your own image paths here
ocr = OCR(detect=True)
text_list = ocr.predict(image_path)

for item in text_list:
  print(" ".join(item))
    

## OUTPUT : கொடைக்கானல் Kodaikanal 
## OUTPUT : செரியர் யற்கை மூலிகைகளில் இருந்து ஈர்த்தெடுக்க்கப்பட்ட வீரிய உட்பொருட்களை உள்ளடக்கி எந்த இரசாயன சேர்க்கைகளும் இல்லாமல் உருவாக்கப்பட்ட இந்தியாவின் முதல் சித்த தயாரிப்பு 

Advanced usage🚀

OCR module can be initialized by setting following parameters as per your requirements

1. Confidence of word ->  OCR(details=1)
2. Bounding Box and Confidence of word -> OCR(detect=True,details=2)
3. To change the CRAFT Text detection settings -> OCR(detect=True,text_threshold=0.5,
                                               link_threshold=0.1,
                                               low_text=0.30)
4. To increase the Batch size of text recognition -> OCR(batch_size=16) # set as per available memory
5. To configure the language to be extracted -> OCR(lang=["tamil"]) # list can take "english" or "tamil" or both. Defaults to both language

Tested using Python 3.10 on Windows & Linux (Ubuntu 22.04) Machines

Applications⚡

  1. ADAS system navigation based on the signboards + maps (hybrid approach) 🚁
  2. License plate recognition 🚘

Limitations⛔

  1. Document text reading capability is not supported as library doesn't have

    ➡️Auto identification of Paragraph

    ➡️Orientation detection

    ➡️Skew correction

    ➡️Reading order prediction

    ➡️Document unwarping

    ➡️Optimal Text detection for Document text not available

    (WORKAROUND Bring your own models for above cases and use with OCR tamil for text recognition)

  2. Unable to read the text if they are present in rotated forms

teaser teaser

  1. Currently supports Only Tamil Language. I don't own english model as it's taken from open source implementation of parseq

Acknowledgements 👏

Text detection - CRAFT TEXT DECTECTION

Text recognition - PARSEQ

@InProceedings{bautista2022parseq,
  title={Scene Text Recognition with Permuted Autoregressive Sequence Models},
  author={Bautista, Darwin and Atienza, Rowel},
  booktitle={European Conference on Computer Vision},
  pages={178--196},
  month={10},
  year={2022},
  publisher={Springer Nature Switzerland},
  address={Cham},
  doi={10.1007/978-3-031-19815-1_11},
  url={https://doi.org/10.1007/978-3-031-19815-1_11}
}
@inproceedings{baek2019character,
  title={Character Region Awareness for Text Detection},
  author={Baek, Youngmin and Lee, Bado and Han, Dongyoon and Yun, Sangdoo and Lee, Hwalsuk},
  booktitle={Proceedings of the IEEE Conference on Computer Vision and Pattern Recognition},
  pages={9365--9374},
  year={2019}
}

Citation

@InProceedings{GnanaPrasath,
  title={Tamil OCR},
  author={Gnana Prasath D},
  month={01},
  year={2024},
  url={https://github.com/gnana70/tamil_ocr}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ocr_tamil-0.4.1.tar.gz (43.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ocr_tamil-0.4.1-py3-none-any.whl (50.2 kB view details)

Uploaded Python 3

File details

Details for the file ocr_tamil-0.4.1.tar.gz.

File metadata

  • Download URL: ocr_tamil-0.4.1.tar.gz
  • Upload date:
  • Size: 43.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for ocr_tamil-0.4.1.tar.gz
Algorithm Hash digest
SHA256 107b9addb6715694b821997e9e579afb36da01798e45a5f0589de9e443988d53
MD5 7732ffc4e32377528106099dea90161f
BLAKE2b-256 0a2b61628274b8ff4e1b3372c061932fd0b5a983a07da57ffbdd9f4086980ae1

See more details on using hashes here.

File details

Details for the file ocr_tamil-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: ocr_tamil-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 50.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for ocr_tamil-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 103ded401580cb4d54c404fafd91a696ec009d2388b354ffb05424c8af0f2fbe
MD5 422da6bab342c4b535e79f372587c5dd
BLAKE2b-256 adc970f6d7375b8a219c67df9262ba0cc9566f878ec113f919f5e614e5707fe1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page