qurator-spk/ocrd_calamari
1
0
Fork 0
mirror of https://github.com/mikegerber/ocrd_calamari.git synced 2025-06-10 04:09:53 +02:00
Code Releases Activity

📝 readme, makefile, synopsis for cli

Browse source 
Conflicts:
	Makefile
	README.md
	requirements.txt
This commit is contained in:
Konstantin Baierer 2019-08-20 15:36:24 +02:00 • committed by Gerber, Mike
parent f7b13b8d3b
commit e34998d58f
3 changed files with 31 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

48
Makefile
View file

@ -1,6 +1,3 @@
# '$(PYTHON)'
PYTHON = python
# '$(PIP_INSTALL)' # '$(PIP_INSTALL)'
PIP_INSTALL = pip install PIP_INSTALL = pip install
@ -17,16 +14,9 @@ help:
@echo " calamari Clone calamari repo" @echo " calamari Clone calamari repo"
@echo " calamari_models Clone calamari_models repo" @echo " calamari_models Clone calamari_models repo"
@echo " calamari/build pip install calamari" @echo " calamari/build pip install calamari"
@echo " deps-test Install testing python deps via pip"
@echo " repo/assets Clone OCR-D/assets to ./repo/assets"
@echo " test/assets Setup test assets"
@echo " assets-clean Remove symlinks in test/assets"
@echo " test Run unit tests"
@echo " coverage Run unit tests and determine test coverage"
@echo "" @echo ""
@echo " Variables" @echo " Variables"
@echo "" @echo ""
@echo " PYTHON '$(PYTHON)'"
@echo " PIP_INSTALL '$(PIP_INSTALL)'" @echo " PIP_INSTALL '$(PIP_INSTALL)'"
@echo " GIT_CLONE '$(GIT_CLONE)'" @echo " GIT_CLONE '$(GIT_CLONE)'"
@ -50,41 +40,3 @@ calamari_models:
# pip install calamari # pip install calamari
calamari/build: calamari calamari_models calamari/build: calamari calamari_models
cd calamari && $(PIP_INSTALL) . cd calamari && $(PIP_INSTALL) .
#
# Assets and Tests
#
# Install testing python deps via pip
deps-test:
$(PIP) install -r requirements_test.txt
# Clone OCR-D/assets to ./repo/assets
repo/assets:
mkdir -p $(dir $@)
git clone https://github.com/OCR-D/assets "$@"
# Setup test assets
test/assets: repo/assets
mkdir -p $@
cp -r -t $@ repo/assets/data/*
# Remove symlinks in test/assets
assets-clean:
rm -rf test/assets
# Run unit tests
test: test/assets calamari_models
# declare -p HTTP_PROXY
$(PYTHON) -m pytest --continue-on-collection-errors test $(PYTEST_ARGS)
# Run unit tests and determine test coverage
coverage: test/assets calamari_models
coverage erase
make test PYTHON="coverage run"
coverage report
coverage html
.PHONY: assets-clean test

34
README.md
View file

@ -13,19 +13,41 @@ This offers a OCR-D compliant workspace processor for some of the functionality
This processor only operates on the text line level and so needs a line segmentation (and by extension a binarized This processor only operates on the text line level and so needs a line segmentation (and by extension a binarized
image) as its input. image) as its input.
## Example Usage ## Installation
```sh ### From PyPI
ocrd-calamari-recognize -p test-parameters.json -m mets.xml -I OCR-D-SEG-LINE -O OCR-D-OCR-CALAMARI
:construction: :construction: :construction: :construction: :construction: :construction: :construction:
```
pip install ocrd_calamari
``` ```
With `test-parameters.json`: ### From Repo
```json ```sh
pip install .
```
To install the calamari with the GPU version of Tensorflow:
```sh
pip install 'calamari-ocr[tf_cpu]'
pip install .
```
## Example Usage
~~~
ocrd-calamari-recognize -p test-parameters.json -m mets.xml -I OCR-D-SEG-LINE -O OCR-D-OCR-CALAMARI
~~~
With `test-parameters.json`:
~~~
{ {
"checkpoint": "/path/to/some/trained/models/*.ckpt.json" "checkpoint": "/path/to/some/trained/models/*.ckpt.json"
} }
``` ~~~
TODO TODO
---- ----

3
ocrd_calamari/cli.py
View file

@ -7,4 +7,7 @@ from ocrd_calamari.recognize import CalamariRecognize
@click.command() @click.command()
@ocrd_cli_options @ocrd_cli_options
def ocrd_calamari_recognize(*args, **kwargs): def ocrd_calamari_recognize(*args, **kwargs):
"""
Run Calamari OCR multi-model recognition and voting
"""
return ocrd_cli_wrap_processor(CalamariRecognize, *args, **kwargs) return ocrd_cli_wrap_processor(CalamariRecognize, *args, **kwargs)