From 2a020954fb356fe9b3c2d8df4439de054f0afa34 Mon Sep 17 00:00:00 2001 From: "Gerber, Mike" Date: Wed, 15 Mar 2023 19:40:43 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=92=20README:=20Update=20that=20we=20have?= =?UTF-8?q?=20images=20again=20+=20how=20to=20download=20models?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 65e6e3e..e39581b 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,9 @@ including all dependencies in Docker. How to use ---------- -**Currently, due to problems with the Travis CI, we do not provide pre-built -containers anymore.*** - -To build the containers yourself using Docker: -~~~ -cd ~/devel/ocrd-galley/ -./build -~~~ +ocrd-galley uses Docker to run the OCR-D images. We provide pre-built container +images that get downloaded automatically when you run the provided wrappers for +the OCR-D processors. You can then install the wrappers into a Python venv: ~~~ @@ -44,9 +39,13 @@ cd ~/devel/ocrd-galley/wrapper pip install . ~~~ +To download models, you need to use the `-a` flag of `ocrd resmgr`: +~~~ +ocrd resmgr download -a ocrd-calamari-recognize default +~~~ + You may then use the script `my_ocrd_workflow` to use your self-built containers on an example workspace: - ~~~ # Download an example workspace cd /tmp @@ -110,3 +109,11 @@ cd workspace-xxxxx # output by the last command ~~~ This produces a workspace from the files and then runs the OCR workflow on it. + +Build the containers yourself +----------------------------- +To build the containers yourself using Docker: +~~~ +cd ~/devel/ocrd-galley/ +./build +~~~