Calamari2

.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  codecov: codecov/codecov@3.3.0
+  codecov: codecov/codecov@5.0.3
 
 jobs:
   test:
@@ -21,13 +21,21 @@ jobs:
           paths:
             - "~/.cache/pip"
       - run: pip3 install --upgrade pip
-      - run: make install deps-test-ubuntu PIP_INSTALL="pip3 install"
-      - run: make coverage
-      - codecov/upload
+      - run: 
+          name: install dependencies and package
+          command: make deps-test-ubuntu install PIP_INSTALL="pip3 install"
       - save_cache:
           key: v01-pydeps-<< parameters.python-image >>-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
           paths:
             - "~/.cache/pip"
+      - run: 
+          name: run regression test and coverage test
+          command: make coverage
+          no_output_timeout: 30m
+      - codecov/upload
+      - store_artifacts:
+          path: htmlcov
+    resource_class: large
 
 workflows:
   build:

Makefile

@@ -2,8 +2,12 @@ export  # export variables to subshells
 PIP_INSTALL = pip3 install
 GIT_CLONE = git clone
 PYTHON = python3
-PYTEST_ARGS = -W 'ignore::DeprecationWarning' -W 'ignore::FutureWarning'
-MODEL = qurator-gt4histocr-1.0
+PYTEST_ARGS = -W 'ignore::DeprecationWarning' -W 'ignore::FutureWarning' -vv
+# not usable with Calamari 2 ATM - see Calamari#362
+#MODEL = qurator-gt4histocr-1.0 # cannot be migrated to Calamari 2
+#MODEL = deep3_fraktur19 # too large for CI
+MODEL = fraktur_19th_century
+export MODEL # needed for pytest model selection
 EXAMPLE = actevedef_718448162.first-page+binarization+segmentation
 
 # BEGIN-EVAL makefile-parser --make-help Makefile
@@ -82,12 +86,13 @@ assets-clean:
 # Run unit tests
 test: test/assets $(MODEL)
 	# declare -p HTTP_PROXY
-	$(PYTHON) -m pytest --continue-on-collection-errors test $(PYTEST_ARGS)
+	$(PYTHON) -m pytest --continue-on-collection-errors --durations=0 test $(PYTEST_ARGS)
 
 # Run unit tests and determine test coverage
 coverage: test/assets $(MODEL)
 	coverage erase
 	make test PYTHON="coverage run"
+	coverage combine
 	coverage report
 	coverage html
 

ocrd_calamari/ocrd-tool.json

