ocr-stringdist 0.2.0__cp311-cp311-musllinux_1_1_i686.whl → 0.2.2__cp311-cp311-musllinux_1_1_i686.whl

ocr_stringdist-0.2.2.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: ocr-stringdist
+Version: 0.2.2
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: repository, https://github.com/NiklasvonM/ocr-stringdist
+Project-URL: documentation, https://niklasvonm.github.io/ocr-stringdist/
+
+# OCR-StringDist
+
+A Python library for fast string distance calculations that account for common OCR (optical character recognition) errors.
+
+Documentation: https://niklasvonm.github.io/ocr-stringdist/
+
+[![PyPI](https://img.shields.io/badge/PyPI-Package-blue)](https://pypi.org/project/ocr-stringdist/)
+[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
+
+## Overview
+
+Standard string distances (like Levenshtein) treat all character substitutions equally. This is suboptimal for text read from images via OCR, where errors like `O` vs `0` are far more common than, say, `O` vs `X`.
+
+OCR-StringDist uses a **weighted Levenshtein distance**, assigning lower costs to common OCR errors.
+
+**Example:** Matching against the correct word `CODE`:
+
+* **Standard Levenshtein:**
+    * $d(\text{"CODE"}, \text{"C0DE"}) = 1$ (O → 0)
+    * $d(\text{"CODE"}, \text{"CXDE"}) = 1$ (O → X)
+    * Result: Both appear equally likely/distant.
+
+* **OCR-StringDist (Weighted):**
+    * $d(\text{"CODE"}, \text{"C0DE"}) \approx 0.1$ (common error, low cost)
+    * $d(\text{"CODE"}, \text{"CXDE"}) = 1.0$ (unlikely error, high cost)
+    * Result: Correctly identifies `C0DE` as a much closer match.
+
+This makes it ideal for matching potentially incorrect OCR output against known values (e.g., product codes, database entries).
+
+## Installation
+
+```bash
+pip install ocr-stringdist
+```
+
+## Features
+
+- **High Performance**: The core logic is implemented in Rust with speed in mind.
+- **Weighted Levenshtein Distance**: Calculates Levenshtein distance with customizable costs for substitutions, insertions, and deletions. Includes an efficient batch version (`batch_weighted_levenshtein_distance`) for comparing one string against many candidates.
+- **Explainable Edit Path**: Returns the optimal sequence of edit operations (substitutions, insertions, and deletions) used to transform one string into another.
+- **Substitution of Multiple Characters**: Not just character pairs, but string pairs may be substituted, for example the Korean syllable "이" for the two letters "OI".
+- **Pre-defined OCR Distance Map**: A built-in distance map for common OCR confusions (e.g., "0" vs "O", "1" vs "l", "5" vs "S").
+- **Unicode Support**: Works with arbitrary Unicode strings.
+- **Best Match Finder**: Includes a utility function `find_best_candidate` to efficiently find the best match from a list based on _any_ distance function.
+
+## Usage
+
+### Basic usage
+
+```python
+from ocr_stringdist import WeightedLevenshtein
+
+# Default substitution costs are ocr_stringdist.ocr_distance_map.
+wl = WeightedLevenshtein()
+
+print(wl.distance("CXDE", "CODE")) # == 1
+print(wl.distance("C0DE", "CODE")) # < 1
+```
+
+### Explain the Edit Path
+
+```python
+edit_path = wl.explain("C0DE", "CODE")
+print(edit_path)
+# EditOperation(op_type='substitute', source_token='0', target_token='O', cost=0.1)]
+```
+
+### Fast Batch Calculations
+
+Quickly compare a string to a list of candidates.
+
+```python
+distances: list[float] = wl.batch_distance("CODE", ["CXDE", "C0DE"])
+# [1.0, 0.1]
+```
+
+### Multi-character Substitutions
+
+```python
+# Custom costs with multi-character substitution
+wl = WeightedLevenshtein(substitution_costs={("In", "h"): 0.5})
+
+print(wl.distance("hi", "Ini")) # 0.5
+```
+
+
+## Acknowledgements
+
+This project is inspired by [jellyfish](https://github.com/jamesturk/jellyfish), providing the base implementations of the algorithms used here.
+

{ocr_stringdist-0.2.0.dist-info → ocr_stringdist-0.2.2.dist-info}/RECORD

@@ -1,11 +1,11 @@
-ocr_stringdist-0.2.0.dist-info/METADATA,sha256=OVF3jUKVM038ogWfwZIHmpu3eUXdeuS1Cy-t96G8Tgo,304
-ocr_stringdist-0.2.0.dist-info/WHEEL,sha256=nTH9UaXhMe2Z7vYjzTFaj4VIXUvQaRiC6yVlzzX1nis,105
-ocr_stringdist-0.2.0.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
-ocr_stringdist.libs/libgcc_s-b5472b99.so.1,sha256=wh8CpjXz9IccAyeERcB7YDEx7NH2jF-PykwOyYNeRRI,453841
+ocr_stringdist-0.2.2.dist-info/METADATA,sha256=2KjG6DHqpsannN0lPK4EwkYBbY3adZrl1oTCq-elnL8,3868
+ocr_stringdist-0.2.2.dist-info/WHEEL,sha256=nTH9UaXhMe2Z7vYjzTFaj4VIXUvQaRiC6yVlzzX1nis,105
+ocr_stringdist-0.2.2.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
+ocr_stringdist.libs/libgcc_s-27e5a392.so.1,sha256=x5sO63liVwXxrjGGP371wB0RyQe1KEnIynYm82T0G0M,449745
 ocr_stringdist/__init__.py,sha256=ApxqraLRcWAkzXhGJXSf3EqGEVFbxghrYrfJ9dmQjQU,467
-ocr_stringdist/_rust_stringdist.cpython-311-i386-linux-musl.so,sha256=QS_4-aXp3qJeK28rq8dpoXh5K5um5w3MOGaI9hDwmVU,776585
+ocr_stringdist/_rust_stringdist.cpython-311-i386-linux-musl.so,sha256=Upv_g-UfBmugHL7FC_rFjOsGjXJcF8wtHSE99Oi6Ctw,776585
 ocr_stringdist/default_ocr_distances.py,sha256=oSu-TpHjPA4jxKpLAfmap8z0ZsC99jsOjnRVHW7Hj_Y,1033
 ocr_stringdist/levenshtein.py,sha256=Jypg31BQyULipJ_Yh3dcBQDKNnbvEIlmf28tDr_gySw,11243
 ocr_stringdist/matching.py,sha256=rr8R63Ttu2hTf5Mni7_P8aGBbjWs6t2QPV3wxKXspAs,3293
 ocr_stringdist/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ocr_stringdist-0.2.0.dist-info/RECORD,,
+ocr_stringdist-0.2.2.dist-info/RECORD,,

ocr_stringdist-0.2.0.dist-info/METADATA

@@ -1,9 +0,0 @@
-Metadata-Version: 2.4
-Name: ocr_stringdist
-Version: 0.2.0
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python
-Classifier: Operating System :: OS Independent
-License-File: LICENSE
-Requires-Python: >=3.9
-Project-URL: repository, https://github.com/NiklasvonM/ocr-stringdist