Warning: This document is for an old version of kraken. The latest version is 0.10.0.

Models

There are currently two kinds of models containing the recurrent neural networks doing all the character recognition supported by kraken: traditional pyrnn models that are just pickled instances of python objects and a new format serializing data in HDF5 files.

pyrnn

These are serialized instances of python lstm.SeqRecognizer objects. Using such a model just entails loading the pickle and calling the appropriate functions to perform recognition much like a shared library in other programming languages.

Several drawbacks exist when using pickled models. First they inherently allow arbitrary code execution with relative ease. Additionally, they are not upward compatible between python 2.x and 3.x and significantly larger than the newer HDF5 models.

HDF5

HDF5 is a file format designed to store large amounts of numerical data efficiently. We currently serialize ocropus’s models as a group with attribute kind set to pyrnn-bidi containing the weights of each neural network in a separate data set. The codec included in pickle models is saved as well, while the line normalizer isn’t stashed for now.

HDF5 models have several advantages over pickled ones. They are noticeably smaller (80Mb vs 1.8Mb for the default model), don’t allow arbitrary code execution, and are upward compatible. Because they are so much more lightweight they are also loaded much faster (~17s vs ~200ms).

Conversion

Per default pyrnn models are automatically converted to the new HDF5 format when explicitely defined using the -m option to the ocr utility on the command line. They are stored in the user kraken directory (default is ~/.kraken) and will be automatically substituted in future runs.

This substitution process is extremely fast, in fact loading the pickle is usually several magnitudes slower than converting it once loaded.

If conversion is not desired, e.g. because there is a bug in the conversion routine, it can be disabled using the --disable-autoconversion switch.