@@ -1,6 +1,6 @@
 {
   "git_url": "https://github.com/OCR-D/ocrd_calamari",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "tools": {
     "ocrd-calamari-recognize": {
       "executable": "ocrd-calamari-recognize",
@@ -11,24 +11,28 @@
         "recognition/text-recognition"
       ],
       "description": "Recognize lines with Calamari",
-      "input_file_grp": [
-        "OCR-D-SEG-LINE"
-      ],
-      "output_file_grp": [
-        "OCR-D-OCR-CALAMARI"
-      ],
+      "input_file_grp_cardinality": 1,
+      "output_file_grp_cardinality": 1,
       "parameters": {
+	"device": {
+	  "description": "Select computing device for Tensorflow (-1 for CPU, 0 for first CUDA GPU etc.). Downgraded to CPU if not available.",
+	  "type": "number",
+	  "format": "integer",
+	  "default": 0
+	},
         "checkpoint_dir": {
-          "description": "The directory containing calamari model files (*.ckpt.json). Uses all checkpoints in that directory",
+          "description": "The directory (name or path) containing Calamari model files (*.ckpt.json). Will use all checkpoints in that directory.",
           "type": "string",
           "format": "uri",
           "content-type": "text/directory",
           "cacheable": true,
-          "default": "qurator-gt4histocr-1.0"
+          "required": true
         },
         "voter": {
           "description": "The voting algorithm to use",
-          "type": "string", "default": "confidence_voter_default_ctc"
+          "type": "string",
+	  "default": "confidence_voter_default_ctc",
+	  "enum": ["confidence_voter_default_ctc", "sequence_voter"]
         },
         "textequiv_level": {
           "type": "string",
@@ -50,107 +54,161 @@
           "name": "qurator-gt4histocr-1.0",
           "description": "Calamari model trained with GT4HistOCR",
           "size": 90275264,
-          "version_range": ">= 1.0.0"
-        },
-        {
-          "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.1-pre1/c1_fraktur19-1.tar.gz",
-          "type": "archive",
-          "name": "zpd-fraktur19",
-          "description": "Model trained on 19th century german fraktur",
-          "path_in_archive": "c1_fraktur19-1",
-          "size": 86009886,
-          "version_range": ">= 1.0.0"
+          "version_range": ">= 1.0.0, < 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.1-pre1/c1_latin-script-hist-3.tar.gz",
-          "type": "archive",
-          "name": "zpd-latin-script-hist-3",
-          "path_in_archive": "c1_latin-script-hist-3",
-          "description": "Model trained on historical latin-script texts",
-          "size": 88416863,
-          "version_range": ">= 1.0.0"
-        },
-        {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/antiqua_historical.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/antiqua_historical.tar.gz",
           "type": "archive",
           "name": "antiqua_historical",
           "path_in_archive": "antiqua_historical",
           "description": "Antiqua parts of GT4HistOCR from Calamari-OCR/calamari_models (5-fold ensemble, normalized grayscale, NFC)",
-          "size": 89615540,
-          "version_range": ">= 1.0.0"
+          "size": 30633860,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/antiqua_historical_ligs.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/antiqua_historical_ligs.tar.gz",
           "type": "archive",
           "name": "antiqua_historical_ligs",
           "path_in_archive": "antiqua_historical_ligs",
           "description": "Antiqua parts of GT4HistOCR with enriched ligatures from Calamari-OCR/calamari_models (5-fold ensemble, normalized grayscale, NFC)",
-          "size": 87540762,
-          "version_range": ">= 1.0.0"
+          "size": 30368081,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/fraktur_19th_century.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/fraktur_19th_century.tar.gz",
           "type": "archive",
           "name": "fraktur_19th_century",
           "path_in_archive": "fraktur_19th_century",
           "description": "Fraktur 19th century parts of GT4HistOCR mixed with Fraktur data from Archiscribe and jze from Calamari-OCR/calamari_models (5-fold ensemble, normalized grayscale and nlbin, NFC)",
-          "size": 83895140,
-          "version_range": ">= 1.0.0"
+          "size": 30018408,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/fraktur_historical.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/fraktur_historical.tar.gz",
           "type": "archive",
           "name": "fraktur_historical",
           "path_in_archive": "fraktur_historical",
           "description": "Fraktur parts of GT4HistOCR from Calamari-OCR/calamari_models (5-fold ensemble, normalized grayscale, NFC)",
-          "size": 87807639,
-          "version_range": ">= 1.0.0"
+          "size": 30232783,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/fraktur_historical_ligs.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/fraktur_historical_ligs.tar.gz",
           "type": "archive",
           "name": "fraktur_historical_ligs",
           "path_in_archive": "fraktur_historical_ligs",
           "description": "Fraktur parts of GT4HistOCR with enriched ligatures from Calamari-OCR/calamari_models (5-fold ensemble, normalized grayscale, NFC)",
-          "size": 88039551,
-          "version_range": ">= 1.0.0"
+          "size": 30622320,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/gt4histocr.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/gt4histocr.tar.gz",
           "type": "archive",
           "name": "gt4histocr",
           "path_in_archive": "gt4histocr",
           "description": "GT4HistOCR from Calamari-OCR/calamari_models (5-fold ensemble, normalized grayscale, NFC)",
-          "size": 90107851,
-          "version_range": ">= 1.0.0"
+          "size": 31159925,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/historical_french.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/historical_french.tar.gz",
           "type": "archive",
           "name": "historical_french",
           "path_in_archive": "historical_french",
           "description": "17-19th century French prints from Calamari-OCR/calamari_models (5-fold ensemble, nlbin, NFC)",
-          "size": 87335250,
-          "version_range": ">= 1.0.0"
+          "size": 30257128,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/idiotikon.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/idiotikon.tar.gz",
           "type": "archive",
           "name": "idiotikon",
           "path_in_archive": "idiotikon",
           "description": "Antiqua UW3 finetuned on Antiqua Idiotikon dictionary with many diacritics from Calamari-OCR/calamari_models (5-fold ensemble, nlbin, NFD)",
-          "size": 100807764,
-          "version_range": ">= 1.0.0"
+          "size": 30474541,
+          "version_range": ">= 2.0.0"
         },
         {
-          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/1.1/uw3-modern-english.zip",
+          "url": "https://github.com/Calamari-OCR/calamari_models/releases/download/2.2/uw3-modern-english.tar.gz",
           "type": "archive",
           "name": "uw3-modern-english",
           "path_in_archive": "uw3-modern-english",
           "description": "Antiqua UW3 corpus from Calamari-OCR/calamari_models (5-fold ensemble, nlbin, NFC)",
-          "size": 85413520,
-          "version_range": ">= 1.0.0"
-        }
+          "size": 29897592,
+          "version_range": ">= 2.0.0"
+        },
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_fraktur19.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_fraktur19",
+	  "path_in_archive": "deep3_fraktur19",
+	  "description": "Model trained on 19th century German Fraktur, like zpd-fraktur19 but deeper (5-fold ensemble, nlbin, NFC) - val_CER=0.5%",
+	  "size": 92555871,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_fraktur-hist.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_fraktur-hist",
+	  "path_in_archive": "deep3_fraktur-hist",
+	  "description": "Model trained on 16th to 19th century German Fraktur, like fraktur-historical but deeper (5-fold ensemble, nlbin, NFC) - val_CER=0.9%",
+	  "size": 92504515,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_antiqua-hist.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_antiqua-hist",
+	  "path_in_archive": "deep3_antiqua-hist",
+	  "description": "Model trained on 16th to 19th century Antiqua, like antiqua-historical but deeper (5-fold ensemble, nlbin, NFC) - val_CER=0.5%",
+	  "size": 92614001,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_antiqua-15-16-cent.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_antiqua-15-16-cent",
+	  "path_in_archive": "deep3_antiqua-15-16-cent",
+	  "description": "Model trained on 15th and 16th century Latin Antiqua, like zpd-latin-script-hist-3 but deeper (5-fold ensemble, nlbin, NFC) - val_CER=0.5%",
+	  "size": 92627999,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_lsh4.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_lsh4",
+	  "path_in_archive": "deep3_lsh4",
+	  "description": "Model trained on 15th and 19th century on German, Latin, French etc. in Antiqua and Fraktur, like gt4histocr but deeper (5-fold ensemble, nlbin, NFC) - val_CER=1.6%",
+	  "size": 92579708,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_htr-bastard.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_htr-bastard",
+	  "path_in_archive": "deep3_htr-bastard",
+	  "description": "Model trained on 13th to 16th century German Gothic Bastarda (5-fold ensemble, nlbin, NFC) - val_CER=6.7%",
+	  "size": 91539649,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/deep3_htr-gothic.tar.gz",
+	  "type": "archive",
+	  "name": "deep3_htr-gothic",
+	  "path_in_archive": "deep3_htr-gothic",
+	  "description": "Model trained on 13th to 16th century German Gothic Cursiva (5-fold ensemble, nlbin, NFC) - val_CER=2.5%",
+	  "size": 91499098,
+	  "version_range": ">= 2.0.0"
+	},
+	{
+	  "url": "https://github.com/Calamari-OCR/calamari_models_experimental/releases/download/v0.0.3/def_arabic.tar.gz",
+	  "type": "archive",
+	  "name": "def_arabic",
+	  "path_in_archive": "def_arabic",
+	  "description": "Model trained for Arabic on ? (5-fold ensemble, nlbin, NFC) - val_CER=1.2%",
+	  "size": 30651139,
+	  "version_range": ">= 2.0.0"
+	}
       ]
     }
   }