dinglehopper/README.md

dinglehopper
============

dinglehopper is an OCR evaluation tool and reads [ALTO](https://github.com/altoxml), [PAGE](https://github.com/PRImA-Research-Lab/PAGE-XML) and text files.

[![Build Status](https://travis-ci.org/qurator-spk/dinglehopper.svg?branch=master)](https://travis-ci.org/qurator-spk/dinglehopper)

Goals
-----
* Useful
  * As a UI tool
  * For an automated evaluation
  * As a library
* Unicode support

Installation
------------
It's best to use pip, e.g.:
~~~
sudo pip install .
~~~

Usage
-----
~~~
dinglehopper some-document.gt.page.xml some-document.ocr.alto.xml
~~~
This generates `report.html` and `report.json`.


As a OCR-D processor:
~~~
ocrd-dinglehopper -m mets.xml -I OCR-D-GT-PAGE,OCR-D-OCR-TESS -O OCR-D-OCR-TESS-EVAL
~~~
This generates HTML and JSON reports in the `OCR-D-OCR-TESS-EVAL` filegroup.


![dinglehopper displaying metrics and character differences](.screenshots/dinglehopper.png?raw=true)

Testing
-------
Use `pytest` to run the tests in [the tests directory](qurator/dinglehopper/tests):
~~~
virtualenv -p /usr/bin/python3 venv
. venv/bin/activate
pip install -r requirements.txt
pip install pytest
pytest
~~~
➡ Move dinglehopper into its own directory 2019-08-14 15:32:50 +02:00			`dinglehopper`
			`============`

add links to supported XML formats 2019-08-15 14:39:35 +02:00			`dinglehopper is an OCR evaluation tool and reads [ALTO](https://github.com/altoxml), [PAGE](https://github.com/PRImA-Research-Lab/PAGE-XML) and text files.`
📝 dinglehopper: Add screenshot 2019-08-14 18:29:49 +02:00
✅ dinglehopper: Make Travis CI badge link to build status 2019-08-16 14:01:53 +02:00			`[![Build Status](https://travis-ci.org/qurator-spk/dinglehopper.svg?branch=master)](https://travis-ci.org/qurator-spk/dinglehopper)`
📝 dinglehopper: Add screenshot 2019-08-14 18:29:49 +02:00
📝 dinglehopper: Document goals 2019-08-15 10:35:26 +02:00			`Goals`
			`-----`
			`* Useful`
Fix typo in README Since u is pronounced `/ju/` in this case, the n is not added to prevent a hiatus here. Cf. https://en.wiktionary.org/wiki/an#Usage_notes. 2019-11-06 14:54:25 +01:00			`* As a UI tool`
📝 dinglehopper: Document goals 2019-08-15 10:35:26 +02:00			`* For an automated evaluation`
			`* As a library`
📝 dinglehopper: Document Unicode support 2019-08-15 10:38:05 +02:00			`* Unicode support`
📝 dinglehopper: Document goals 2019-08-15 10:35:26 +02:00
📝 dinglehopper: Document installation + testing 2019-11-18 16:32:42 +01:00			`Installation`
			`------------`
			`It's best to use pip, e.g.:`
			`~~~`
			`sudo pip install .`
			`~~~`

✨ dinglehopper: Add OCR-D interface 2019-08-15 17:25:54 +02:00			`Usage`
			`-----`
📝 dinglehopper: Document basic CLI usage 2019-08-15 17:52:41 +02:00			`~~~`
			`dinglehopper some-document.gt.page.xml some-document.ocr.alto.xml`
			`~~~`
			This generates `report.html` and `report.json`.


✨ dinglehopper: Add OCR-D interface 2019-08-15 17:25:54 +02:00			`As a OCR-D processor:`
			`~~~`
			`ocrd-dinglehopper -m mets.xml -I OCR-D-GT-PAGE,OCR-D-OCR-TESS -O OCR-D-OCR-TESS-EVAL`
			`~~~`
			This generates HTML and JSON reports in the `OCR-D-OCR-TESS-EVAL` filegroup.


📝 dinglehopper: Add screenshot 2019-08-14 18:29:49 +02:00			`![dinglehopper displaying metrics and character differences](.screenshots/dinglehopper.png?raw=true)`
📝 dinglehopper: Document installation + testing 2019-11-18 16:32:42 +01:00
			`Testing`
			`-------`
			Use `pytest` to run the tests in [the tests directory](qurator/dinglehopper/tests):
			`~~~`
			`virtualenv -p /usr/bin/python3 venv`
			`. venv/bin/activate`
			`pip install -r requirements.txt`
			`pip install pytest`
			`pytest`
			`~~~`