kglite 0.10.9

Pure-Rust knowledge graph engine — Cypher pipeline, snapshot/working CoW transactions, columnar/mmap/disk storage backends, optional dataset loaders (SEC EDGAR, Sodir, Wikidata). PyO3 wrappers live in the sibling kglite-py crate (the Python wheel); embeddable directly from any Rust binary without PyO3 in the dep tree.
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Storage-mode planning — estimate the built graph's resident size
//! for a given scope, and pick the cheapest backend that fits.
//!
//! Pure formulas, ported from the Python `sec/wrapper.py`. The size
//! formula is calibrated against the loader's measured node-count
//! behaviour (see `docs/guides/sec.md` "Sizing").

/// The full SEC filer universe — used to scale a `cik_list` scope
/// down to a fraction of the whole.
const FULL_UNIVERSE: f64 = 6000.0;

/// Estimate the built graph's resident size in GB.
///
/// `cik_count` is the number of CIKs in the scope filter; `None` (or
/// `Some(0)`) means the full universe.
pub fn predict_graph_size_gb(
    years: u32,
    detailed: u32,
    cik_count: Option<usize>,
    include_subsidiaries: bool,
    include_xbrl_metrics: bool,
    include_8k_events: bool,
) -> f64 {
    let cik_fraction = match cik_count {
        None | Some(0) => 1.0,
        Some(n) => (n as f64 / FULL_UNIVERSE).min(1.0),
    };
    // Shallow filing index: ~0.1 GB per ingested year.
    let mut gb = 0.1 * years as f64 * cik_fraction;
    if detailed > 0 {
        let d = detailed as f64;
        // Form 4 + 13F + Exhibit 21 baseline.
        gb += 0.6 * d * cik_fraction;
        if include_xbrl_metrics {
            gb += 4.0 * d * cik_fraction;
        }
        if include_8k_events {
            gb += 1.0 * d * cik_fraction;
        }
        if include_subsidiaries {
            gb += 0.05 * d * cik_fraction;
        }
    }
    gb
}

/// Pick a storage backend for an estimated graph size: `memory` below
/// 4 GB, `mapped` from 4 to 16 GB, `disk` above.
pub fn pick_storage_mode(predicted_gb: f64) -> &'static str {
    if predicted_gb < 4.0 {
        "memory"
    } else if predicted_gb < 16.0 {
        "mapped"
    } else {
        "disk"
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn full_universe_scope_uses_fraction_one() {
        // years=10, detailed=2, every payload → 1 + 1.2 + 8 + 2 + 0.1.
        let gb = predict_graph_size_gb(10, 2, None, true, true, true);
        assert!((gb - 12.3).abs() < 1e-9, "got {gb}");
    }

    #[test]
    fn cik_list_scales_size_down() {
        let full = predict_graph_size_gb(10, 2, None, true, true, true);
        let sliced = predict_graph_size_gb(10, 2, Some(600), true, true, true);
        // 600 / 6000 = 10% of the universe.
        assert!((sliced - full * 0.1).abs() < 1e-9, "got {sliced}");
    }

    #[test]
    fn detailed_zero_skips_payload_terms() {
        let gb = predict_graph_size_gb(5, 0, None, true, true, true);
        assert!((gb - 0.5).abs() < 1e-9, "got {gb}");
    }

    #[test]
    fn empty_cik_list_is_full_universe() {
        assert_eq!(
            predict_graph_size_gb(10, 2, Some(0), true, true, true),
            predict_graph_size_gb(10, 2, None, true, true, true),
        );
    }

    #[test]
    fn storage_mode_thresholds() {
        assert_eq!(pick_storage_mode(2.0), "memory");
        assert_eq!(pick_storage_mode(3.99), "memory");
        assert_eq!(pick_storage_mode(4.0), "mapped");
        assert_eq!(pick_storage_mode(15.9), "mapped");
        assert_eq!(pick_storage_mode(16.0), "disk");
        assert_eq!(pick_storage_mode(100.0), "disk");
    }
}