You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@
19
19
*[Command line tools](#command-line-tools)
20
20
* [`ocrd` CLI](#ocrd-cli)
21
21
* [`ocrd-dummy` CLI](#ocrd-dummy-cli)
22
+
*[Configuration](#configuration)
22
23
*[Packages](#packages)
23
24
* [ocrd_utils](#ocrd_utils)
24
25
* [ocrd_models](#ocrd_models)
@@ -81,6 +82,19 @@ supported flags, options and arguments.
81
82
82
83
A minimal [OCR-D processor](https://ocr-d.de/en/user_guide#using-the-ocr-d-processors) that copies from `-I/-input-file-grp` to `-O/-output-file-grp`
83
84
85
+
## Configuration
86
+
87
+
Almost all behaviour of the OCR-D/core software is configured via CLI options and flags, which can be listed with the `--help` flag that all CLI support.
88
+
89
+
Some parts of the software are configured via environement variables:
90
+
91
+
*`OCRD_METS_CACHING`: If set to `true`, access to the METS file is cached, speeding in-memory search and modification.
92
+
*`OCRD_PROFILE`: This variable configures the built-in CPU and memory profiling. If empty, no profiling is done. Otherwise expected to contain any of the following tokens:
93
+
*`CPU`: Enable CPU profiling of processor runs
94
+
*`RSS`: Enable RSS memory profiling
95
+
*`PSS`: Enable proportionate memory profiling
96
+
*`OCRD_PROFILE_FILE`: If set, then the CPU profile is written to this file for later peruse with a analysis tools like [snakeviz](https://jiffyclub.github.io/snakeviz/)
0 commit comments