ocr-stringdist 0.0.5__cp310-cp310-musllinux_1_1_i686.whl → 0.0.6__cp310-cp310-musllinux_1_1_i686.whl

ocr_stringdist/__init__.py

@@ -6,7 +6,8 @@ from .matching import find_best_candidate
 
 __all__ = [
     "ocr_distance_map",
-    "weighted_levenshtein_distance",  # noqa: F405
+    "weighted_levenshtein_distance",
+    "batch_weighted_levenshtein_distance",
     "find_best_candidate",
 ]
 
@@ -19,24 +20,79 @@ def weighted_levenshtein_distance(
     *,
     symmetric: bool = True,
     default_cost: float = 1.0,
+    max_token_characters: int = 1,
 ) -> float:
     """
     Levenshtein distance with custom substitution costs.
     Insertion/deletion costs are 1.
 
-    The default `cost_map` considers common OCR errors, see `ocr_stringdist.ocr_distance_map`.
+    The default `cost_map` considers common OCR errors, see
+    :py:data:`ocr_stringdist.default_ocr_distances.ocr_distance_map`.
 
     :param s1: First string
     :param s2: Second string
-    :param cost_map: Dictionary mapping tuples of characters to their substitution cost.
+    :param cost_map: Dictionary mapping tuples of strings ("substitution tokens") to their
+                     substitution costs.
                      Only one direction needs to be configured unless `symmetric` is False.
+                     Note that you need to set `max_token_characters` if the substitution tokens
+                     have more than one character, for example when substituting "w" for "vv".
                      Defaults to `ocr_stringdist.ocr_distance_map`.
     :param symmetric: Should the keys of `cost_map` be considered to be symmetric? Defaults to True.
     :param default_cost: The default substitution cost for character pairs not found in `cost_map`.
+    :param max_token_characters: A positive integer, indicating the maximum number of characters a
+                                 substitution token in `cost_map` may have. The default 1 indicates
+                                 that only single characters can be substituted for each other.
+                                 Higher values lead to slower calculations.
     """
     if cost_map is None:
         cost_map = ocr_distance_map
     # _weighted_levenshtein_distance is written in Rust, see src/rust_stringdist.rs.
     return _weighted_levenshtein_distance(  # type: ignore  # noqa: F405
-        s1, s2, cost_map=cost_map, symmetric=symmetric, default_cost=default_cost
+        s1,
+        s2,
+        cost_map=cost_map,
+        symmetric=symmetric,
+        default_cost=default_cost,
+        max_token_characters=max_token_characters,
+    )
+
+
+def batch_weighted_levenshtein_distance(
+    s: str,
+    candidates: list[str],
+    /,
+    cost_map: Optional[dict[tuple[str, str], float]] = None,
+    *,
+    symmetric: bool = True,
+    default_cost: float = 1.0,
+    max_token_characters: int = 1,
+) -> list[float]:
+    """
+    Calculate weighted Levenshtein distances between a string and multiple candidates.
+
+    This is more efficient than calling :func:`weighted_levenshtein_distance` multiple times.
+
+    :param s: The string to compare
+    :param candidates: List of candidate strings to compare against
+    :param cost_map: Dictionary mapping tuples of characters to their substitution cost.
+                     Only one direction needs to be configured unless `symmetric` is False.
+                     Defaults to `ocr_stringdist.ocr_distance_map`.
+    :param symmetric: Should the keys of `cost_map` be considered to be symmetric? Defaults to True.
+    :param default_cost: The default substitution cost for character pairs not found in `cost_map`.
+    :param max_token_characters: A positive integer, indicating the maximum number of characters a
+                                 substitution token in `cost_map` may have. The default 1 indicates
+                                 that only single characters can be substituted for each other.
+                                 Higher values lead to slower calculations.
+    :return: A list of distances corresponding to each candidate
+    """
+    if cost_map is None:
+        cost_map = ocr_distance_map
+    # _batch_weighted_levenshtein_distance is written in Rust, see src/rust_stringdist.rs.
+    return _batch_weighted_levenshtein_distance(  # type: ignore  # noqa: F405
+        s,
+        candidates,
+        cost_map=cost_map,
+        symmetric=symmetric,
+        default_cost=default_cost,
+        max_token_characters=max_token_characters,
     )

ocr_stringdist/default_ocr_distances.py

