Documentation

Binarize, normalize, rescale and segment images using Kraken and DUP-ocropy.
Including wrappers for model training.

Installation

Recommended Python version: 3.10.14
Used Kraken version: 4.3.13

PyEnv

GitHub: PyEnv with build dependencies.

Install Python

pyenv install 3.10.14

Create virtual environment

pyenv virtualenv 3.10.14 octopy

Activate virtual environment

pyenv activate octopy

Octopy

Download

git clone --recurse-submodules --remote-submodules https://github.com/jahtz/octopy.git

Install dependencies

pip install -r octopy/requirements.txt

Usage

Preprocessing

python octopy pp [OPTIONS] [FILES]...

Options

-h, --help              Show this message and exit.
-o, --output DIRECTORY  Output directory to save the pre-processed files. [required]
-b, --binarize          Binarize images.
-n, --normalize         Normalize images.
-r, --resize            Resize images. Used for binarization and normalization.
--height INTEGER        Height of resized image.
--width INTEGER         Width of resized image. If height and width is set, height is prioritized.
-t, --threshold FLOAT   Threshold percentage for binarization. [default:0.5]

Segmentation

python octopy seg [OPTIONS] [FILES]...

Options

-h, --help                 Show this message and exit.
-m, --model FILE           Path to segmentation model. [required]
-o, --output DIRECTORY     Output directory to save PageXML files.
-s, --suffix TEXT          Suffix to append to the output file name. e.g. '.seg.xml' results in 'imagename.seg.xml'. [default: .xml]
-d, --device TEXT          Device to run the model on (see Kraken guide). [default: cpu]
-c, --creator TEXT         Creator of the PageXML file.
-r, --recalculate INTEGER  Recalculate line polygons with this factor. Increases compute time significantly.

Segmentation Training

python octopy segtrain [OPTIONS] [GROUND_TRUTH]...

Options

-h, --help                 Show this message and exit.
-o, --output DIRECTORY     Output directory to save epochs and trained model. [required]
-n, --name TEXT            Name of the output model. [default: foo]
-m, --model FILE           Path to existing model to continue training. If set to None, a new model is trained from scratch.
-p, --partition FLOAT      Ground truth data partition ratio between train/validation set. [default: 0.9]
-d, --device TEXT          Device to run the model on (see Kraken guide). [default: cpu]
-t, --threads INTEGER      Number of threads to use (cpu only). [default: 1]
--max-epochs INTEGER       Maximum number of epochs to train. [default: 50]
--min-epochs INTEGER       Minimum number of epochs to train. [default: 0]
-q, --quit [early|fixed]   Stop condition for training. Set to `early` for early stopping or `fixed` for fixed number of epochs. [default: fixed]
-v, --verbose              Verbosity level. For level 2 use -vv (0-3).
-mr, --merge-regions TEXT  Region merge mapping. One or more mappings of the form `$target:$src` where $src is merged into $target.

ZPD

Developed at Centre for Philology and Digitality (ZPD), University of Würzburg.