No description
Find a file
2024-10-16 13:37:13 +02:00
.circleci CI: try adding py3.11 2024-10-16 13:37:13 +02:00
.github/workflows CI: remove py37 from matrix 2024-10-14 13:27:00 +02:00
repo add assets subrepo 2020-10-15 17:31:47 +02:00
sbb_binarize 📦 v0.1.0 2023-04-14 16:11:31 +02:00
.gitignore 📦 v0.0.2 2020-10-23 17:09:54 +02:00
.gitkeep Add new directory, you can find corresponding models in qurator-data 2019-08-23 15:47:32 +02:00
.gitmodules add assets subrepo 2020-10-15 17:31:47 +02:00
CHANGELOG.md 📦 v0.1.0 2023-04-14 16:11:31 +02:00
Dockerfile dockerfile: switch to pyproject.toml 2024-10-15 12:41:37 +02:00
LICENSE Add LICENSE 2019-12-10 16:40:44 +01:00
make.sh Add new file 2019-08-23 15:50:09 +02:00
Makefile docker: rebase on core-cuda stage 2024-10-15 12:56:26 +02:00
ocrd-tool.json add ocrd-tool.json 2020-10-15 15:19:04 +02:00
pyproject.toml forgot to include package data 2024-10-15 12:45:16 +02:00
README.md add GHA CD via Dockerhub 2024-09-30 21:27:04 +02:00
requirements.txt relax TF requirement (subminor) 2024-10-16 13:36:51 +02:00

sbb_binarization

Document Image Binarization

pip release GHActions CI GHActions CD

Installation

Python 3.7-3.10 with Tensorflow <=2.11.1 are currently supported. While newer versions might also work, we currently don't test this.

You can either install from PyPI via

pip install sbb-binarization

or clone the repository, enter it and install (editable) with

git clone git@github.com:qurator-spk/sbb_binarization.git
cd sbb_binarization; pip install -e .

Alternatively, download the prebuilt image from Dockerhub:

docker pull ocrd/sbb_binarization

Models

Pre-trained models can be downloaded from the locations below. We also provide models and model cards on 🤗

Version Format Download
2021-03-09 SavedModel https://github.com/qurator-spk/sbb_binarization/releases/download/v0.0.11/saved_model_2021_03_09.zip
2021-03-09 HDF5 https://qurator-data.de/sbb_binarization/2021-03-09/models.tar.gz
2020-01-16 SavedModel https://github.com/qurator-spk/sbb_binarization/releases/download/v0.0.11/saved_model_2020_01_16.zip
2020-01-16 HDF5 https://qurator-data.de/sbb_binarization/2020-01-16/models.tar.gz

With OCR-D, you can also use the Resource Manager, e.g.

ocrd resmgr download ocrd-sbb-binarize "*"

Usage

sbb_binarize \
  -m <path to directory containing model files> \
  <input image> \
  <output image>

Note: the output image MUST use either .tif or .png as file extension to produce a binary image. Input images can also be JPEG.

Images containing a lot of border noise (black pixels) should be cropped beforehand to improve the quality of results.

Example

sbb_binarize -m /path/to/model/ myimage.tif myimage-bin.tif

To use the OCR-D interface:

ocrd-sbb-binarize -I INPUT_FILE_GRP -O OCR-D-IMG-BIN -P model default

Testing

For simple smoke tests, the following will

  • download models

  • download test data

  • run the OCR-D wrapper (on page and region level):

      make models
      make test