Skip to main content

OCR/HTR engine for all the languages

Project description

Description

https://github.com/mittagessen/kraken/actions/workflows/test.yml/badge.svg

kraken is a turn-key OCR system optimized for historical and non-Latin script material.

kraken’s main features are:

  • Fully trainable layout analysis and character recognition

  • Right-to-Left, BiDi, and Top-to-Bottom script support

  • ALTO, PageXML, abbyXML, and hOCR output

  • Word bounding boxes and character cuts

  • Multi-script recognition support

  • Public repository of model files

  • Lightweight model files

  • Variable recognition network architectures

Installation

kraken only runs on Linux or Mac OS X. Windows is not supported.

The latest stable releases can be installed either from PyPi:

$ pip install kraken

or through conda:

$ conda install -c conda-forge -c mittagessen kraken

If you want direct PDF and multi-image TIFF/JPEG2000 support it is necessary to install the pdf extras package for PyPi:

$ pip install kraken[pdf]

or install pyvips manually with conda:

$ conda install -c conda-forge pyvips

Conda environment files are provided which for the seamless installation of the master branch as well:

$ git clone git://github.com/mittagessen/kraken.git
$ cd kraken
$ conda env create -f environment.yml

or:

$ git clone git://github.com/mittagessen/kraken.git
$ cd kraken
$ conda env create -f environment_cuda.yml

for CUDA acceleration with the appropriate hardware.

Finally you’ll have to scrounge up a model to do the actual recognition of characters. To download the default model for printed English text and place it in the kraken directory for the current user:

$ kraken get 10.5281/zenodo.2577813

A list of libre models available in the central repository can be retrieved by running:

$ kraken list

Quickstart

Recognizing text on an image using the default parameters including the prerequisite steps of binarization and page segmentation:

$ kraken -i image.tif image.txt binarize segment ocr

To binarize a single image using the nlbin algorithm:

$ kraken -i image.tif bw.png binarize

To segment an image (binarized or not) with the new baseline segmenter:

$ kraken -i image.tif lines.json segment -bl

To segment and OCR an image using the default model(s):

$ kraken -i image.tif image.txt segment -bl ocr

All subcommands and options are documented. Use the help option to get more information.

Documentation

Have a look at the docs

Funding

kraken is developed at the École Pratique des Hautes Études, Université PSL.

This project was partially funded through the RESILIENCE project, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation.

Co-financed by the European Union

Project details


Release history Release notifications | RSS feed

This version

3.0.6

Download files

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

Source Distribution

kraken-3.0.6.tar.gz (11.2 MB view details)

Uploaded Source

Built Distribution

kraken-3.0.6-py3-none-any.whl (5.4 MB view details)

Uploaded Python 3

File details

Details for the file kraken-3.0.6.tar.gz.

File metadata

  • Download URL: kraken-3.0.6.tar.gz
  • Upload date:
  • Size: 11.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for kraken-3.0.6.tar.gz
Algorithm Hash digest
SHA256 179def2f6345b281010a037a412082a892ea2d741307245e365e7f5ce02d31aa
MD5 d800dcb2b1d03cdb438c5903ee865bb0
BLAKE2b-256 6faea14a05992376585f827d1b5c09f96a2ad375d4e4bb93e3a434d6ff4a1d43

See more details on using hashes here.

File details

Details for the file kraken-3.0.6-py3-none-any.whl.

File metadata

  • Download URL: kraken-3.0.6-py3-none-any.whl
  • Upload date:
  • Size: 5.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for kraken-3.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4cd4a2bf84bbfb88e48203b8d950b63a67a896ff95f93f0cd5970f320b7299b1
MD5 e2df6737492ac26be37084ebc821e9ec
BLAKE2b-256 687bc95996053ed20b9c7380841a0be0fd41c564985a915e21ce9c8f8bdcf044

See more details on using hashes here.

Supported by

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