diff --git a/README.md b/README.md index 97dcd21..157f02b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Binarization +# sbb_binarization -> Binarization for document images +> Document Image Binarization using pre-trained models [![pip release](https://img.shields.io/pypi/v/sbb-binarization.svg)](https://pypi.org/project/sbb-binarization/) [![CircleCI test](https://circleci.com/gh/qurator-spk/sbb_binarization.svg?style=shield)](https://circleci.com/gh/qurator-spk/sbb_binarization) @@ -10,28 +10,35 @@ -## Introduction - -This tool performs document image binarization using a trained ResNet50-UNet model. - ## Installation -Clone the repository, enter it and run +Python versions `3.7-3.10` are currently supported. -`pip install .` +You can either install via -### Models +``` +pip install sbb-binarization +``` -Pre-trained models in HDF5 format can be downloaded from here: +or clone the repository, enter it and install (editable) with -https://qurator-data.de/sbb_binarization/ +``` +git clone git@github.com:qurator-spk/sbb_binarization.git +cd sbb_binarization; pip install -e . +``` -We also provide models in Tensorflow SavedModel format via Huggingface and Github release assets: +### Models -https://huggingface.co/SBB/sbb_binarization -https://github.com/qurator-spk/sbb_binarization/releases +Pre-trained models can be downloaded from the locations below. We also provide the models and [model card](https://huggingface.co/SBB/sbb_binarization) on 🤗 -With [OCR-D](https://ocr-d.de/), you can use the [Resource Manager](Tensorflow SavedModel) to deploy models, e.g. +| 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](https://ocr-d.de/), you can use the [Resource Manager](https://ocr-d.de/en/models) to deploy models, e.g. ocrd resmgr download ocrd-sbb-binarize "*" @@ -40,11 +47,13 @@ With [OCR-D](https://ocr-d.de/), you can use the [Resource Manager](Tensorflow S ```sh sbb_binarize \ - -m \ \ ``` +**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 @@ -65,6 +74,6 @@ For simple smoke tests, the following will - download test data - run the OCR-D wrapper (on page and region level): - make model + make models make test