Skip to content

Commit

Permalink
✒ README: Minor whitespace cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
mikegerber committed Aug 11, 2023
1 parent 54a3121 commit dbaccdd
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,27 +70,27 @@ This generates `report.html` and `report.json`.

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

Batch comparison between folders of GT and OCR files can be done by simply providing
Batch comparison between folders of GT and OCR files can be done by simply providing
folders:
~~~
dinglehopper gt/ ocr/ report output_folder/
~~~
This assumes that you have files with the same name in both folders, e.g.
This assumes that you have files with the same name in both folders, e.g.
`gt/00000001.page.xml` and `ocr/00000001.alto.xml`.

The example generates reports for each set of files, with the prefix `report`, in the
The example generates reports for each set of files, with the prefix `report`, in the
(automatically created) folder `output_folder/`.

By default, the JSON report does not contain the character and word differences, only
the calculated metrics. If you want to include the differences, use the
By default, the JSON report does not contain the character and word differences, only
the calculated metrics. If you want to include the differences, use the
`--differences` flag:

~~~
dinglehopper gt/ ocr/ report output_folder/ --differences
~~~

### dinglehopper-summarize
A set of (JSON) reports can be summarized into a single set of
A set of (JSON) reports can be summarized into a single set of
reports. This is useful after having generated reports in batch.
Example:
~~~
Expand All @@ -100,7 +100,7 @@ This generates `summary.html` and `summary.json` in the same `output_folder`.

If you are summarizing many reports and have used the `--differences` flag while
generating them, it may be useful to limit the number of differences reported by using
the `--occurences-threshold` parameter. This will reduce the size of the generated HTML
the `--occurences-threshold` parameter. This will reduce the size of the generated HTML
report, making it easier to open and navigate. Note that the JSON report will still
contain all differences. Example:
~~~
Expand Down

0 comments on commit dbaccdd

Please sign in to comment.