Python-based tools for document analysis and OCR
Jupyter Notebook Python Other
Latest commit 49c7f9e Apr 28, 2017 @zuphilip zuphilip committed on GitHub Update wiki badge
We have now 11 wiki pages.
Failed to load latest commit information.
.github ISSUE_TEMPLATE: git log -n1 and python version Nov 6, 2016
OLD py3k: Use print function instead of statement. Nov 15, 2016
doc Add line-normalization.ipynb for documentation Apr 26, 2017
models Add a in models directory (#194) Mar 19, 2017
ocrolib Merge pull request #133 from tmbdev/dewarp-padding2 Apr 26, 2017
tests Add test image for dewarping Apr 26, 2017
.gitignore Add .ipynb_checkpoints/ to .gitignore Apr 28, 2017
.hgignore added some more ignores Aug 16, 2012
.travis.yml Add matplotlib cache to Travis cache. Nov 16, 2016
LICENSE Added LICENSE and files I forgot to include with las tcommit. Dec 10, 2014
PACKAGES PACKAGES: Drop python-tables requirement Nov 10, 2016 Update wiki badge Apr 28, 2017 Add solution for OS X (clang) Feb 21, 2015
ocropus-dewarp py3k: Use print function instead of statement. Nov 15, 2016
ocropus-econf Merge branch 'master' into pr Jan 23, 2017
ocropus-errs Merge branch 'master' into pr Jan 23, 2017
ocropus-gpageseg Merge pull request #180 from tmbdev/cleanup-select-regions Feb 11, 2017
ocropus-gtedit py3k: Use print function instead of statement. Nov 15, 2016
ocropus-hocr Made output more compatible to the hOCR spec. Dec 2, 2016
ocropus-linegen py3k: Use print function instead of statement. Nov 15, 2016
ocropus-lpred py3k: Use new-style exceptions. Jan 23, 2017
ocropus-ltrain py3k: Use new-style exceptions. Jan 23, 2017
ocropus-nlbin Unused function select_regions in ocropus-nlbin Feb 5, 2017
ocropus-rpred Merge branch 'master' into cleanup-common Jan 23, 2017
ocropus-rtrain py3k: Use print function instead of statement. Nov 15, 2016
ocropus-visualize-results py3k: Use print function instead of statement. Nov 15, 2016
requirements.txt Merge branch 'master' into cleanup-requirements Nov 10, 2016
run-coverage Allow test scripts to run in any directory. Nov 16, 2016
run-rtrain Allow test scripts to run in any directory. Nov 16, 2016
run-test Allow test scripts to run in any directory. Nov 16, 2016 py3k: Use print function instead of statement. Nov 15, 2016


Build Status license Wiki Join the chat at

OCRopus is a collection of document analysis programs, not a turn-key OCR system. In order to apply it to your documents, you may need to do some image preprocessing, and possibly also train new models.

In addition to the recognition scripts themselves, there are a number of scripts for ground truth editing and correction, measuring error rates, determining confusion matrices, etc. OCRopus commands will generally print a stack trace along with an error message; this is not generally indicative of a problem (in a future release, we'll suppress the stack trace by default since it seems to confuse too many users).


To install OCRopus dependencies system-wide:

$ sudo apt-get install $(cat PACKAGES)
$ wget -nd
$ mv en-default.pyrnn.gz models/
$ sudo python install

Alternatively, dependencies can be installed into a Python Virtual Environment:

$ virtualenv ocropus_venv/
$ source ocropus_venv/bin/activate
$ pip install -r requirements.txt
$ wget -nd
$ mv en-default.pyrnn.gz models/
$ python install

An additional method using Conda is also possible:

$ conda create -n ocropus_env python=2.7
$ source activate ocropus_env
$ conda install --file requirements.txt
$ wget -nd
$ mv en-default.pyrnn.gz models/
$ python install

To test the recognizer, run:

$ ./run-test


To recognize pages of text, you need to run separate commands: binarization, page layout analysis, and text line recognition. The default parameters and settings of OCRopus assume 300dpi binary black-on-white images. If your images are scanned at a different resolution, the simplest thing to do is to downscale/upscale them to 300dpi. The text line recognizer is fairly robust to different resolutions, but the layout analysis is quite resolution dependent.

Here is an example for a page of Fraktur text (German); you need to download the Fraktur model from to run this example:

# perform binarization
./ocropus-nlbin tests/ersch.png -o book

# perform page layout analysis
./ocropus-gpageseg 'book/????.bin.png'

# perform text line recognition (on four cores, with a fraktur model)
./ocropus-rpred -Q 4 -m models/fraktur.pyrnn.gz 'book/????/??????.bin.png'

# generate HTML output
./ocropus-hocr 'book/????.bin.png' -o ersch.html

# display the output
firefox ersch.html

There are some things the currently trained models for ocropus-rpred will not handle well, largely because they are nearly absent in the current training data. That includes all-caps text, some special symbols (including "?"), typewriter fonts, and subscripts/superscripts. This will be addressed in a future release, and, of course, you are welcome to contribute new, trained models.

You can also generate training data using ocropus-linegen:

ocropus-linegen -t tests/tomsawyer.txt -f tests/DejaVuSans.ttf

This will create a directory "linegen/..." containing training data suitable for training OCRopus with synthetic data.


Project Announcements
The text line recognizer has been ported to C++ and is now a separate project, the CLSTM project, available here:
Please welcome @zuphilip and @kba as additional project maintainers. @tmb is busy developing new DNN models for document analysis (among other things). (10/15/2016)

A lot of excellent packages have become available for deep learning, vision, and GPU computing over the last few years. At the same time, it has become feasible now to address problems like layout analysis and text line following through attentional and reinforcement learning mechanisms. I (@tmb) am planning on developing new software using these new tools and techniques for the traditional document analysis tasks. These will become available as separate projects.

Note that for text line recognition and language modeling, you can also use the CLSTM command line tools. Except for taking different command line options, they are otherwise drop-in replacements for the Python-based text line recognizer.


OCRopy and CLSTM are both command line driven programs. The best way to contribute is to create new command line programs using the same (simple) persistent representations as the rest of OCRopus.

The biggest needs are in the following areas:

  • text/image segmentation
  • text line detection and extraction
  • output generation (hOCR and hOCR-to-* transformations)


The CLSTM project ( is a replacement for ocropus-rtrain and ocropus-rpred in C++ (it used to be a subproject of ocropy but has been moved into a separate project now). It is significantly faster than the Python versions and has minimal library dependencies, so it is suitable for embedding into C++ programs.

Python and C++ models can not be interchanged, both because the save file formats are different and because the text line normalization is slightly different. Error rates are about the same.

In addition, the C++ command line tool (clstmctc) has different command line options and currently requires loading training data into HDF5 files, instead of being trained off a list of image files directly (image file-based training will be added to clstmctc soon).

The CLSTM project also provides LSTM-based language modeling that works very well with post-processing and correcting OCR output, as well as solving a number of other OCR-related tasks, such as dehyphenation or changes in orthography (see our publications). You can train language models using clstmtext.

Generally, your best bet for CLSTM and OCRopy is to rely only on the command line tools; that makes it easy to replace different components. In addition, you should keep your OCR training data in .png/.gt.txt files so that you can easily retrain models as better recognizers become available.

After making CLSTM a full replacement for ocropus-rtrain/ocropus-rpred, the next step will be to replace the binarization, text/image segmentation, and layout analysis in OCRopus with trainable 2D LSTM models.

Solution for clang