ocr-foundry 0.2.0__py3-none-any.whl

ocr_foundry-0.2.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.5
+Name: ocr-foundry
+Version: 0.2.0
+Summary: OCR Foundry - synthetic OCR training data with Khmer/English and opt-in multilingual rendering
+Project-URL: Homepage, https://github.com/0x1d1e/ocr-foundry
+Project-URL: Issues, https://github.com/0x1d1e/ocr-foundry/issues
+Project-URL: Changelog, https://github.com/0x1d1e/ocr-foundry/blob/main/CHANGELOG.md
+Author: Kosal Seng
+License-Expression: MIT
+License-File: LICENSE
+Keywords: data-generation,image-generation,khmer,ocr,synthetic-data,text-recognition
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.12
+Requires-Dist: albumentations>=1.3.0
+Requires-Dist: fonttools>=4.0.0
+Requires-Dist: khmernormalizer>=0.0.4
+Requires-Dist: lmdb>=1.4.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: opencv-python-headless>=4.8.0
+Requires-Dist: pillow>=10.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: regex>=2023.0.0
+Requires-Dist: tqdm>=4.64.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: ty>=0.0.1a1; extra == 'dev'
+Provides-Extra: rust
+Requires-Dist: khocr-gen-core; extra == 'rust'
+Description-Content-Type: text/markdown
+
+# OCR Foundry
+
+Synthetic OCR training data generator with legacy Khmer/English behavior and
+opt-in multilingual whole-line rendering. Use `ocr-foundry`; existing `khocr-gen`
+commands run the same CLI. The v0.2 distribution `ocr-foundry` installs both
+executables. Python imports remain `khocr_gen`, and Rust and `KHOCR_GEN_*`
+environment contracts are unchanged.
+
+See [branding and compatibility](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/BRANDING.md)
+for migration details. Repository links to `https://github.com/0x1d1e/ocr-foundry`
+are valid now.
+
+## Installation
+
+```bash
+pip install ocr-foundry
+```
+
+`pip install ocr-foundry` is the v0.2 distribution. It provides both the
+`ocr-foundry` and `khocr-gen` commands.
+
+The PyPI project `khocr-gen` is deprecated. Release 0.2.0 contains no code and
+depends on this package. `khocr-gen==0.1.13` is the last standalone release.
+If `khocr-gen==0.1.13` is already installed, upgrade or remove it before
+installing `ocr-foundry`, because both distributions would otherwise provide
+the `khocr-gen` command.
+
+The `rust` extra is not installable from PyPI because `khocr-gen-core` is not
+published. Native use is a source checkout with `uv sync --extra dev --extra rust`.
+
+### Requirements
+
+- Python >= 3.12
+- Rust toolchain (`cargo`/`rustc`, edition 2021) - only needed to build the optional acceleration extension
+
+## Quick Start
+
+### 1. Prepare fonts
+
+```text
+fonts/
+├── khmer/     <- .ttf / .otf Khmer fonts
+└── english/   <- .ttf / .otf English fonts
+```
+
+Fonts placed directly in `fonts/` (not in a subdirectory) are added to both pools as fallbacks.
+
+### 2. Prepare corpus
+
+A plain UTF-8 text file, one string per line:
+
+```text
+សួស្តី
+Hello World
+ស្វាគមន៍ Welcome
+```
+
+### 3. Generate a dataset
+
+```bash
+ocr-foundry generate --corpus corpus/corpus.txt --fonts fonts --output data --copies 3 --storage lmdb
+```
+
+### 4. View generated images
+
+```bash
+# Summary of an LMDB database
+ocr-foundry view --lmdb data/train/lmdb
+
+# Extract images
+ocr-foundry view --lmdb data/train/lmdb --output-dir extracted
+
+# Show labels only
+ocr-foundry view --lmdb data/train/lmdb --labels-only
+```
+
+## Multilingual mode and evaluation
+
+`--multilingual` requires Pillow RAQM and renders horizontal logical Unicode lines using
+one covering font by default, with opt-in cluster-aware font fallback (`--cluster-font-fallback`)
+segmenting grapheme clusters, preserving combining marks and Khmer coeng sequences, and aligning
+multi-run segments to a shared baseline. Labels retain normalized logical text without visual reordering.
+Arbitrary recursive font pools, explicit NFC/no-normalization policies, and auto/ltr/rtl direction are supported.
+JSONL manifests ingest rich metadata, emit `provenance.jsonl` sidecars, and record font hashes in `metadata.jsonl`.
+
+The source recipe `configs/multilingual-realistic.yml` includes clean samples, disables rare oversampling
+and foreground crops, and enables a measured line-ink height guard, with opt-in binary glyph-mask guards
+(`--min-glyph-height-for-augmentation`) and script/font intensity scaling. Page layout composition
+(`ocr-foundry layout`) adds opt-in whitespace word annotations, native RAQM vertical writing (words and
+vertical modes requiring shared libraqm with linked FreeType), and paginated table hierarchy. Rendering
+checks are not a universal language-quality claim; see the
+[capability matrix](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/MULTILINGUAL.md) and
+[page layout contract](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/PAGE_LAYOUT.md).
+
+```bash
+ocr-foundry evaluate --reference reference.jsonl --predictions predictions.jsonl --normalization NFC
+```
+
+The offline evaluator reports corpus CER, exact-line accuracy and reference-language
+groups from ID-keyed JSONL. It downloads no model. See the
+[schema and frozen real-document protocol](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/EVALUATION.md)
+and [provenance/migration roadmap](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/MULTILINGUAL_ROADMAP.md).
+
+## Configuration
+
+All generation parameters can be specified via CLI flags, a YAML config file, or both (CLI overrides YAML).
+See [CONFIG.md](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/CONFIG.md) for details.
+Example: [generate.yml](https://github.com/0x1d1e/ocr-foundry/blob/main/configs/generate.yml)
+
+Config loading order (lowest to highest priority):
+1. argparse built-in defaults
+2. YAML config file values
+3. Explicit CLI flags
+
+## CLI Reference
+
+See [CLI_REFERENCE.md](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/CLI_REFERENCE.md) for complete command documentation.
+
+## Documentation
+
+- [Getting Started](https://github.com/0x1d1e/ocr-foundry/wiki/Getting-Started) for a first dataset.
+- [GitHub wiki](https://github.com/0x1d1e/ocr-foundry/wiki) for usage guides and troubleshooting.
+- [In-repository references](https://github.com/0x1d1e/ocr-foundry/blob/main/docs/README.md) for
+  the CLI, configuration, augmentation, and Rust extension.
+
+## Acknowledgments
+
+OCR Foundry builds on these open-source libraries:
+
+- [khmernormalizer](https://github.com/seanghay/khmernormalizer) (MIT) - Khmer text normalization
+- [OpenCV](https://opencv.org/) (Apache 2.0) - Image processing and augmentation
+- [Pillow](https://python-pillow.org/) (HPND) - Font rendering and image creation
+- [Albumentations](https://albumentations.ai/) (MIT) - Augmentation primitives
+- [NumPy](https://numpy.org/) (BSD-3-Clause) - Numerical operations
+- [LMDB](https://www.symas.com/lmdb) (OpenLDAP 2.8) - Embedded database for training pipelines
+
+## License
+
+MIT

ocr_foundry-0.2.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+khocr_gen/__init__.py,sha256=UYucRIwwXp5sUXIfcRNjgWmuuQb1kroH5MUpXMntw_4,312
+khocr_gen/_pil_compat.py,sha256=j5LuJbnlh6SBvlLoo1EeXs_1nmxbIIT98W_xzQfm-UM,678
+khocr_gen/_rust_accel.py,sha256=4JsXBqu8RWgFqKdbSsHvaTrgkvmd6k93BTdt6J3J0Mg,6676
+khocr_gen/augmentation.py,sha256=yzLKOLsEZC7T8tK3MdB-eQifTkzbV1JNRUVMPf0Ogrg,41046
+khocr_gen/benchmark.py,sha256=Z2bvMUFMZr1RHcW3ERmIRZ1LgMRFJDL7PPVN0N14sFA,35121
+khocr_gen/benchmark_cmd.py,sha256=Kaos2hoLPIThALS4RqzP2S1dHTrkDXH5eMjZ2oBXMJE,3905
+khocr_gen/cli.py,sha256=UX0f629-OdIkRUiY7XlHcbA9O25hW51j9F0HjO4pZx8,7156
+khocr_gen/combine.py,sha256=IcSQdXbjtLzGMVdy067eyh0EKNrKc9EY_Aawd8RrRTE,7484
+khocr_gen/combine_cmd.py,sha256=mE_1aeJXbxJlS9Zr0PyL9qdYHowwjbuzriTvWDC3Lb8,3844
+khocr_gen/config.py,sha256=esJg9apHRvATsFP4zSTKsm1amDWFDqfWnMQ4kn3wjLI,57929
+khocr_gen/config_loader.py,sha256=uWsYWCJ-f2SrUVkLrMVeV-l0kTeJ8X4KLB4Ghn39M-k,5018
+khocr_gen/corpus.py,sha256=39lVr3fsr7DuGTCPjHBIv1AnuIxGxtW1H58_2s8veHY,20906
+khocr_gen/data_generator.py,sha256=EOt9I3akpYj0UJLNq1SdYDcSYKBppM_i5JmkYrlR2Kc,48784
+khocr_gen/errors.py,sha256=u54q1i-9FqBA7_UQjqlK4YYebQcx9IrzYWmVRyvBwZE,801
+khocr_gen/evaluate_cmd.py,sha256=cQRGxu7PMwgR5pHtnpG7O5HPqDjJb2aQqBNXwjRakwo,1454
+khocr_gen/evaluation.py,sha256=Lhcr613dhquqbD9-sG4Ej8jRbz_U1JWjx8Mu8Y0aH50,10164
+khocr_gen/fonts.py,sha256=FAlQ9QIY6JLPejPoYFixO4pTYaosJJ6YhYvQSDiPIkw,12782
+khocr_gen/generate.py,sha256=x5vpJFk0AERsh0I-SLmqk1a5E9PqDYZIqzfpdVTZNJ8,8390
+khocr_gen/layout.py,sha256=m3nBbIQQh33a3BBku4r-YYB3F242eeQfmxSyepbXINc,41756
+khocr_gen/layout_cmd.py,sha256=WPhryKADF-ZMOXFXwCaREEEO9OX9c_fH4mOWrS2Gp4Q,12757
+khocr_gen/layout_degradation.py,sha256=1qPnUO1N0F6qX4JQVaddSo8lmRKJQQOEWvy5ngGznGg,5589
+khocr_gen/layout_mesh.py,sha256=2LDPUPW8ubWumPzgmd86w0MY56T1W4QoZORpoxGvOr4,8633
+khocr_gen/layout_shaping.py,sha256=SCItKjSLesCU3yH4NvIa7qDiHPpGNQWkPrUnJsWRpvM,13723
+khocr_gen/layout_transform.py,sha256=ZmGyadDesm74ktVC0Wlb0NFnbBY7v5p0TZazndv6tg4,10193
+khocr_gen/layout_warp.py,sha256=hHh0JF797WIUscU7CTUn4Yvq_gfaLVTMLanKYdFXpW8,20264
+khocr_gen/line_height.py,sha256=t35p_Tzc-kL0P4IkLpsgvhe3NSfBag5LCMhoul0ADic,5021
+khocr_gen/lmdb_pack.py,sha256=wCExePR3Tdy8XWAPMqHqPIDXK0a41Ayt9WlLUQw1oww,4449
+khocr_gen/logging.py,sha256=vC38AkARPePIjs9HMdYSINiSoCb9GohgqNJEEoLYleQ,748
+khocr_gen/normalizer.py,sha256=uSRXrkdPSXv-QgMLoUggTSvGOrHjQtTohLN3jH4iPdo,7721
+khocr_gen/parallel.py,sha256=0K3Ah9l6paAlEcMe_uCyDge1COpuDb4TOmhvD2imroE,13388
+khocr_gen/provenance.py,sha256=1psCifMcnEotbIqJfsBBsPsVXF4_8bpONlQSRwfotms,11945
+khocr_gen/rendering.py,sha256=_YLT_QL97ltsxVSd4qkDtjubO68SYIWffAfWpsXwm8o,67532
+khocr_gen/text_support.py,sha256=_-_nmrSuNVPQQ9hWzIczbXnecjbAMh4uHoX0W-ep59Y,15144
+khocr_gen/verify.py,sha256=y5ZQQAmiEMhHa_5hnMqUEsGl-pWpNIpxiwEmkRxiock,18141
+khocr_gen/viewer.py,sha256=PJXrwq7NEqZMC8Jxldf9bop52XHl9yh6uUQ__o7SOJE,5941
+ocr_foundry-0.2.0.dist-info/METADATA,sha256=IaZpXOt2we6_zwCiRbOTCRAm7xKdml8ozamG0iljdXo,7036
+ocr_foundry-0.2.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+ocr_foundry-0.2.0.dist-info/entry_points.txt,sha256=sGOvPPH7m4LUwGeqKN5qWht2M-rU1IKYh955NE9XpVk,82
+ocr_foundry-0.2.0.dist-info/licenses/LICENSE,sha256=AfRrnYSoa0M3RC3d-0nKjH_Ch9EwOnmLp2e4nYmpBbA,1067
+ocr_foundry-0.2.0.dist-info/RECORD,,

ocr_foundry-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ocr_foundry-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+khocr-gen = khocr_gen.cli:main
+ocr-foundry = khocr_gen.cli:main

ocr_foundry-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kosal Seng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.