From ad4416a7d53e3fb783d15a67095994a7623bf109 Mon Sep 17 00:00:00 2001 From: Nick White Date: Fri, 6 Nov 2020 16:57:20 +0000 Subject: Document the local mode --- doc.go | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'doc.go') diff --git a/doc.go b/doc.go index 823ac2f..179a4f3 100644 --- a/doc.go +++ b/doc.go @@ -168,5 +168,22 @@ At present the bookpipeline has some silly limitations of file names for book pages to be recognised. This is something which will be fixed in due course. Pages that are to be fully processed: *[0-9]{4}.jpg$ Pages that are to be wiped only: *[0-9]{6}(.bin)?.png$ + +Local operation + +While bookpipeline was built with cloud based operation in mind, there is also +a local mode that can be used to run OCR jobs from a single computer, with all +the benefits of preprocessing, choosing the best threshold for each image, +graph creation and so on that the pipeline provides. + +You can use this by passing the '-c local' flag to the core bookpipeline +commands. Here is a simple example run: + + booktopipeline -c local MyBook + bookpipeline -v -c local # run until MyBook has finished processing + getpipelinebook -c local MyBook + +Note that the local mode is not as well tested as the core cloud modes; please +report any bugs you find with it. */ package bookpipeline -- cgit v1.2.1-24-ge1ad From 82ee93b53ae4fcef619543f643dc626f6c9353cf Mon Sep 17 00:00:00 2001 From: Nick White Date: Wed, 18 Nov 2020 13:47:44 +0000 Subject: Describe rescribe tool in documentation --- doc.go | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) (limited to 'doc.go') diff --git a/doc.go b/doc.go index 179a4f3..bd4da11 100644 --- a/doc.go +++ b/doc.go @@ -174,14 +174,11 @@ Local operation While bookpipeline was built with cloud based operation in mind, there is also a local mode that can be used to run OCR jobs from a single computer, with all the benefits of preprocessing, choosing the best threshold for each image, -graph creation and so on that the pipeline provides. +graph creation, PDF creation, and so on that the pipeline provides. -You can use this by passing the '-c local' flag to the core bookpipeline -commands. Here is a simple example run: - - booktopipeline -c local MyBook - bookpipeline -v -c local # run until MyBook has finished processing - getpipelinebook -c local MyBook +Several of the commands accept a `-c local` flag for local operation, but now +there is also a new command, named rescribe, that is designed to make things +much simpler for people just wanting to do some OCR on their local computer. Note that the local mode is not as well tested as the core cloud modes; please report any bugs you find with it. -- cgit v1.2.1-24-ge1ad