diff options
| -rw-r--r-- | cloudsettings.go | 3 | ||||
| -rw-r--r-- | cmd/addtoqueue/main.go | 2 | ||||
| -rw-r--r-- | cmd/bookpipeline/main.go | 3 | ||||
| -rw-r--r-- | cmd/booktopipeline/main.go | 2 | ||||
| -rw-r--r-- | cmd/confgraph/main.go | 2 | ||||
| -rw-r--r-- | cmd/getpipelinebook/main.go | 1 | ||||
| -rw-r--r-- | cmd/lspipeline/main.go | 1 | ||||
| -rw-r--r-- | cmd/mkpipeline/main.go | 2 | ||||
| -rw-r--r-- | cmd/pagegraph/main.go | 2 | ||||
| -rw-r--r-- | cmd/pdfbook/main.go | 2 | ||||
| -rw-r--r-- | cmd/spotme/main.go | 1 |
11 files changed, 21 insertions, 0 deletions
diff --git a/cloudsettings.go b/cloudsettings.go index fa60238..b1993e3 100644 --- a/cloudsettings.go +++ b/cloudsettings.go @@ -8,6 +8,9 @@ package bookpipeline // you want to use the cloud functionality on your own site. // Spot instance details. +// This is only needed if you want to start spot instances with the +// spotme command, to start up preconfigured virtual servers running +// bookpipeline. // The profile needs to allow permissions to the below S3 buckets and // SQS queues, the Sg (security group) doesn't need any permissions, // beyond SSH if you like, and the image should have bookpipeline diff --git a/cmd/addtoqueue/main.go b/cmd/addtoqueue/main.go index c3284e9..8e4ecd2 100644 --- a/cmd/addtoqueue/main.go +++ b/cmd/addtoqueue/main.go @@ -2,6 +2,8 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// addtoqueue adds a message to a queue. This is handy to work +// around bugs in the book pipeline when things are misbehaving. package main import ( diff --git a/cmd/bookpipeline/main.go b/cmd/bookpipeline/main.go index 9059167..3b9befb 100644 --- a/cmd/bookpipeline/main.go +++ b/cmd/bookpipeline/main.go @@ -2,6 +2,9 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// bookpipeline is the core command of the bookpipeline package, which +// watches queues for messages and does various OCR related tasks when +// it receives them, saving the results in cloud storage. package main import ( diff --git a/cmd/booktopipeline/main.go b/cmd/booktopipeline/main.go index cb40eb4..2e7064e 100644 --- a/cmd/booktopipeline/main.go +++ b/cmd/booktopipeline/main.go @@ -2,6 +2,8 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// booktopipeline uploads a book to cloud storage and adds the name +// to a queue ready to be processed by the bookpipeline tool. package main import ( diff --git a/cmd/confgraph/main.go b/cmd/confgraph/main.go index 55d2fd5..864e44b 100644 --- a/cmd/confgraph/main.go +++ b/cmd/confgraph/main.go @@ -2,6 +2,8 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// confgraph creates a graph showing the average word confidence +// of each page of hOCR in a directory. package main import ( diff --git a/cmd/getpipelinebook/main.go b/cmd/getpipelinebook/main.go index fe2af89..dc9387f 100644 --- a/cmd/getpipelinebook/main.go +++ b/cmd/getpipelinebook/main.go @@ -2,6 +2,7 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// getpipelinebook downloads the pipeline results for a book. package main import ( diff --git a/cmd/lspipeline/main.go b/cmd/lspipeline/main.go index ab2f8b1..b649778 100644 --- a/cmd/lspipeline/main.go +++ b/cmd/lspipeline/main.go @@ -2,6 +2,7 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// lspipeline lists useful things related to the book pipeline. package main import ( diff --git a/cmd/mkpipeline/main.go b/cmd/mkpipeline/main.go index b15e9ef..f3e1258 100644 --- a/cmd/mkpipeline/main.go +++ b/cmd/mkpipeline/main.go @@ -2,6 +2,8 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// mkpipeline sets up the necessary buckets and queues for the book +// pipeline. package main import ( diff --git a/cmd/pagegraph/main.go b/cmd/pagegraph/main.go index 5750892..e6f8f54 100644 --- a/cmd/pagegraph/main.go +++ b/cmd/pagegraph/main.go @@ -2,6 +2,8 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// pagegraph creates a graph showing the average confidence of each +// word in a page of hOCR. package main import ( diff --git a/cmd/pdfbook/main.go b/cmd/pdfbook/main.go index 923d97e..0f72ecb 100644 --- a/cmd/pdfbook/main.go +++ b/cmd/pdfbook/main.go @@ -2,6 +2,8 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// pdfbook creates a searchable PDF from a directory of hOCR and +// image files. package main import ( diff --git a/cmd/spotme/main.go b/cmd/spotme/main.go index 3a6fe6f..1f7969d 100644 --- a/cmd/spotme/main.go +++ b/cmd/spotme/main.go @@ -2,6 +2,7 @@ // Use of this source code is governed by the GPLv3 // license that can be found in the LICENSE file. +// spotme creates new spot instances for the book pipeline. package main import ( |