🎨 clean up README, create proper Makefile

This commit is contained in:
Konstantin Baierer 2020-10-15 14:44:41 +02:00
parent 7e4bcd0534
commit 47e8ddae5a
2 changed files with 21 additions and 5 deletions

4
Makefile Normal file
View file

@ -0,0 +1,4 @@
all: install
install:
pip install .

View file

@ -1,18 +1,30 @@
# Binarization
> Binarization for document images
## Introduction
This tool performs document image binarization (i.e. transform colour/grayscale to black-and-white pixels) for OCR using multiple trained models.
This tool performs document image binarization (i.e. transform colour/grayscale
to black-and-white pixels) for OCR using multiple trained models.
## Installation
Clone the repository, enter it and run
`./make`
`pip install .`
### Models
Pre-trained models can be downloaded from here:
https://qurator-data.de/sbb_binarization/
## Usage
`sbb_binarize -m <directory with models> -i <image file>
-p <set to true to let the model see the image divided into patches>
-s <directory where the results will be saved>`
```sh
sbb_binarize \
-m <directory with models> \
-i <image file> \
-p <set to true to let the model see the image divided into patches> \
-s <directory where the results will be saved>`
```