End-to-End Multi-Lingual Optical Character Recognition (OCR) Solution
Ready-to-use OCR with 80+ supported languages and all popular writing scripts including Latin, Chinese, Arabic, Devanagari, Cyrillic and etc.
11 September 2021 - Version 1.4.1
29 June 2021 - Version 1.4
- Instruction on training/using custom recognition model
- Example dataset for model training
- Batched image inference for GPU (thanks @SamSamhuns, see PR)
- Vertical text support (thanks @interactivetech). This is for rotated text, not to be confused with vertical Chinese or Japanese text. (see PR)
- Output in dictionary format (thanks @A2va, see PR)
30 May 2021 - Version 1.3.2
20 April 2021 - Version 1.3.1
- Add support for PIL image (thanks @prays)
- Add Tajik language (tjk)
- Update argument setting for command line
y_thsto control merging behavior when
21 March 2021 - Version 1.3
- Second-generation models: multiple times smaller size, multiple times faster inference, additional characters, comparable accuracy to the first generation models.
EasyOCR will choose the latest model by default but you can also specify which model to use by passing
recog_networkargument when creating
Readerinstance. For example,
reader = easyocr.Reader(['en','fr'], recog_network = 'latin_g1')will use the 1st generation Latin model.
- List of all models: Model hub
- Second-generation models: multiple times smaller size, multiple times faster inference, additional characters, comparable accuracy to the first generation models. EasyOCR will choose the latest model by default but you can also specify which model to use by passing
What's coming next
- Handwritten text support
pip for stable release,
pip install easyocr
For latest development release,
pip install git+git://github.com/jaidedai/easyocr.git
Note 1: for Windows, please install torch and torchvision first by following the official instruction here https://pytorch.org. On pytorch website, be sure to select the right CUDA version you have. If you intend to run on CPU mode only, select CUDA = None.
Note 2: We also provide Dockerfile here.
import easyocr reader = easyocr.Reader(['ch_sim','en']) # need to run only once to load model into memory result = reader.readtext('chinese.jpg')
Output will be in list format, each item represents bounding box, text and confident level, respectively.
[([[189, 75], [469, 75], [469, 165], [189, 165]], '愚园路', 0.3754989504814148), ([[86, 80], [134, 80], [134, 128], [86, 128]], '西', 0.40452659130096436), ([[517, 81], [565, 81], [565, 123], [517, 123]], '东', 0.9989598989486694), ([[78, 126], [136, 126], [136, 156], [78, 156]], '315', 0.8125889301300049), ([[514, 126], [574, 126], [574, 156], [514, 156]], '309', 0.4971577227115631), ([[226, 170], [414, 170], [414, 220], [226, 220]], 'Yuyuan Rd.', 0.8261902332305908), ([[79, 173], [125, 173], [125, 213], [79, 213]], 'W', 0.9848111271858215), ([[529, 173], [569, 173], [569, 213], [529, 213]], 'E', 0.8405593633651733)]
['ch_sim','en'] is the list of languages you want to read. You can pass
several languages at once but not all languages can be used together.
English is compatible with every languages. Languages that share common characters are usually compatible with each other.
Note 2: Instead of filepath
chinese.jpg, you can also pass OpenCV image object (numpy array) or image file as bytes. URL to raw image is also acceptable.
Note 3: The line
reader = easyocr.Reader(['ch_sim','en']) is for loading model into memory. It takes some time but it need to be run only once.
You can also set
detail = 0 for simpler output.
reader.readtext('chinese.jpg', detail = 0)
['愚园路', '西', '东', '315', '309', 'Yuyuan Rd.', 'W', 'E']
Model weight for chosen language will be automatically downloaded or you can download it manually from the model hub and put it in '~/.EasyOCR/model' folder
In case you do not have GPU or your GPU has low memory, you can run it in CPU mode by adding gpu = False
reader = easyocr.Reader(['ch_sim','en'], gpu = False)
Run on command line
$ easyocr -l ch_sim en -f chinese.jpg --detail=1 --gpu=True
Train/use your own model
- Handwritten support
- Restructure code to support swappable detection and recognition algorithm. The api should be as easy as
reader = easyocr.Reader(['en'], detection='DB', recognition = 'Transformer')
The idea is to be able to plug-in any state-of-the-art model into EasyOCR. There are a lot of geniuses trying to make better detection/recognition model. We are not trying to be a genius here, just make genius's works quickly accessible to the public ... for free. (well I believe most geniuses want their work to create positive impact as fast/big as possible) The pipeline should be something like below diagram. Grey slots are placeholders for changeable light blue modules.
Acknowledgement and References
This project is based on researches/codes from several papers/open-source repositories.
All deep learning part is based on Pytorch. :heart:
Recognition model is CRNN (paper). It is composed of 3 main components, feature extraction (we are currently using Resnet), sequence labeling (LSTM) and decoding (CTC). Training pipeline for recognition part is a modified version from deep-text-recognition-benchmark. (Thanks @ku21fan from @clovaai) This repository is a gem that deserved more recognition.
Data synthesis is based on TextRecognitionDataGenerator. (Thanks @Belval)
And good read about CTC from distill.pub here.
Want To Contribute?
Let's advance humanity together by making AI available to everyone!
3 ways to contribute:
Coder: Please send PR for small bug/improvement. For bigger one, discuss with us by open an issue first. There is a list of possible bug/improvement issue tagged with 'PR WELCOME'.
User: Tell us how EasyOCR benefit you/your organization to encourage further development. Also post failure cases in Issue Section to help improving future model.
Tech leader/Guru: If you found this library useful, please spread the word! (See Yann Lecun's post about EasyOCR)
Guideline for new language request
To request a new language support, I need you to send a PR with 2 following files
- In folder easyocr/character, we need 'yourlanguagecode_char.txt' that contains list of all characters. Please see format example from other files in that folder.
- In folder easyocr/dict, we need 'yourlanguagecode.txt' that contains list of words in your language. On average we have ~30000 words per language with more than 50000 words for popular one. More is better in this file.
If your language has unique elements (such as 1. Arabic: characters change form when attach to each other + write from right to left 2. Thai: Some characters need to be above the line and some below), please educate me with your best ability and/or give useful links. It is important to take care of the detail to achieve a system that really works.
Lastly, please understand that my priority will have to go to popular language or set of languages that share most of characters together (also tell me if your language share a lot of characters with other). It takes me at least a week to work for new model. You may have to wait a while for new model to be released.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size easyocr-1.4.1-py3-none-any.whl (63.6 MB)||File type Wheel||Python version py3||Upload date||Hashes View|