OCR/HTR engine for all the languages
Project description
Description
kraken is a turn-key OCR system optimized for historical and non-Latin script material.
kraken’s main features are:
Fully trainable layout analysis, reading order, and character recognition
Right-to-Left, BiDi, and Top-to-Bottom script support
ALTO, PageXML, abbyyXML, and hOCR output
Word bounding boxes and character cuts
Multi-script recognition support
Public repository of model files
Variable recognition network architecture
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 pip:
$ pip install pyvips
Conda environment files are provided for the seamless installation of the main branch as well:
$ git clone https://github.com/mittagessen/kraken.git $ cd kraken $ conda env create -f environment.yml
or:
$ git clone https://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 French text and place it in the kraken directory for the current user:
$ kraken get 10.5281/zenodo.10592716
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 -m catmus-print-fondue-large.mlmodel
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.
Ce travail a bénéficié d’une aide de l’État gérée par l’Agence Nationale de la Recherche au titre du Programme d’Investissements d’Avenir portant la référence ANR-21-ESRE-0005 (Biblissima+).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file kraken-5.2.9.tar.gz.
File metadata
- Download URL: kraken-5.2.9.tar.gz
- Upload date:
- Size: 12.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0d132267bc168bebc27b961da7c917a8584363d497eb7a63fa2bcbd51f9edcae |
|
| MD5 | fb69fe09725f92b9eb90bf05afe45cb6 |
|
| BLAKE2b-256 | 7e55ba9522dbeff0239955c9549ecac756bc034f891f3be5084390371d725443 |
File details
Details for the file kraken-5.2.9-py3-none-any.whl.
File metadata
- Download URL: kraken-5.2.9-py3-none-any.whl
- Upload date:
- Size: 5.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3f1d7c801e7a7c985e9fe1bff5abd4b621769e2cd70668909255af856c0f86d0 |
|
| MD5 | 75e8d0acaff71c5d27fa29fbd3e1a7dc |
|
| BLAKE2b-256 | d0c5640a6af5332c65aebbef7e72f410b9eca281d7e925d2cc93d2ae86651d66 |