@@ -1,3 +1,5 @@
+# Start marker for literalinclude, see docs/source/api/index.rst.
+# OCR_DISTANCE_MAP_START
 ocr_distance_map: dict[tuple[str, str], float] = {
     ("O", "0"): 0.1,
     ("l", "1"): 0.1,
@@ -31,6 +33,8 @@ ocr_distance_map: dict[tuple[str, str], float] = {
     ("é", "á"): 0.7,
     ("E", "F"): 0.8,
 }
+# OCR_DISTANCE_MAP_END
+# End marker for literalinclude
 """
 Pre-defined distance map between characters, considering common OCR errors.
 The distances are between 0 and 1.

{ocr_stringdist-0.0.5.dist-info → ocr_stringdist-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ocr_stringdist
-Version: 0.0.5
+Version: 0.0.6
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python
 Classifier: Operating System :: OS Independent
@@ -36,7 +36,7 @@ pip install ocr-stringdist
 
 ## Features
 
-- **Weighted Levenshtein Distance**: An adaptation of the classic Levenshtein algorithm with custom substitution costs for character pairs that are commonly confused in OCR models.
+- **Weighted Levenshtein Distance**: An adaptation of the classic Levenshtein algorithm with custom substitution costs for character pairs that are commonly confused in OCR models, including efficient batch processing.
 - **Unicode Support**: Arbitrary unicode strings can be compared.
 - **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").
@@ -60,7 +60,7 @@ distance = osd.weighted_levenshtein_distance(
     "hi", "Ini",
     cost_map=custom_map,
     symmetric=True,
-    default_cost=1.0,
+    max_token_characters=2,
 )
 print(f"Distance with custom map: {distance}")
 ```

ocr_stringdist-0.0.6.dist-info/RECORD

@@ -0,0 +1,10 @@
+ocr_stringdist-0.0.6.dist-info/METADATA,sha256=w_dnhka08_rjLZ3LxFzTqeaUuvUrzer7FkjrqQI2xIg,3522
+ocr_stringdist-0.0.6.dist-info/WHEEL,sha256=Cl-l6-pHsPQyGZM6aZ9ZaqUOwfa3C4W3NzP4o7ok8tc,105
+ocr_stringdist-0.0.6.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
+ocr_stringdist.libs/libgcc_s-b5472b99.so.1,sha256=wh8CpjXz9IccAyeERcB7YDEx7NH2jF-PykwOyYNeRRI,453841
+ocr_stringdist/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ocr_stringdist/__init__.py,sha256=45mZy8Gx3ygO60XAcWR8ZVS4LAoPcvKd946MwbM9-vc,4172
+ocr_stringdist/default_ocr_distances.py,sha256=oSu-TpHjPA4jxKpLAfmap8z0ZsC99jsOjnRVHW7Hj_Y,1033
+ocr_stringdist/matching.py,sha256=rr8R63Ttu2hTf5Mni7_P8aGBbjWs6t2QPV3wxKXspAs,3293
+ocr_stringdist/_rust_stringdist.cpython-310-i386-linux-gnu.so,sha256=LVB2GInVHw9v-8q60F9yuSSyIyYofulBRhWObHn5X-4,715173
+ocr_stringdist-0.0.6.dist-info/RECORD,,

ocr_stringdist-0.0.5.dist-info/RECORD

@@ -1,10 +0,0 @@
-ocr_stringdist-0.0.5.dist-info/METADATA,sha256=vX4O04CresnzPoQnQSnejENFPcgSK5XWqRewrBvl9BU,3478
-ocr_stringdist-0.0.5.dist-info/WHEEL,sha256=Cl-l6-pHsPQyGZM6aZ9ZaqUOwfa3C4W3NzP4o7ok8tc,105
-ocr_stringdist-0.0.5.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
-ocr_stringdist.libs/libgcc_s-b5472b99.so.1,sha256=wh8CpjXz9IccAyeERcB7YDEx7NH2jF-PykwOyYNeRRI,453841
-ocr_stringdist/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ocr_stringdist/__init__.py,sha256=zL-0Bmo6jCas2QlDCGxL2vPbjoNrdpLQ9kPfsAjC0QI,1515
-ocr_stringdist/default_ocr_distances.py,sha256=8jmR5aLrEfrm5Fj2-nEqdTCKEmoEcm8DxBWv7IQd5_k,887
-ocr_stringdist/matching.py,sha256=rr8R63Ttu2hTf5Mni7_P8aGBbjWs6t2QPV3wxKXspAs,3293
-ocr_stringdist/_rust_stringdist.cpython-310-i386-linux-gnu.so,sha256=ITXMBeDNzem7DUebJeAns2siEq8wg7jYRtr_U1D5iiU,559137
-ocr_stringdist-0.0.5.dist-info/RECORD,,