ko-hand-ocr 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,20 @@
1
+ ko-hand-ocr
2
+ Copyright 2026 ko-hand-ocr contributors
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ 이 저작물에는 아래 것이 들어 있습니다.
11
+
12
+ - 인코더 가중치는 `facebook/deit-small-patch16-224` (Apache-2.0, Meta Platforms, Inc.)
13
+ 에서 시작해 미세조정한 것입니다.
14
+ - 디코더 가중치는 이 저장소에서 처음부터 학습했습니다.
15
+ - 학습 이미지는 아래 글꼴로 그려 만들었습니다.
16
+ · 나눔손글씨 109벌 (NAVER Corporation / CLOVA AI OCR Team)
17
+ · 한글 손글씨 글꼴 14벌 (google/fonts, SIL Open Font License 1.1)
18
+ **글꼴 파일은 이 저장소에 들어 있지 않으며 재배포하지 않습니다.**
19
+ 가중치는 글자 모양의 저작물이 아니라 그림에서 배운 값입니다.
20
+ 자세한 내용은 PROVENANCE.md 를 보십시오.
@@ -0,0 +1,322 @@
1
+ Metadata-Version: 2.4
2
+ Name: ko-hand-ocr
3
+ Version: 0.2.0
4
+ Summary: Korean handwriting OCR - reads one line of handwritten Korean/English. 31M params, CPU-only, no dataset terms inherited.
5
+ License-Expression: Apache-2.0
6
+ Project-URL: Source, https://github.com/jysvai/ko-hand-ocr
7
+ Project-URL: Issues, https://github.com/jysvai/ko-hand-ocr/issues
8
+ Keywords: ocr,handwriting,korean,hangul,trocr
9
+ Requires-Python: >=3.10
10
+ Description-Content-Type: text/markdown
11
+ License-File: LICENSE
12
+ License-File: NOTICE
13
+ Requires-Dist: torch>=2.5
14
+ Requires-Dist: transformers>=4.45
15
+ Requires-Dist: Pillow>=10.0
16
+ Provides-Extra: train
17
+ Requires-Dist: numpy>=1.26; extra == "train"
18
+ Dynamic: license-file
19
+
20
+ <div align="center">
21
+
22
+ # ko-hand-ocr
23
+
24
+ **Reads one line of handwritten Korean + English.**
25
+ A 31M model trained from scratch on synthetic data — no handwriting dataset, no inherited terms.
26
+
27
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/jysvai/ko-hand-ocr/blob/main/LICENSE)
28
+ [![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/jysvai/ko-hand-ocr)
29
+ [![Params](https://img.shields.io/badge/params-31M-1baf7a)](https://github.com/jysvai/ko-hand-ocr)
30
+ [![Weights](https://img.shields.io/badge/weights-116MB-1baf7a)](https://github.com/jysvai/ko-hand-ocr/releases/tag/v0.2.0)
31
+ [![CPU](https://img.shields.io/badge/runs%20on-CPU%20only-eda100)](https://github.com/jysvai/ko-hand-ocr)
32
+ [![Data](https://img.shields.io/badge/training%20data-synthetic-e87ba4)](https://github.com/jysvai/ko-hand-ocr/blob/main/PROVENANCE.md)
33
+
34
+ [한국어](https://github.com/jysvai/ko-hand-ocr/blob/main/README.md) · **English**
35
+
36
+ </div>
37
+
38
+ ```
39
+ photo -> line cutting -> ko-hand-ocr -> "부서 : 포테토뭉부서"
40
+ ```
41
+
42
+ ---
43
+
44
+ ## At a glance
45
+
46
+ | | |
47
+ |---|---|
48
+ | **What it reads** | One line of handwritten Korean + English, from a photo |
49
+ | **Model** | ViT-Small encoder (ImageNet, Apache-2.0) + 4-layer TrOCR decoder trained from scratch |
50
+ | **Vocabulary** | 229 jamo tokens — not 11,172 syllables, so unseen characters are still writable |
51
+ | **Parameters** | **31M** — one seventh of `ko-trocr` (213.7M) |
52
+ | **Weights** | **116 MB** single · 465 MB four-way ensemble *(downloaded separately)* |
53
+ | **Package** | 83 KB — the code only |
54
+ | **Speed** | **0.16 s per cell** · 1.37 s for a whole photo — **CPU only, no GPU** |
55
+ | **Memory** | 890 MB single · 1.35 GB ensemble |
56
+ | **Accuracy** | **93.5%** on handwriting fonts never seen in training (93.9% ensemble) |
57
+ | **Training data** | Synthetic — drawn on the fly from OFL fonts. Nothing is stored on disk |
58
+ | **License** | Apache-2.0, weights included — **no dataset terms inherited** |
59
+ | **Python** | 3.10+ · PyTorch 2.5+ |
60
+
61
+ ## What it does — and does not
62
+
63
+ **Does**
64
+
65
+ - Reads a **whole photo**: finds the lines, cuts them, reads each one (`read_photo`)
66
+ - Reads **pre-cut line images**, batched (`read`)
67
+ - **Constrained decoding** — restrict the output to a candidate list, and report whether the free and constrained readings agree (`both`)
68
+ - **Ensemble reading** — run several checkpoints and take the answer they agree on
69
+ - Runs **fully offline on CPU.** Nothing is sent anywhere
70
+
71
+ **Does not**
72
+
73
+ - Split a table cell into label and value — `read_photo` only cuts down to lines
74
+ - Handle vertical writing or merged cells
75
+ - Stay silent on an empty cell — a cell that is pure scribble still produces something
76
+
77
+ ## Why it exists
78
+
79
+ In practice the only publicly available Korean handwriting OCR model is
80
+ `ddobokki/ko-trocr`, and its training data comes from AI Hub, which places conditions
81
+ on purpose of use and on redistribution. That blocks it from being embedded in an
82
+ in-house tool or shipped as a public package. So **the same capability was rebuilt
83
+ from scratch** — with a provenance chain that can be audited part by part.
84
+
85
+ ![ko-hand-ocr vs ko-trocr](https://raw.githubusercontent.com/jysvai/ko-hand-ocr/main/bench-compare.svg)
86
+
87
+ ## Install
88
+
89
+ ```bash
90
+ pip install git+https://github.com/jysvai/ko-hand-ocr.git
91
+ ```
92
+
93
+ > Not on PyPI yet. Until it is, install from the repository.
94
+
95
+ Weights ship separately — they are too large for the repository, so they are attached
96
+ to [Releases](https://github.com/jysvai/ko-hand-ocr/releases/tag/v0.2.0).
97
+
98
+ | Download | Size | What it is |
99
+ |---|---|---|
100
+ | `ko-hand-ocr-v46.zip` | 116MB | **A single checkpoint.** Enough for most uses. 0.16 s/cell |
101
+ | `ko-hand-ocr-ensemble.zip` | 465MB | Four checkpoints. More accurate, 10x slower |
102
+
103
+ ```bash
104
+ curl -LO https://github.com/jysvai/ko-hand-ocr/releases/download/v0.2.0/ko-hand-ocr-v46.zip
105
+ ```
106
+
107
+ Pass the unzipped folder straight to `Reader()`. It must contain `config.json`,
108
+ `vocab.json` and `model.safetensors`.
109
+
110
+ ## Quick start
111
+
112
+ ```python
113
+ from kohandocr.reader import Reader
114
+
115
+ reader = Reader("ko-hand-ocr-v46", device="cpu") # the unzipped folder
116
+
117
+ # A whole photo. Line cutting is included.
118
+ reader.read_photo(open("scan.jpg", "rb").read())
119
+ # -> ['보안점검표', '부서 : 포테토뭉부서', '이름 : 감자밭']
120
+
121
+ # If the lines are already cut, hand the images in directly. Batch them for speed.
122
+ reader.read([cell_a, cell_b, cell_c])
123
+
124
+ # Given a candidate list, the output can be constrained to it.
125
+ reader.both([cell_b], options=["포테토뭉부서", "감자밭", "김클로드"])
126
+ # -> [{'text': '부서 : 포테토뭄부서', 'constrained': '포테토뭉부서', 'agrees': True}]
127
+ ```
128
+
129
+ **Do not trust the constrained result on its own.** Because it is constrained, the
130
+ model *must* return something from the list. If the true answer is not in the list you
131
+ get a confident wrong answer and nothing looks off. When `agrees` is false, hand it
132
+ to a human.
133
+
134
+ ### Reading with several checkpoints
135
+
136
+ Different checkpoints fail on different cells. Train a little longer on the same data
137
+ and some cells survive while others die — which tells you those cells were being read
138
+ by a thin margin. So keep several checkpoints and take **the answer they agree on**.
139
+
140
+ ```
141
+ unzipped/
142
+ config.json vocab.json model.safetensors
143
+ also/
144
+ v20b/ config.json vocab.json model.safetensors
145
+ v19/ ...
146
+ ```
147
+
148
+ If `also/` is present, `Reader` uses it automatically. The call site does not change.
149
+
150
+ Combining by confidence was measured and **it did not work** — the model is sometimes
151
+ more confident about a wrong answer. So selection is by **how much the outputs agree**,
152
+ not by confidence.
153
+
154
+ ## How it is built
155
+
156
+ ```
157
+ 64 x 640 line image
158
+ |
159
+ ViT-Small encoder facebook/deit-small-patch16-224 (ImageNet-1k, Apache-2.0)
160
+ patch 16 pretrained weights, continued at a lower learning rate
161
+ |
162
+ TrOCR decoder 4 layers, 6 heads — trained from scratch
163
+ |
164
+ 229 jamo tokens ㄱ ㅏ ㅁ ... assembled into 감
165
+ |
166
+ "부서 : 감자밭"
167
+ ```
168
+
169
+ Two decisions carry most of the result.
170
+
171
+ **Jamo, not syllables.** Memorising all 11,172 Hangul syllables needs a large output
172
+ layer and still fails on anything rare. 229 jamo compose into any syllable, so a
173
+ character the model never saw in training is still writable — which matters for names.
174
+
175
+ **The encoder is not frozen, but it is not shaken either.** It already learned to see
176
+ on ImageNet, so it continues at a lower learning rate while the blank decoder learns
177
+ fast. Training both at the same rate destroys what the encoder knew.
178
+
179
+ ## Accuracy
180
+
181
+ Measured two ways. **Both matter.** All figures below come from
182
+ `python tools/verify.py` (400 lines per font, 11 photos).
183
+
184
+ | | unseen fonts (mean) | worst font | 11 handwriting photos | worst photo |
185
+ |---|---|---|---|---|
186
+ | single (v46) | 93.5% | 86.4% | 89.6% | 66.7% |
187
+ | four | **93.9%** | **88.1%** | **95.6%** | **83.1%** |
188
+
189
+ Similarity is measured per jamo; on the photo side each photo gets one vote.
190
+
191
+ **Do not take the photo number at face value.** It is measured on 11 photos (37 cells)
192
+ taken by the author, so it swings ±5%p. The figure closer to what you would see on
193
+ someone else's handwriting is the **unseen-fonts** column — tested only on six font
194
+ families never used in training, where the swing is half as wide (±2-3%p).
195
+
196
+ Four checkpoints open a **large gap on photos** (95.6 vs 89.6) and a small one on
197
+ fonts (93.9 vs 93.5). The photo gap is large because where one checkpoint collapses
198
+ another carries the cell — the worst photo goes from 66.7% with one checkpoint to
199
+ 83.1% with four. The cost is being ten times slower.
200
+
201
+ ### Per font (400 lines each)
202
+
203
+ ![Accuracy by handwriting font](https://raw.githubusercontent.com/jysvai/ko-hand-ocr/main/bench-accuracy.svg)
204
+
205
+ Look only at the average and **the font that collapses is hidden.** The real spread
206
+ is 12%p.
207
+
208
+ | Font | single (v46) | four |
209
+ |---|---|---|
210
+ | **EastSeaDokdo (동해독도)** | **86.4%** | **88.1%** |
211
+ | KirangHaerang (기랑해랑) | 92.4% | 92.6% |
212
+ | HiMelody (하이멜로디) | 93.2% | 93.2% |
213
+ | NanumPenScript (나눔펜스크립트) | 94.0% | 94.2% |
214
+ | GamjaFlower (감자꽃) | 96.9% | 97.0% |
215
+ | SingleDay (싱글데이) | 97.9% | 98.1% |
216
+
217
+ What has to clear the bar is not the mean but **the lowest font.** The goal is 90% on
218
+ all six; EastSeaDokdo has not got there yet.
219
+
220
+ All six are fonts **never used in training**, and all are SIL Open Font License.
221
+
222
+ ```bash
223
+ python tools/holdout.py <checkpoint-dir> --per-font --sample sample.png
224
+ ```
225
+
226
+ ### What the test sheet actually looks like
227
+
228
+ ![unseen-font test sheet](https://raw.githubusercontent.com/jysvai/ko-hand-ocr/main/holdout-sample.png)
229
+
230
+ Three lines per font, with the ground truth, what the model read, and the similarity.
231
+ The pale band on the right is the leftover space from fitting into a 64x640 frame —
232
+ this is exactly what the model sees.
233
+
234
+ It shows why the gap opens. **SingleDay** has well-separated characters and intact
235
+ strokes, close to print. **EastSeaDokdo** smears and drops strokes, so `안전사무국`
236
+ looks like a different word almost entirely — a human cannot read it without context
237
+ either.
238
+
239
+ This is **an image, not a font file.** Drawing glyphs with a font is what the OFL
240
+ permits; what is not redistributed is the `.ttf` files themselves
241
+ ([PROVENANCE.md](https://github.com/jysvai/ko-hand-ocr/blob/main/PROVENANCE.md)).
242
+
243
+ ## Speed and footprint (measured)
244
+
245
+ No GPU needed. Emitting jamo one at a time is the bottleneck, so more cores do not help
246
+ much — and by the same token **it does not get slower on a weak machine.**
247
+
248
+ CPU only, median over 11 photos (37 cells). Time is split into **cutting and reading** —
249
+ shrinking the model does not shrink cutting, and when a photo holds only three or four
250
+ lines, cutting is more than half the cost.
251
+
252
+ | | cut | read | one photo (3.4 cells) | per cell |
253
+ |---|---|---|---|---|
254
+ | single, beam 5 | 0.82s | 0.55s | 1.37s | 0.16s |
255
+ | single, greedy | 0.82s | 0.32s | 1.13s | 0.10s |
256
+ | four, beam 5 | 0.82s | 5.73s | 6.55s | 1.70s |
257
+
258
+ Memory is about 890MB for one checkpoint, about 1.35GB for four.
259
+
260
+ Produced with `python tools/bench.py --all --device cpu`. That harness walks exactly the
261
+ path the application walks — a speed measured along a different path is not the speed
262
+ the user gets.
263
+
264
+ ## Where it runs
265
+
266
+ **Built and tested on Windows.** Training and inference were both run on
267
+ Windows 11 with Python 3.13/3.14.
268
+
269
+ | | |
270
+ |---|---|
271
+ | Windows | Where it was built. Training and inference both verified |
272
+ | macOS | **Untested.** Inference is pure PyTorch + PIL so it should run, but it has not been confirmed |
273
+ | Linux | Not tried yet |
274
+
275
+ `tools/train.ps1` is PowerShell, so it is Windows-only. Elsewhere, call
276
+ `python -m kohandocr.train` directly — all that script does is wait for the previous
277
+ run to release the GPU, launch it, and watch the first few steps.
278
+
279
+ ## Training
280
+
281
+ No data is baked ahead of time. A corpus line is generated, drawn with a handwriting
282
+ font, and fed in **on the spot**. Nothing is left on disk, and a change to the
283
+ distribution takes effect from the next step.
284
+
285
+ ```bash
286
+ python tools/fetch_fonts.py # fetch OFL handwriting fonts
287
+ python -m kohandocr.train --out runs/v1 \
288
+ --steps 20000 --batch 40 --workers 3 --letters 128
289
+ ```
290
+
291
+ Fonts are looked up in this order. **No path is hard-coded.**
292
+
293
+ 1. whatever `--fonts` was given
294
+ 2. the `KOHAND_FONTS` environment variable
295
+ 3. `~/.cache/ko-hand-ocr/fonts`
296
+
297
+ The fonts are not in this repository and are **not redistributed.** The 109 Nanum
298
+ handwriting fonts come from [clova.ai/handwriting](https://clova.ai/handwriting).
299
+ Details in [PROVENANCE.md](https://github.com/jysvai/ko-hand-ocr/blob/main/PROVENANCE.md).
300
+
301
+ How closely the synthetic images match real handwriting is checked against the measured
302
+ distributions recorded in `kohandocr/measured.json` — nine of them (ink coverage,
303
+ density, aspect ratio, margins and so on).
304
+
305
+ ```bash
306
+ python tools/match.py # target vs current synthesis, side by side
307
+ ```
308
+
309
+ **Running longer does not make it better.** After changing the synthesis distribution,
310
+ run short, keep intermediate checkpoints, and pick between them (measured: 15,000 steps
311
+ was the peak and 30,000 steps was worse).
312
+
313
+ ```bash
314
+ python tools/pick.py runs/v1-15000 runs/v1-30000 # score the kept checkpoints and pick
315
+ ```
316
+
317
+ ## License
318
+
319
+ Apache-2.0, weights included. The licenses of the fonts used in training do not attach
320
+ to the weights — the weights are not a derivative of the glyph artwork, they are values
321
+ learned from images. The reasoning is recorded part by part in
322
+ [PROVENANCE.md](https://github.com/jysvai/ko-hand-ocr/blob/main/PROVENANCE.md).