ruvector-gnn 2.1.0

Graph Neural Network layer for Ruvector on HNSW topology
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
110
111

//! Error types for the GNN module.

use thiserror::Error;

/// Result type alias for GNN operations.
pub type Result<T> = std::result::Result<T, GnnError>;

/// Errors that can occur during GNN operations.
#[derive(Error, Debug)]
pub enum GnnError {
    /// Tensor dimension mismatch
    #[error("Tensor dimension mismatch: expected {expected}, got {actual}")]
    DimensionMismatch {
        /// Expected dimension
        expected: String,
        /// Actual dimension
        actual: String,
    },

    /// Invalid tensor shape
    #[error("Invalid tensor shape: {0}")]
    InvalidShape(String),

    /// Layer configuration error
    #[error("Layer configuration error: {0}")]
    LayerConfig(String),

    /// Training error
    #[error("Training error: {0}")]
    Training(String),

    /// Compression error
    #[error("Compression error: {0}")]
    Compression(String),

    /// Search error
    #[error("Search error: {0}")]
    Search(String),

    /// Invalid input
    #[error("Invalid input: {0}")]
    InvalidInput(String),

    /// Memory mapping error
    #[cfg(not(target_arch = "wasm32"))]
    #[error("Memory mapping error: {0}")]
    Mmap(String),

    /// I/O error
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// Core library error
    #[error("Core error: {0}")]
    Core(#[from] ruvector_core::error::RuvectorError),

    /// Generic error
    #[error("{0}")]
    Other(String),
}

impl GnnError {
    /// Create a dimension mismatch error
    pub fn dimension_mismatch(expected: impl Into<String>, actual: impl Into<String>) -> Self {
        Self::DimensionMismatch {
            expected: expected.into(),
            actual: actual.into(),
        }
    }

    /// Create an invalid shape error
    pub fn invalid_shape(msg: impl Into<String>) -> Self {
        Self::InvalidShape(msg.into())
    }

    /// Create a layer config error
    pub fn layer_config(msg: impl Into<String>) -> Self {
        Self::LayerConfig(msg.into())
    }

    /// Create a training error
    pub fn training(msg: impl Into<String>) -> Self {
        Self::Training(msg.into())
    }

    /// Create a compression error
    pub fn compression(msg: impl Into<String>) -> Self {
        Self::Compression(msg.into())
    }

    /// Create a search error
    pub fn search(msg: impl Into<String>) -> Self {
        Self::Search(msg.into())
    }

    /// Create a memory mapping error
    #[cfg(not(target_arch = "wasm32"))]
    pub fn mmap(msg: impl Into<String>) -> Self {
        Self::Mmap(msg.into())
    }

    /// Create an invalid input error
    pub fn invalid_input(msg: impl Into<String>) -> Self {
        Self::InvalidInput(msg.into())
    }

    /// Create a generic error
    pub fn other(msg: impl Into<String>) -> Self {
        Self::Other(msg.into())
    }
}