From 230e7cc705eef7800924917c23b9b4242d69f926 Mon Sep 17 00:00:00 2001 From: cneud <952378+cneud@users.noreply.github.com> Date: Mon, 20 Oct 2025 22:52:54 +0200 Subject: [PATCH] integrate ocrd docs --- README.md | 11 ++--------- docs/ocrd.md | 5 +++++ 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fabb594..d6930f7 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,7 @@ eynollah ocr \ ### Reading Order Detection -The machine-based reading-order module employs a pretrained model to identify the reading order from layouts represented in PAGE-XML files. +The reading order detection module employs a pretrained model to identify the reading order from layouts represented in PAGE-XML files. The command-line interface for machine based reading order can be called like this: @@ -169,17 +169,10 @@ eynollah machine-based-reading-order \ -o ``` -#### Use as OCR-D processor - -Eynollah ships with a CLI interface to be used as [OCR-D](https://ocr-d.de) [processor](https://ocr-d.de/en/spec/cli), -formally described in [`ocrd-tool.json`](https://github.com/qurator-spk/eynollah/tree/main/src/eynollah/ocrd-tool.json). - -Further documentation on using Eynollah with OCR-D can be found in [`ocrd.md`](https://github.com/qurator-spk/eynollah/tree/main/docs/ocrd.md). - ## How to cite ```bibtex -@inproceedings{hip23eynollah, +@inproceedings{hip23rezanezhad, title = {Document Layout Analysis with Deep Learning and Heuristics}, author = {Rezanezhad, Vahid and Baierer, Konstantin and Gerber, Mike and Labusch, Kai and Neudecker, Clemens}, booktitle = {Proceedings of the 7th International Workshop on Historical Document Imaging and Processing {HIP} 2023, diff --git a/docs/ocrd.md b/docs/ocrd.md index a391024..9e7e268 100644 --- a/docs/ocrd.md +++ b/docs/ocrd.md @@ -1,3 +1,8 @@ +## Use as OCR-D processor + +Eynollah ships with a CLI interface to be used as [OCR-D](https://ocr-d.de) [processor](https://ocr-d.de/en/spec/cli), +formally described in [`ocrd-tool.json`](https://github.com/qurator-spk/eynollah/tree/main/src/eynollah/ocrd-tool.json). + When using Eynollah in OCR-D, the source image file group with (preferably) RGB images should be used as input like this: ocrd-eynollah-segment -I OCR-D-IMG -O OCR-D-SEG -P models eynollah_layout_v0_5_0