zer-core 1.0.2

Core traits and types for the zer entity-resolution library
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
25
26
27
28
29
30

use crate::{comparison::ComparisonVector, record::RecordId};

/// Coarse classification of a scored pair based on match probability.
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum MatchBand {
    AutoMatch,
    Borderline,
    AutoReject,
}

/// Learned Fellegi-Sunter m/u parameters and classification thresholds for one schema.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct ModelParams {
    pub m: Vec<Vec<f32>>,
    pub u: Vec<Vec<f32>>,
    pub log_prior_odds:  f32,
    pub upper_threshold: f32,
    pub lower_threshold: f32,
}

/// A candidate pair annotated with its match weight, probability, and band.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct ScoredPair {
    pub record_a:          RecordId,
    pub record_b:          RecordId,
    pub match_weight:      f32,
    pub match_probability: f32,
    pub vector:            ComparisonVector,
    pub band:              MatchBand,
}