selene-db-graph 1.3.0

In-memory property-graph storage core (ArcSwap + imbl CoW, label/typed indexes, write funnel) for selene-db.
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
102
103
104
105
106
107
108
109

//! Vector-index configuration validation.

use selene_core::{HnswIndexConfig, IvfIndexConfig};

use crate::{GraphError, GraphResult};

use super::VectorIndexKind;

/// Upper bound for HNSW `M` accepted by the native graph engine.
pub(crate) const MAX_HNSW_MAX_NEIGHBORS: u16 = 512;
/// Upper bound for HNSW construction beam width.
pub(crate) const MAX_HNSW_EF_CONSTRUCTION: u16 = 4096;
/// Upper bound for explicit IVF target centroid counts.
pub(crate) const MAX_IVF_TARGET_CENTROIDS: u16 = 1024;

pub(crate) fn hnsw_config_for_kind(
    kind: VectorIndexKind,
    config: Option<HnswIndexConfig>,
) -> GraphResult<Option<HnswIndexConfig>> {
    match (kind.hnsw_metric(), config) {
        (None, None) => Ok(None),
        (None, Some(config)) => Err(invalid_config(
            config,
            "only HNSW vector indexes accept HNSW config",
        )),
        (Some(_), None) => Ok(Some(HnswIndexConfig::default())),
        (Some(_), Some(config)) => {
            validate_hnsw_config(config)?;
            Ok(Some(config))
        }
    }
}

pub(crate) fn validate_hnsw_config(config: HnswIndexConfig) -> GraphResult<()> {
    if config.max_neighbors == 0 {
        return Err(invalid_config(
            config,
            "max_neighbors must be greater than zero",
        ));
    }
    if config.max_neighbors > MAX_HNSW_MAX_NEIGHBORS {
        return Err(invalid_config(config, "max_neighbors exceeds engine cap"));
    }
    if config.ef_construction == 0 {
        return Err(invalid_config(
            config,
            "ef_construction must be greater than zero",
        ));
    }
    if config.ef_construction > MAX_HNSW_EF_CONSTRUCTION {
        return Err(invalid_config(config, "ef_construction exceeds engine cap"));
    }
    if config.ef_construction < config.max_neighbors {
        return Err(invalid_config(
            config,
            "ef_construction must be at least max_neighbors",
        ));
    }
    Ok(())
}

fn invalid_config(config: HnswIndexConfig, reason: &'static str) -> GraphError {
    GraphError::VectorIndexInvalidHnswConfig {
        max_neighbors: config.max_neighbors,
        ef_construction: config.ef_construction,
        reason,
    }
}

pub(crate) fn ivf_config_for_kind(
    kind: VectorIndexKind,
    config: Option<IvfIndexConfig>,
) -> GraphResult<Option<IvfIndexConfig>> {
    match (kind.ivf_metric(), config) {
        (None, None) => Ok(None),
        (None, Some(config)) => Err(invalid_ivf_config(
            config,
            "only IVF vector indexes accept IVF config",
        )),
        (Some(_), None) => Ok(None),
        (Some(_), Some(config)) => {
            validate_ivf_config(config)?;
            Ok(Some(config))
        }
    }
}

pub(crate) fn validate_ivf_config(config: IvfIndexConfig) -> GraphResult<()> {
    if config.target_centroids == 0 {
        return Err(invalid_ivf_config(
            config,
            "target_centroids must be greater than zero",
        ));
    }
    if config.target_centroids > MAX_IVF_TARGET_CENTROIDS {
        return Err(invalid_ivf_config(
            config,
            "target_centroids exceeds engine cap",
        ));
    }
    Ok(())
}

fn invalid_ivf_config(config: IvfIndexConfig, reason: &'static str) -> GraphError {
    GraphError::VectorIndexInvalidIvfConfig {
        target_centroids: config.target_centroids,
        reason,
    }
}