From 3e842c09554ef6eac7688bdd53c21b143b286c93 Mon Sep 17 00:00:00 2001 From: flo Date: Mon, 18 Nov 2019 16:04:31 +0100 Subject: [PATCH 01/17] Make options its own paragraph --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d6113734..d1fd5be2 100644 --- a/README.md +++ b/README.md @@ -72,8 +72,9 @@ Arguments: ### ocrd-cis-train.sh Script to train a model from a list of ground-truth archives (see -ocrd-tool.json) for the post correction. The tool somewhat mimics the -behaviour of other ocrd tools: +ocrd-tool.json) for the post correction. + +The tool somewhat mimics the behaviour of other ocrd tools: * `--mets` for the workspace * `--log-level` is passed to other tools * `--parameter` is used as configuration From db5c61a9bfc652950b0818e2788759e5a242c5c1 Mon Sep 17 00:00:00 2001 From: flo Date: Mon, 18 Nov 2019 17:09:49 +0100 Subject: [PATCH 02/17] Simple tool to generate DITA documentation --- data/misc/ocrd-cis-dita.sh | 65 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 data/misc/ocrd-cis-dita.sh diff --git a/data/misc/ocrd-cis-dita.sh b/data/misc/ocrd-cis-dita.sh new file mode 100644 index 00000000..31b62ee3 --- /dev/null +++ b/data/misc/ocrd-cis-dita.sh @@ -0,0 +1,65 @@ +#!/bin/bash + +for tool in ocrd-cis-wer; do + dir="data/docs/$tool" + mkdir -p "$dir" || exit 1 + cat < "$dir/topicmap.xml" + + + + + + + + + + +EOF + + # tool + cat < "$dir/tool.md" +# Tool $tool +$(cat ocrd-tool.json | jq -r ".tools.\"$tool\".description") +EOF + + # parameters + cat < "$dir/parameters.md" +# Parameters +The tool $tool accepts the following configuration parameters: +\`\`\`json +$(cat ocrd-tool.json | jq ".tools.\"$tool\".parameters") +\`\`\` +EOF + + # installation + cat < "$dir/installation.md" +# Installation of $tool +1. (optional) Initialize virtualenv: \`python3 -m venv path/to/dir\` +2. Install ocrd_cis: \`make install\` +EOF + + blockn=0 + ofile="" + while read line; do + if echo "$line" | grep $tool > /dev/null; then + # echo "setting blockn=1" + ofile="$dir/Description.md" + echo "# Description of $tool" > "$ofile" + blockn=1 + elif [[ $blockn == 1 ]] && [[ "$line" == "" ]]; then + # echo "setting blockn=2" + ofile="$dir/Option.md" + echo "# Options for $tool" > "$ofile" + blockn=2 + elif [[ $blockn == 2 ]] && [[ "$line" == "" ]]; then + # echo "setting blockn=0" + blockn=0 + elif [[ $blockn == 1 ]] || [[ $blockn == 2 ]]; then + echo "$blockn $line"; + echo "$line" >> "$ofile" + fi + done < README.md +done From 4b0b5834697cbfb66386656b99c11dfe67c442c1 Mon Sep 17 00:00:00 2001 From: flo Date: Mon, 18 Nov 2019 17:10:22 +0100 Subject: [PATCH 03/17] Add version DITA documentation files --- data/docs/ocrd-cis-wer/Description.md | 3 +++ data/docs/ocrd-cis-wer/Option.md | 7 +++++++ data/docs/ocrd-cis-wer/installation.md | 3 +++ data/docs/ocrd-cis-wer/parameters.md | 16 ++++++++++++++++ data/docs/ocrd-cis-wer/tool.md | 2 ++ data/docs/ocrd-cis-wer/topicmap.xml | 13 +++++++++++++ 6 files changed, 44 insertions(+) create mode 100644 data/docs/ocrd-cis-wer/Description.md create mode 100644 data/docs/ocrd-cis-wer/Option.md create mode 100644 data/docs/ocrd-cis-wer/installation.md create mode 100644 data/docs/ocrd-cis-wer/parameters.md create mode 100644 data/docs/ocrd-cis-wer/tool.md create mode 100644 data/docs/ocrd-cis-wer/topicmap.xml diff --git a/data/docs/ocrd-cis-wer/Description.md b/data/docs/ocrd-cis-wer/Description.md new file mode 100644 index 00000000..cfaafcd1 --- /dev/null +++ b/data/docs/ocrd-cis-wer/Description.md @@ -0,0 +1,3 @@ +# Description of ocrd-cis-wer +Helper tool to calculate the word error rate aligned ocr files. It +writes a simple JSON-formated stats file to the given output file group. diff --git a/data/docs/ocrd-cis-wer/Option.md b/data/docs/ocrd-cis-wer/Option.md new file mode 100644 index 00000000..48dd7c5c --- /dev/null +++ b/data/docs/ocrd-cis-wer/Option.md @@ -0,0 +1,7 @@ +# Options for ocrd-cis-wer +Arguments: +* `--input-file-grp` input file group of aligned ocr results with +their respective ground truth. +* `--output-file-grp` name of the file group for the stats file +* `--log-level` set log level +* `--mets` path to METS file in workspace diff --git a/data/docs/ocrd-cis-wer/installation.md b/data/docs/ocrd-cis-wer/installation.md new file mode 100644 index 00000000..fbdd34b9 --- /dev/null +++ b/data/docs/ocrd-cis-wer/installation.md @@ -0,0 +1,3 @@ +# Installation of ocrd-cis-wer +1. (optional) Initialize virtualenv: `python3 -m venv path/to/dir` +2. Install ocrd_cis: `make install` diff --git a/data/docs/ocrd-cis-wer/parameters.md b/data/docs/ocrd-cis-wer/parameters.md new file mode 100644 index 00000000..1f53ff5b --- /dev/null +++ b/data/docs/ocrd-cis-wer/parameters.md @@ -0,0 +1,16 @@ +# Parameters +The tool ocrd-cis-wer accepts the following configuration parameters: +```json +{ + "testIndex": { + "description": "text equiv index for the test/ocr tokens", + "type": "integer", + "default": 0 + }, + "gtIndex": { + "type": "integer", + "description": "text equiv index for the gt tokens", + "default": -1 + } +} +``` diff --git a/data/docs/ocrd-cis-wer/tool.md b/data/docs/ocrd-cis-wer/tool.md new file mode 100644 index 00000000..f7d9b4c2 --- /dev/null +++ b/data/docs/ocrd-cis-wer/tool.md @@ -0,0 +1,2 @@ +# Tool ocrd-cis-wer +calculate the word error rate for aligned page xml files diff --git a/data/docs/ocrd-cis-wer/topicmap.xml b/data/docs/ocrd-cis-wer/topicmap.xml new file mode 100644 index 00000000..8b97df24 --- /dev/null +++ b/data/docs/ocrd-cis-wer/topicmap.xml @@ -0,0 +1,13 @@ + + + + + + + + + + From c4dd01e5161393bb72c4828dc27f32827bd9655a Mon Sep 17 00:00:00 2001 From: flo Date: Mon, 18 Nov 2019 17:17:20 +0100 Subject: [PATCH 04/17] Add --parameter flag to documentation --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d1fd5be2..9fc0a513 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,7 @@ Helper tool to calculate the word error rate aligned ocr files. It writes a simple JSON-formated stats file to the given output file group. Arguments: + * `--parameter` set configuration file * `--input-file-grp` input file group of aligned ocr results with their respective ground truth. * `--output-file-grp` name of the file group for the stats file From 4e21f2f34e26d90b0945522f22c2ae5d87ca4967 Mon Sep 17 00:00:00 2001 From: flo Date: Mon, 18 Nov 2019 17:19:24 +0100 Subject: [PATCH 05/17] Improve output --- data/misc/ocrd-cis-dita.sh | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/data/misc/ocrd-cis-dita.sh b/data/misc/ocrd-cis-dita.sh index 31b62ee3..fbc1fbc8 100644 --- a/data/misc/ocrd-cis-dita.sh +++ b/data/misc/ocrd-cis-dita.sh @@ -21,13 +21,13 @@ EOF # tool cat < "$dir/tool.md" -# Tool $tool +# Tool $tool {#Tool .concept} $(cat ocrd-tool.json | jq -r ".tools.\"$tool\".description") EOF # parameters cat < "$dir/parameters.md" -# Parameters +# Parameters {#parameters .reference} The tool $tool accepts the following configuration parameters: \`\`\`json $(cat ocrd-tool.json | jq ".tools.\"$tool\".parameters") @@ -36,7 +36,7 @@ EOF # installation cat < "$dir/installation.md" -# Installation of $tool +# Installation of $tool {#installation .task} 1. (optional) Initialize virtualenv: \`python3 -m venv path/to/dir\` 2. Install ocrd_cis: \`make install\` EOF @@ -47,18 +47,18 @@ EOF if echo "$line" | grep $tool > /dev/null; then # echo "setting blockn=1" ofile="$dir/Description.md" - echo "# Description of $tool" > "$ofile" + echo "# Description of $tool {#Description .concept}" > "$ofile" blockn=1 elif [[ $blockn == 1 ]] && [[ "$line" == "" ]]; then # echo "setting blockn=2" ofile="$dir/Option.md" - echo "# Options for $tool" > "$ofile" + echo "# Options for $tool {#Option .reference}" > "$ofile" blockn=2 elif [[ $blockn == 2 ]] && [[ "$line" == "" ]]; then # echo "setting blockn=0" blockn=0 elif [[ $blockn == 1 ]] || [[ $blockn == 2 ]]; then - echo "$blockn $line"; + # echo "$blockn $line"; echo "$line" >> "$ofile" fi done < README.md From 6d4d44a9d69246b7a624c4aabe7131441b49e046 Mon Sep 17 00:00:00 2001 From: flo Date: Mon, 18 Nov 2019 17:19:41 +0100 Subject: [PATCH 06/17] Update documentation --- data/docs/ocrd-cis-wer/Description.md | 2 +- data/docs/ocrd-cis-wer/Option.md | 3 ++- data/docs/ocrd-cis-wer/installation.md | 2 +- data/docs/ocrd-cis-wer/parameters.md | 2 +- data/docs/ocrd-cis-wer/tool.md | 2 +- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/data/docs/ocrd-cis-wer/Description.md b/data/docs/ocrd-cis-wer/Description.md index cfaafcd1..7938916c 100644 --- a/data/docs/ocrd-cis-wer/Description.md +++ b/data/docs/ocrd-cis-wer/Description.md @@ -1,3 +1,3 @@ -# Description of ocrd-cis-wer +# Description of ocrd-cis-wer {#Description .concept} Helper tool to calculate the word error rate aligned ocr files. It writes a simple JSON-formated stats file to the given output file group. diff --git a/data/docs/ocrd-cis-wer/Option.md b/data/docs/ocrd-cis-wer/Option.md index 48dd7c5c..c726ac2e 100644 --- a/data/docs/ocrd-cis-wer/Option.md +++ b/data/docs/ocrd-cis-wer/Option.md @@ -1,5 +1,6 @@ -# Options for ocrd-cis-wer +# Options for ocrd-cis-wer {#Option .reference} Arguments: +* `--parameter` set configuration file * `--input-file-grp` input file group of aligned ocr results with their respective ground truth. * `--output-file-grp` name of the file group for the stats file diff --git a/data/docs/ocrd-cis-wer/installation.md b/data/docs/ocrd-cis-wer/installation.md index fbdd34b9..da1cf3ec 100644 --- a/data/docs/ocrd-cis-wer/installation.md +++ b/data/docs/ocrd-cis-wer/installation.md @@ -1,3 +1,3 @@ -# Installation of ocrd-cis-wer +# Installation of ocrd-cis-wer {#installation .task} 1. (optional) Initialize virtualenv: `python3 -m venv path/to/dir` 2. Install ocrd_cis: `make install` diff --git a/data/docs/ocrd-cis-wer/parameters.md b/data/docs/ocrd-cis-wer/parameters.md index 1f53ff5b..622aadfe 100644 --- a/data/docs/ocrd-cis-wer/parameters.md +++ b/data/docs/ocrd-cis-wer/parameters.md @@ -1,4 +1,4 @@ -# Parameters +# Parameters {#parameters .reference} The tool ocrd-cis-wer accepts the following configuration parameters: ```json { diff --git a/data/docs/ocrd-cis-wer/tool.md b/data/docs/ocrd-cis-wer/tool.md index f7d9b4c2..329b2423 100644 --- a/data/docs/ocrd-cis-wer/tool.md +++ b/data/docs/ocrd-cis-wer/tool.md @@ -1,2 +1,2 @@ -# Tool ocrd-cis-wer +# Tool ocrd-cis-wer {#Tool .concept} calculate the word error rate for aligned page xml files From f3cbd02cd39aa19ca0224c8e4b7d92960ddd4833 Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 10:24:28 +0100 Subject: [PATCH 07/17] User lower case file names --- .../ocrd-cis-wer/{Description.md => description.md} | 2 +- data/docs/ocrd-cis-wer/{Option.md => option.md} | 2 +- data/docs/ocrd-cis-wer/topicmap.xml | 4 ++-- data/misc/ocrd-cis-dita.sh | 12 ++++++------ 4 files changed, 10 insertions(+), 10 deletions(-) rename data/docs/ocrd-cis-wer/{Description.md => description.md} (72%) rename data/docs/ocrd-cis-wer/{Option.md => option.md} (85%) diff --git a/data/docs/ocrd-cis-wer/Description.md b/data/docs/ocrd-cis-wer/description.md similarity index 72% rename from data/docs/ocrd-cis-wer/Description.md rename to data/docs/ocrd-cis-wer/description.md index 7938916c..2d89cfb8 100644 --- a/data/docs/ocrd-cis-wer/Description.md +++ b/data/docs/ocrd-cis-wer/description.md @@ -1,3 +1,3 @@ -# Description of ocrd-cis-wer {#Description .concept} +# Description of ocrd-cis-wer {#description .concept} Helper tool to calculate the word error rate aligned ocr files. It writes a simple JSON-formated stats file to the given output file group. diff --git a/data/docs/ocrd-cis-wer/Option.md b/data/docs/ocrd-cis-wer/option.md similarity index 85% rename from data/docs/ocrd-cis-wer/Option.md rename to data/docs/ocrd-cis-wer/option.md index c726ac2e..576f908b 100644 --- a/data/docs/ocrd-cis-wer/Option.md +++ b/data/docs/ocrd-cis-wer/option.md @@ -1,4 +1,4 @@ -# Options for ocrd-cis-wer {#Option .reference} +# Options for ocrd-cis-wer {#option .reference} Arguments: * `--parameter` set configuration file * `--input-file-grp` input file group of aligned ocr results with diff --git a/data/docs/ocrd-cis-wer/topicmap.xml b/data/docs/ocrd-cis-wer/topicmap.xml index 8b97df24..8dc542c3 100644 --- a/data/docs/ocrd-cis-wer/topicmap.xml +++ b/data/docs/ocrd-cis-wer/topicmap.xml @@ -2,9 +2,9 @@ - + - + + + + diff --git a/data/misc/ocrd-cis-dita.sh b/data/misc/ocrd-cis-dita.sh index 0dd9ab83..0c75c0b7 100644 --- a/data/misc/ocrd-cis-dita.sh +++ b/data/misc/ocrd-cis-dita.sh @@ -7,19 +7,25 @@ for tool in ocrd-cis-wer; do + + + - - + + + EOF - # tool + # name + cat < "$dir/name.md" +# $tool +EOF + + # simple description cat < "$dir/tool.md" # Tool $tool {#Tool .concept} $(cat ocrd-tool.json | jq -r ".tools.\"$tool\".description") @@ -41,6 +47,31 @@ EOF 2. Install ocrd_cis: \`make install\` EOF + # release notes + cat < "$dir/release_notes.md" +# Release notes +EOF + + # Authors + cat< "$dir/authors.md" +# Authors +1. Christoph Weber +2. Florian Fink +3. Robert Sachunsky +4. Tobias Englmeier +EOF + + # Reporting + cat< "$dir/reporting.md" +# Reporting +Reports any bugs/problems at the [issues page](https://github.com/cisocrgroup/ocrd_cis/issues) +EOF + + # Copyright + echo "# License" > "$dir/copyright.md" + cat LICENSE >> "$dir/copyright.md" + + # generate description and options from README.md blockn=0 ofile="" while read line; do From e3ac0aa18b36883dc99476591eb415e6c99809e3 Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:11:54 +0100 Subject: [PATCH 10/17] Fix grammar --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6386c5e5..2638a516 100644 --- a/README.md +++ b/README.md @@ -87,8 +87,9 @@ Helper tool to get the path of the installed data files. Usage: path to th default 3-grams language model file. ### ocrd-cis-wer -Helper tool to calculate the word error rate aligned ocr files. It -writes a simple JSON-formated stats file to the given output file group. +Helper tool to calculate the word error rate of aligned ocr files. It +writes a simple JSON-formated stats file to the given output file +group. This tool accepts the following Arguments: * `--parameter` set configuration file From 0846c367ad1ff0ce79509c11749f7a61a7cc4698 Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:12:41 +0100 Subject: [PATCH 11/17] Generate templates for other files --- data/docs/ocrd-cis-wer/glossary.xml | 42 ++++++++ .../ocrd-cis-wer/inputFormatDescription.md | 1 + .../ocrd-cis-wer/outputFormatDescription.md | 1 + data/docs/ocrd-cis-wer/topicmap.xml | 4 + data/docs/ocrd-cis-wer/troubleshooting.xml | 29 +++++ data/misc/ocrd-cis-dita.sh | 100 ++++++++++++++++++ 6 files changed, 177 insertions(+) create mode 100644 data/docs/ocrd-cis-wer/glossary.xml create mode 100644 data/docs/ocrd-cis-wer/inputFormatDescription.md create mode 100644 data/docs/ocrd-cis-wer/outputFormatDescription.md create mode 100644 data/docs/ocrd-cis-wer/troubleshooting.xml diff --git a/data/docs/ocrd-cis-wer/glossary.xml b/data/docs/ocrd-cis-wer/glossary.xml new file mode 100644 index 00000000..02bcee21 --- /dev/null +++ b/data/docs/ocrd-cis-wer/glossary.xml @@ -0,0 +1,42 @@ + + + + Glossar + + + diff --git a/data/docs/ocrd-cis-wer/inputFormatDescription.md b/data/docs/ocrd-cis-wer/inputFormatDescription.md new file mode 100644 index 00000000..767d563c --- /dev/null +++ b/data/docs/ocrd-cis-wer/inputFormatDescription.md @@ -0,0 +1 @@ +# Input format {#inputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-wer/outputFormatDescription.md b/data/docs/ocrd-cis-wer/outputFormatDescription.md new file mode 100644 index 00000000..89486585 --- /dev/null +++ b/data/docs/ocrd-cis-wer/outputFormatDescription.md @@ -0,0 +1 @@ +# Output format {#outputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-wer/topicmap.xml b/data/docs/ocrd-cis-wer/topicmap.xml index 3751b0a1..a3c13f10 100644 --- a/data/docs/ocrd-cis-wer/topicmap.xml +++ b/data/docs/ocrd-cis-wer/topicmap.xml @@ -7,7 +7,11 @@ + + + + diff --git a/data/docs/ocrd-cis-wer/troubleshooting.xml b/data/docs/ocrd-cis-wer/troubleshooting.xml new file mode 100644 index 00000000..2d113697 --- /dev/null +++ b/data/docs/ocrd-cis-wer/troubleshooting.xml @@ -0,0 +1,29 @@ + + + + Troubleshooting + + diff --git a/data/misc/ocrd-cis-dita.sh b/data/misc/ocrd-cis-dita.sh index 0c75c0b7..a0d040fc 100644 --- a/data/misc/ocrd-cis-dita.sh +++ b/data/misc/ocrd-cis-dita.sh @@ -13,7 +13,11 @@ for tool in ocrd-cis-wer; do + + + + @@ -71,6 +75,102 @@ EOF echo "# License" > "$dir/copyright.md" cat LICENSE >> "$dir/copyright.md" + # input format description + if [[ ! -f "$dir/inputFormatDescription.md" ]]; then + cat< "$dir/inputFormatDescription.md" +# Input format {#inputFormatDescription .reference} +EOF + fi + + # output format description + if [[ ! -f "$dir/outputFormatDescription.md" ]]; then + cat< "$dir/outputFormatDescription.md" +# Output format {#outputFormatDescription .reference} +EOF + fi + + # Troubleshooting + if [[ ! -f "$dir/troubleshooting.xml" ]]; then + cat< "$dir/troubleshooting.xml" + + + + Troubleshooting + + +EOF + fi + + if [[ ! -f "$dir/glossary.xml" ]]; then + cat< "$dir/glossary.xml" + + + + Glossar + + + +EOF + fi + # generate description and options from README.md blockn=0 ofile="" From e834ff378eea0a8e61fb4ced142346cc3184b4dd Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:19:10 +0100 Subject: [PATCH 12/17] iterate over tools --- data/misc/ocrd-cis-dita.sh | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/data/misc/ocrd-cis-dita.sh b/data/misc/ocrd-cis-dita.sh index a0d040fc..9555314e 100644 --- a/data/misc/ocrd-cis-dita.sh +++ b/data/misc/ocrd-cis-dita.sh @@ -1,8 +1,25 @@ #!/bin/bash -for tool in ocrd-cis-wer; do +overwrite=false +tools="" +for arg in $*; do + case $arg in + -f|--force) + overwrite=true;; + *) + tools="$arg $tools" + ;; + esac +done + +for tool in $tools; do dir="data/docs/$tool" + if [[ $overwrite == true ]]; then + rm -rf "$dir" + fi mkdir -p "$dir" || exit 1 + + # topicmap cat < "$dir/topicmap.xml" From 5322684f625e5785af410fff4005132bad73d65d Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:20:16 +0100 Subject: [PATCH 13/17] Update description --- data/docs/ocrd-cis-wer/description.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/data/docs/ocrd-cis-wer/description.md b/data/docs/ocrd-cis-wer/description.md index 2d89cfb8..b8ff32e2 100644 --- a/data/docs/ocrd-cis-wer/description.md +++ b/data/docs/ocrd-cis-wer/description.md @@ -1,3 +1,4 @@ # Description of ocrd-cis-wer {#description .concept} -Helper tool to calculate the word error rate aligned ocr files. It -writes a simple JSON-formated stats file to the given output file group. +Helper tool to calculate the word error rate of aligned ocr files. It +writes a simple JSON-formated stats file to the given output file +group. From 880835ac1170286fb392bea9a822b855728a3147 Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:30:31 +0100 Subject: [PATCH 14/17] Update installation instrcutions --- data/docs/ocrd-cis-wer/installation.md | 3 ++- data/misc/ocrd-cis-dita.sh | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/data/docs/ocrd-cis-wer/installation.md b/data/docs/ocrd-cis-wer/installation.md index da1cf3ec..bd00e27b 100644 --- a/data/docs/ocrd-cis-wer/installation.md +++ b/data/docs/ocrd-cis-wer/installation.md @@ -1,3 +1,4 @@ # Installation of ocrd-cis-wer {#installation .task} -1. (optional) Initialize virtualenv: `python3 -m venv path/to/dir` +1. Initialize virtualenv: `python3 -m venv path/to/dir` (optional) 2. Install ocrd_cis: `make install` +3. Test the installation: `make test` (optional) diff --git a/data/misc/ocrd-cis-dita.sh b/data/misc/ocrd-cis-dita.sh index 9555314e..27940567 100644 --- a/data/misc/ocrd-cis-dita.sh +++ b/data/misc/ocrd-cis-dita.sh @@ -64,8 +64,9 @@ EOF # installation cat < "$dir/installation.md" # Installation of $tool {#installation .task} -1. (optional) Initialize virtualenv: \`python3 -m venv path/to/dir\` +1. Initialize virtualenv: \`python3 -m venv path/to/dir\` (optional) 2. Install ocrd_cis: \`make install\` +3. Test the installation: \`make test\` (optional) EOF # release notes From 278cdf40e1554b50f8c91375f6369a81570c8476 Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:31:37 +0100 Subject: [PATCH 15/17] Add output format description --- data/docs/ocrd-cis-wer/outputFormatDescription.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/data/docs/ocrd-cis-wer/outputFormatDescription.md b/data/docs/ocrd-cis-wer/outputFormatDescription.md index 89486585..3f6637d1 100644 --- a/data/docs/ocrd-cis-wer/outputFormatDescription.md +++ b/data/docs/ocrd-cis-wer/outputFormatDescription.md @@ -1 +1,10 @@ # Output format {#outputFormatDescription .reference} + +```json +{ + "totalWords": 3, + "correctWords": 2, + "incorrectWords": 1, + "wordErrorRate": .3 +} +``` From 3fc7dbce11a55144e7147e4c43b518e72ee2207e Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:35:42 +0100 Subject: [PATCH 16/17] Add empty parameters entry to ocrd-cis-align --- ocrd_cis/ocrd-tool.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ocrd_cis/ocrd-tool.json b/ocrd_cis/ocrd-tool.json index ae762948..b3d4b674 100644 --- a/ocrd_cis/ocrd-tool.json +++ b/ocrd_cis/ocrd-tool.json @@ -342,7 +342,8 @@ "steps": [ "postprocessing/alignment" ], - "description": "Align multiple OCRs and/or GTs" + "description": "Align multiple OCRs and/or GTs", + "parameters": {} }, "ocrd-cis-wer": { "executable": "ocrd-cis-wer", From 7dff41b273e7f262d7a9d1ea030690aa018e846f Mon Sep 17 00:00:00 2001 From: flo Date: Tue, 19 Nov 2019 12:49:38 +0100 Subject: [PATCH 17/17] Generate basic dita files --- data/docs/ocrd-cis-align/authors.md | 5 +++ data/docs/ocrd-cis-align/copyright.md | 22 ++++++++++ data/docs/ocrd-cis-align/description.md | 5 +++ data/docs/ocrd-cis-align/glossary.xml | 42 +++++++++++++++++++ .../ocrd-cis-align/inputFormatDescription.md | 1 + data/docs/ocrd-cis-align/installation.md | 4 ++ data/docs/ocrd-cis-align/name.md | 1 + data/docs/ocrd-cis-align/option.md | 8 ++++ .../ocrd-cis-align/outputFormatDescription.md | 1 + data/docs/ocrd-cis-align/parameters.md | 5 +++ data/docs/ocrd-cis-align/release_notes.md | 1 + data/docs/ocrd-cis-align/reporting.md | 2 + data/docs/ocrd-cis-align/tool.md | 2 + data/docs/ocrd-cis-align/topicmap.xml | 18 ++++++++ data/docs/ocrd-cis-align/troubleshooting.xml | 29 +++++++++++++ data/docs/ocrd-cis-post-correct.sh/authors.md | 5 +++ .../ocrd-cis-post-correct.sh/copyright.md | 22 ++++++++++ .../ocrd-cis-post-correct.sh/description.md | 5 +++ .../ocrd-cis-post-correct.sh/glossary.xml | 42 +++++++++++++++++++ .../inputFormatDescription.md | 1 + .../ocrd-cis-post-correct.sh/installation.md | 4 ++ data/docs/ocrd-cis-post-correct.sh/name.md | 1 + data/docs/ocrd-cis-post-correct.sh/option.md | 7 ++++ .../outputFormatDescription.md | 1 + .../ocrd-cis-post-correct.sh/parameters.md | 5 +++ .../ocrd-cis-post-correct.sh/release_notes.md | 1 + .../ocrd-cis-post-correct.sh/reporting.md | 2 + data/docs/ocrd-cis-post-correct.sh/tool.md | 2 + .../ocrd-cis-post-correct.sh/topicmap.xml | 18 ++++++++ .../troubleshooting.xml | 29 +++++++++++++ data/docs/ocrd-cis-train.sh/authors.md | 5 +++ data/docs/ocrd-cis-train.sh/copyright.md | 22 ++++++++++ data/docs/ocrd-cis-train.sh/description.md | 3 ++ data/docs/ocrd-cis-train.sh/glossary.xml | 42 +++++++++++++++++++ .../inputFormatDescription.md | 1 + data/docs/ocrd-cis-train.sh/installation.md | 4 ++ data/docs/ocrd-cis-train.sh/name.md | 1 + data/docs/ocrd-cis-train.sh/option.md | 7 ++++ .../outputFormatDescription.md | 1 + data/docs/ocrd-cis-train.sh/parameters.md | 5 +++ data/docs/ocrd-cis-train.sh/release_notes.md | 1 + data/docs/ocrd-cis-train.sh/reporting.md | 2 + data/docs/ocrd-cis-train.sh/tool.md | 2 + data/docs/ocrd-cis-train.sh/topicmap.xml | 18 ++++++++ .../ocrd-cis-train.sh/troubleshooting.xml | 29 +++++++++++++ 45 files changed, 434 insertions(+) create mode 100644 data/docs/ocrd-cis-align/authors.md create mode 100644 data/docs/ocrd-cis-align/copyright.md create mode 100644 data/docs/ocrd-cis-align/description.md create mode 100644 data/docs/ocrd-cis-align/glossary.xml create mode 100644 data/docs/ocrd-cis-align/inputFormatDescription.md create mode 100644 data/docs/ocrd-cis-align/installation.md create mode 100644 data/docs/ocrd-cis-align/name.md create mode 100644 data/docs/ocrd-cis-align/option.md create mode 100644 data/docs/ocrd-cis-align/outputFormatDescription.md create mode 100644 data/docs/ocrd-cis-align/parameters.md create mode 100644 data/docs/ocrd-cis-align/release_notes.md create mode 100644 data/docs/ocrd-cis-align/reporting.md create mode 100644 data/docs/ocrd-cis-align/tool.md create mode 100644 data/docs/ocrd-cis-align/topicmap.xml create mode 100644 data/docs/ocrd-cis-align/troubleshooting.xml create mode 100644 data/docs/ocrd-cis-post-correct.sh/authors.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/copyright.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/description.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/glossary.xml create mode 100644 data/docs/ocrd-cis-post-correct.sh/inputFormatDescription.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/installation.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/name.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/option.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/outputFormatDescription.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/parameters.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/release_notes.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/reporting.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/tool.md create mode 100644 data/docs/ocrd-cis-post-correct.sh/topicmap.xml create mode 100644 data/docs/ocrd-cis-post-correct.sh/troubleshooting.xml create mode 100644 data/docs/ocrd-cis-train.sh/authors.md create mode 100644 data/docs/ocrd-cis-train.sh/copyright.md create mode 100644 data/docs/ocrd-cis-train.sh/description.md create mode 100644 data/docs/ocrd-cis-train.sh/glossary.xml create mode 100644 data/docs/ocrd-cis-train.sh/inputFormatDescription.md create mode 100644 data/docs/ocrd-cis-train.sh/installation.md create mode 100644 data/docs/ocrd-cis-train.sh/name.md create mode 100644 data/docs/ocrd-cis-train.sh/option.md create mode 100644 data/docs/ocrd-cis-train.sh/outputFormatDescription.md create mode 100644 data/docs/ocrd-cis-train.sh/parameters.md create mode 100644 data/docs/ocrd-cis-train.sh/release_notes.md create mode 100644 data/docs/ocrd-cis-train.sh/reporting.md create mode 100644 data/docs/ocrd-cis-train.sh/tool.md create mode 100644 data/docs/ocrd-cis-train.sh/topicmap.xml create mode 100644 data/docs/ocrd-cis-train.sh/troubleshooting.xml diff --git a/data/docs/ocrd-cis-align/authors.md b/data/docs/ocrd-cis-align/authors.md new file mode 100644 index 00000000..cbdb0060 --- /dev/null +++ b/data/docs/ocrd-cis-align/authors.md @@ -0,0 +1,5 @@ +# Authors +1. Christoph Weber +2. Florian Fink +3. Robert Sachunsky +4. Tobias Englmeier diff --git a/data/docs/ocrd-cis-align/copyright.md b/data/docs/ocrd-cis-align/copyright.md new file mode 100644 index 00000000..83cbbb55 --- /dev/null +++ b/data/docs/ocrd-cis-align/copyright.md @@ -0,0 +1,22 @@ +# License +MIT License + +Copyright (c) 2018 2018 Centrum für Informations- und Sprachverarbeitung (CIS) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/data/docs/ocrd-cis-align/description.md b/data/docs/ocrd-cis-align/description.md new file mode 100644 index 00000000..9c68dbec --- /dev/null +++ b/data/docs/ocrd-cis-align/description.md @@ -0,0 +1,5 @@ +# Description of ocrd-cis-align {#description .concept} +Aligns tokens of multiple input file groups to one output file group. +This tool is used to align the master OCR with any additional support +OCRs. It accepts a comma-separated list of input file groups, which +it aligns in order. diff --git a/data/docs/ocrd-cis-align/glossary.xml b/data/docs/ocrd-cis-align/glossary.xml new file mode 100644 index 00000000..02bcee21 --- /dev/null +++ b/data/docs/ocrd-cis-align/glossary.xml @@ -0,0 +1,42 @@ + + + + Glossar + + + diff --git a/data/docs/ocrd-cis-align/inputFormatDescription.md b/data/docs/ocrd-cis-align/inputFormatDescription.md new file mode 100644 index 00000000..767d563c --- /dev/null +++ b/data/docs/ocrd-cis-align/inputFormatDescription.md @@ -0,0 +1 @@ +# Input format {#inputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-align/installation.md b/data/docs/ocrd-cis-align/installation.md new file mode 100644 index 00000000..08ab18a8 --- /dev/null +++ b/data/docs/ocrd-cis-align/installation.md @@ -0,0 +1,4 @@ +# Installation of ocrd-cis-align {#installation .task} +1. Initialize virtualenv: `python3 -m venv path/to/dir` (optional) +2. Install ocrd_cis: `make install` +3. Test the installation: `make test` (optional) diff --git a/data/docs/ocrd-cis-align/name.md b/data/docs/ocrd-cis-align/name.md new file mode 100644 index 00000000..3cd5e368 --- /dev/null +++ b/data/docs/ocrd-cis-align/name.md @@ -0,0 +1 @@ +# ocrd-cis-align diff --git a/data/docs/ocrd-cis-align/option.md b/data/docs/ocrd-cis-align/option.md new file mode 100644 index 00000000..6b07e685 --- /dev/null +++ b/data/docs/ocrd-cis-align/option.md @@ -0,0 +1,8 @@ +# Options for ocrd-cis-align {#option .reference} +This tool accepts the following Arguments: +* `--parameter` path to configuration file +* `--input-file-grp` comma seperated list of the input file groups; +first input file group is the master OCR +* `--output-file-grp` name of the file group for the aligned result +* `--log-level` set log level +* `--mets` path to METS file in workspace diff --git a/data/docs/ocrd-cis-align/outputFormatDescription.md b/data/docs/ocrd-cis-align/outputFormatDescription.md new file mode 100644 index 00000000..89486585 --- /dev/null +++ b/data/docs/ocrd-cis-align/outputFormatDescription.md @@ -0,0 +1 @@ +# Output format {#outputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-align/parameters.md b/data/docs/ocrd-cis-align/parameters.md new file mode 100644 index 00000000..19b1ea55 --- /dev/null +++ b/data/docs/ocrd-cis-align/parameters.md @@ -0,0 +1,5 @@ +# Parameters {#parameters .reference} +The tool ocrd-cis-align accepts the following configuration parameters: +```json +{} +``` diff --git a/data/docs/ocrd-cis-align/release_notes.md b/data/docs/ocrd-cis-align/release_notes.md new file mode 100644 index 00000000..d7de275f --- /dev/null +++ b/data/docs/ocrd-cis-align/release_notes.md @@ -0,0 +1 @@ +# Release notes diff --git a/data/docs/ocrd-cis-align/reporting.md b/data/docs/ocrd-cis-align/reporting.md new file mode 100644 index 00000000..e71d72c5 --- /dev/null +++ b/data/docs/ocrd-cis-align/reporting.md @@ -0,0 +1,2 @@ +# Reporting +Reports any bugs/problems at the [issues page](https://github.com/cisocrgroup/ocrd_cis/issues) diff --git a/data/docs/ocrd-cis-align/tool.md b/data/docs/ocrd-cis-align/tool.md new file mode 100644 index 00000000..8636efca --- /dev/null +++ b/data/docs/ocrd-cis-align/tool.md @@ -0,0 +1,2 @@ +# Tool ocrd-cis-align {#Tool .concept} +Align multiple OCRs and/or GTs diff --git a/data/docs/ocrd-cis-align/topicmap.xml b/data/docs/ocrd-cis-align/topicmap.xml new file mode 100644 index 00000000..a3c13f10 --- /dev/null +++ b/data/docs/ocrd-cis-align/topicmap.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/data/docs/ocrd-cis-align/troubleshooting.xml b/data/docs/ocrd-cis-align/troubleshooting.xml new file mode 100644 index 00000000..2d113697 --- /dev/null +++ b/data/docs/ocrd-cis-align/troubleshooting.xml @@ -0,0 +1,29 @@ + + + + Troubleshooting + + diff --git a/data/docs/ocrd-cis-post-correct.sh/authors.md b/data/docs/ocrd-cis-post-correct.sh/authors.md new file mode 100644 index 00000000..cbdb0060 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/authors.md @@ -0,0 +1,5 @@ +# Authors +1. Christoph Weber +2. Florian Fink +3. Robert Sachunsky +4. Tobias Englmeier diff --git a/data/docs/ocrd-cis-post-correct.sh/copyright.md b/data/docs/ocrd-cis-post-correct.sh/copyright.md new file mode 100644 index 00000000..83cbbb55 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/copyright.md @@ -0,0 +1,22 @@ +# License +MIT License + +Copyright (c) 2018 2018 Centrum für Informations- und Sprachverarbeitung (CIS) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/data/docs/ocrd-cis-post-correct.sh/description.md b/data/docs/ocrd-cis-post-correct.sh/description.md new file mode 100644 index 00000000..20e543f4 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/description.md @@ -0,0 +1,5 @@ +# Description of ocrd-cis-post-correct.sh {#description .concept} +This bash script runs the post correction using a pre-trained +[model](http://cis.lmu.de/~finkf/model.zip). If additional support +OCRs should be used, models for these OCR steps are required and must +be configured in an according configuration file (see ocrd-tool.json). diff --git a/data/docs/ocrd-cis-post-correct.sh/glossary.xml b/data/docs/ocrd-cis-post-correct.sh/glossary.xml new file mode 100644 index 00000000..02bcee21 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/glossary.xml @@ -0,0 +1,42 @@ + + + + Glossar + + + diff --git a/data/docs/ocrd-cis-post-correct.sh/inputFormatDescription.md b/data/docs/ocrd-cis-post-correct.sh/inputFormatDescription.md new file mode 100644 index 00000000..767d563c --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/inputFormatDescription.md @@ -0,0 +1 @@ +# Input format {#inputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-post-correct.sh/installation.md b/data/docs/ocrd-cis-post-correct.sh/installation.md new file mode 100644 index 00000000..4c22504d --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/installation.md @@ -0,0 +1,4 @@ +# Installation of ocrd-cis-post-correct.sh {#installation .task} +1. Initialize virtualenv: `python3 -m venv path/to/dir` (optional) +2. Install ocrd_cis: `make install` +3. Test the installation: `make test` (optional) diff --git a/data/docs/ocrd-cis-post-correct.sh/name.md b/data/docs/ocrd-cis-post-correct.sh/name.md new file mode 100644 index 00000000..570c5151 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/name.md @@ -0,0 +1 @@ +# ocrd-cis-post-correct.sh diff --git a/data/docs/ocrd-cis-post-correct.sh/option.md b/data/docs/ocrd-cis-post-correct.sh/option.md new file mode 100644 index 00000000..294bf986 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/option.md @@ -0,0 +1,7 @@ +# Options for ocrd-cis-post-correct.sh {#option .reference} +This tool accepts the following Arguments: +* `--parameter` path to configuration file +* `--input-file-grp` name of the master-OCR file group +* `--output-file-grp` name of the post-correction file group +* `--log-level` set log level +* `--mets` path to METS file in workspace diff --git a/data/docs/ocrd-cis-post-correct.sh/outputFormatDescription.md b/data/docs/ocrd-cis-post-correct.sh/outputFormatDescription.md new file mode 100644 index 00000000..89486585 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/outputFormatDescription.md @@ -0,0 +1 @@ +# Output format {#outputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-post-correct.sh/parameters.md b/data/docs/ocrd-cis-post-correct.sh/parameters.md new file mode 100644 index 00000000..7c38ab60 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/parameters.md @@ -0,0 +1,5 @@ +# Parameters {#parameters .reference} +The tool ocrd-cis-post-correct.sh accepts the following configuration parameters: +```json +null +``` diff --git a/data/docs/ocrd-cis-post-correct.sh/release_notes.md b/data/docs/ocrd-cis-post-correct.sh/release_notes.md new file mode 100644 index 00000000..d7de275f --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/release_notes.md @@ -0,0 +1 @@ +# Release notes diff --git a/data/docs/ocrd-cis-post-correct.sh/reporting.md b/data/docs/ocrd-cis-post-correct.sh/reporting.md new file mode 100644 index 00000000..e71d72c5 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/reporting.md @@ -0,0 +1,2 @@ +# Reporting +Reports any bugs/problems at the [issues page](https://github.com/cisocrgroup/ocrd_cis/issues) diff --git a/data/docs/ocrd-cis-post-correct.sh/tool.md b/data/docs/ocrd-cis-post-correct.sh/tool.md new file mode 100644 index 00000000..e45ae45f --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/tool.md @@ -0,0 +1,2 @@ +# Tool ocrd-cis-post-correct.sh {#Tool .concept} +null diff --git a/data/docs/ocrd-cis-post-correct.sh/topicmap.xml b/data/docs/ocrd-cis-post-correct.sh/topicmap.xml new file mode 100644 index 00000000..a3c13f10 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/topicmap.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/data/docs/ocrd-cis-post-correct.sh/troubleshooting.xml b/data/docs/ocrd-cis-post-correct.sh/troubleshooting.xml new file mode 100644 index 00000000..2d113697 --- /dev/null +++ b/data/docs/ocrd-cis-post-correct.sh/troubleshooting.xml @@ -0,0 +1,29 @@ + + + + Troubleshooting + + diff --git a/data/docs/ocrd-cis-train.sh/authors.md b/data/docs/ocrd-cis-train.sh/authors.md new file mode 100644 index 00000000..cbdb0060 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/authors.md @@ -0,0 +1,5 @@ +# Authors +1. Christoph Weber +2. Florian Fink +3. Robert Sachunsky +4. Tobias Englmeier diff --git a/data/docs/ocrd-cis-train.sh/copyright.md b/data/docs/ocrd-cis-train.sh/copyright.md new file mode 100644 index 00000000..83cbbb55 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/copyright.md @@ -0,0 +1,22 @@ +# License +MIT License + +Copyright (c) 2018 2018 Centrum für Informations- und Sprachverarbeitung (CIS) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/data/docs/ocrd-cis-train.sh/description.md b/data/docs/ocrd-cis-train.sh/description.md new file mode 100644 index 00000000..3648ddc3 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/description.md @@ -0,0 +1,3 @@ +# Description of ocrd-cis-train.sh {#description .concept} +Script to train a model from a list of ground-truth archives (see +ocrd-tool.json) for the post correction. diff --git a/data/docs/ocrd-cis-train.sh/glossary.xml b/data/docs/ocrd-cis-train.sh/glossary.xml new file mode 100644 index 00000000..02bcee21 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/glossary.xml @@ -0,0 +1,42 @@ + + + + Glossar + + + diff --git a/data/docs/ocrd-cis-train.sh/inputFormatDescription.md b/data/docs/ocrd-cis-train.sh/inputFormatDescription.md new file mode 100644 index 00000000..767d563c --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/inputFormatDescription.md @@ -0,0 +1 @@ +# Input format {#inputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-train.sh/installation.md b/data/docs/ocrd-cis-train.sh/installation.md new file mode 100644 index 00000000..1f53c798 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/installation.md @@ -0,0 +1,4 @@ +# Installation of ocrd-cis-train.sh {#installation .task} +1. Initialize virtualenv: `python3 -m venv path/to/dir` (optional) +2. Install ocrd_cis: `make install` +3. Test the installation: `make test` (optional) diff --git a/data/docs/ocrd-cis-train.sh/name.md b/data/docs/ocrd-cis-train.sh/name.md new file mode 100644 index 00000000..8ac81f55 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/name.md @@ -0,0 +1 @@ +# ocrd-cis-train.sh diff --git a/data/docs/ocrd-cis-train.sh/option.md b/data/docs/ocrd-cis-train.sh/option.md new file mode 100644 index 00000000..d4350786 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/option.md @@ -0,0 +1,7 @@ +# Options for ocrd-cis-train.sh {#option .reference} +The tool somewhat mimics the behaviour of other ocrd tools and accepts +the following Arguments: +* `--mets` for the workspace +* `--log-level` is passed to other tools +* `--parameter` is used as configuration +* `--output-file-grp` defines the output file group for the model diff --git a/data/docs/ocrd-cis-train.sh/outputFormatDescription.md b/data/docs/ocrd-cis-train.sh/outputFormatDescription.md new file mode 100644 index 00000000..89486585 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/outputFormatDescription.md @@ -0,0 +1 @@ +# Output format {#outputFormatDescription .reference} diff --git a/data/docs/ocrd-cis-train.sh/parameters.md b/data/docs/ocrd-cis-train.sh/parameters.md new file mode 100644 index 00000000..abdb8b55 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/parameters.md @@ -0,0 +1,5 @@ +# Parameters {#parameters .reference} +The tool ocrd-cis-train.sh accepts the following configuration parameters: +```json +null +``` diff --git a/data/docs/ocrd-cis-train.sh/release_notes.md b/data/docs/ocrd-cis-train.sh/release_notes.md new file mode 100644 index 00000000..d7de275f --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/release_notes.md @@ -0,0 +1 @@ +# Release notes diff --git a/data/docs/ocrd-cis-train.sh/reporting.md b/data/docs/ocrd-cis-train.sh/reporting.md new file mode 100644 index 00000000..e71d72c5 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/reporting.md @@ -0,0 +1,2 @@ +# Reporting +Reports any bugs/problems at the [issues page](https://github.com/cisocrgroup/ocrd_cis/issues) diff --git a/data/docs/ocrd-cis-train.sh/tool.md b/data/docs/ocrd-cis-train.sh/tool.md new file mode 100644 index 00000000..da241f2e --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/tool.md @@ -0,0 +1,2 @@ +# Tool ocrd-cis-train.sh {#Tool .concept} +null diff --git a/data/docs/ocrd-cis-train.sh/topicmap.xml b/data/docs/ocrd-cis-train.sh/topicmap.xml new file mode 100644 index 00000000..a3c13f10 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/topicmap.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/data/docs/ocrd-cis-train.sh/troubleshooting.xml b/data/docs/ocrd-cis-train.sh/troubleshooting.xml new file mode 100644 index 00000000..2d113697 --- /dev/null +++ b/data/docs/ocrd-cis-train.sh/troubleshooting.xml @@ -0,0 +1,29 @@ + + + + Troubleshooting + +