zer-compare 1.0.1

Fellegi-Sunter field comparison, similarity functions, and EM scoring for zer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# zer-compare

Fellegi-Sunter field comparison, similarity functions, and EM scoring for the [zer](https://crates.io/crates/zer) entity-resolution library.

This crate is the CPU implementation of the comparison and scoring pipeline. For GPU-accelerated equivalents see [`zer-compute`](https://crates.io/crates/zer-compute).

## What it provides

| Item | Description |
|------|-------------|
| `FieldComparator` | Compares record pairs field-by-field, producing comparison vectors |
| `FellegiSunterScorer` | Computes match probability from comparison vectors using trained m/u parameters |
| `SimilarityFn` | Trait for plugging in custom similarity functions |
| `JaroWinklerSimilarity` | Jaro-Winkler string distance, good for short names |
| `LevenshteinSimilarity` | Edit distance similarity |
| `PhoneticEqualitySimilarity` | Phonetic matching via Soundex / Double Metaphone |
| `TokenOverlapSimilarity` | Jaccard-based token overlap, good for addresses |
| `AddressTokenOverlap` | Dutch address-aware token comparison |
| `run_em` / `auto_calibrate_thresholds` | EM algorithm for unsupervised m/u parameter estimation |
| `LevelThresholds` | Discretises continuous similarity scores into comparison levels |

## License

Apache-2.0 ยท [GitHub](https://github.com/ZAL-Analytics/zer)