ruvllm-esp32 0.1.1

Tiny LLM inference for ESP32 microcontrollers with INT8/INT4 quantization, multi-chip federation, RuVector semantic memory, and SNN-gated energy optimization
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
//! Micro HNSW - Approximate Nearest Neighbor for ESP32
//!
//! A minimal HNSW (Hierarchical Navigable Small World) implementation
//! designed for ESP32's memory constraints.
//!
//! # Features
//! - Fixed-size graph structure (no dynamic allocation)
//! - INT8 quantized vectors
//! - Binary quantization option (32x smaller)
//! - O(log n) search complexity
//!
//! # Memory Usage
//!
//! For 64-dimensional INT8 vectors:
//! - 100 vectors: ~8 KB
//! - 500 vectors: ~40 KB
//! - 1000 vectors (binary): ~10 KB

use heapless::Vec as HVec;
use heapless::BinaryHeap;
use heapless::binary_heap::Min;
use super::{MicroVector, DistanceMetric, euclidean_distance_i8, MAX_NEIGHBORS};

/// Maximum vectors in the index
pub const INDEX_CAPACITY: usize = 256;
/// Maximum layers in HNSW
pub const MAX_LAYERS: usize = 4;
/// Default neighbors per layer
pub const DEFAULT_M: usize = 8;
/// Search expansion factor
pub const EF_SEARCH: usize = 16;

/// HNSW Configuration
#[derive(Debug, Clone)]
pub struct HNSWConfig {
    /// Max neighbors per node
    pub m: usize,
    /// Neighbors at layer 0 (usually 2*M)
    pub m_max0: usize,
    /// Construction expansion factor
    pub ef_construction: usize,
    /// Search expansion factor
    pub ef_search: usize,
    /// Distance metric
    pub metric: DistanceMetric,
    /// Enable binary quantization
    pub binary_mode: bool,
}

impl Default for HNSWConfig {
    fn default() -> Self {
        Self {
            m: 8,
            m_max0: 16,
            ef_construction: 32,
            ef_search: 16,
            metric: DistanceMetric::Euclidean,
            binary_mode: false,
        }
    }
}

/// Search result
#[derive(Debug, Clone, Copy)]
pub struct SearchResult {
    /// Vector ID
    pub id: u32,
    /// Distance to query
    pub distance: i32,
    /// Index in storage
    pub index: usize,
}

impl PartialEq for SearchResult {
    fn eq(&self, other: &Self) -> bool {
        self.distance == other.distance
    }
}

impl Eq for SearchResult {}

impl PartialOrd for SearchResult {
    fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for SearchResult {
    fn cmp(&self, other: &Self) -> core::cmp::Ordering {
        self.distance.cmp(&other.distance)
    }
}

/// Node in the HNSW graph
#[derive(Debug, Clone)]
struct HNSWNode<const DIM: usize> {
    /// Vector data
    vector: HVec<i8, DIM>,
    /// User ID
    id: u32,
    /// Neighbors per layer [layer][neighbor_indices]
    neighbors: [HVec<u16, MAX_NEIGHBORS>; MAX_LAYERS],
    /// Maximum layer this node exists on
    max_layer: u8,
}

impl<const DIM: usize> Default for HNSWNode<DIM> {
    fn default() -> Self {
        Self {
            vector: HVec::new(),
            id: 0,
            neighbors: Default::default(),
            max_layer: 0,
        }
    }
}

/// Micro HNSW Index
pub struct MicroHNSW<const DIM: usize, const CAPACITY: usize> {
    /// Configuration
    config: HNSWConfig,
    /// Stored nodes
    nodes: HVec<HNSWNode<DIM>, CAPACITY>,
    /// Entry point (highest layer node)
    entry_point: Option<usize>,
    /// Current maximum layer
    max_layer: u8,
    /// Random seed for layer selection
    rng_state: u32,
}

impl<const DIM: usize, const CAPACITY: usize> MicroHNSW<DIM, CAPACITY> {
    /// Create new HNSW index
    pub fn new(config: HNSWConfig) -> Self {
        Self {
            config,
            nodes: HVec::new(),
            entry_point: None,
            max_layer: 0,
            rng_state: 12345, // Default seed
        }
    }

    /// Set random seed
    pub fn with_seed(mut self, seed: u32) -> Self {
        self.rng_state = seed;
        self
    }

    /// Number of vectors in index
    pub fn len(&self) -> usize {
        self.nodes.len()
    }

    /// Check if empty
    pub fn is_empty(&self) -> bool {
        self.nodes.is_empty()
    }

    /// Memory usage in bytes
    pub fn memory_bytes(&self) -> usize {
        // Approximate: vectors + neighbor lists
        self.nodes.len() * (DIM + MAX_LAYERS * MAX_NEIGHBORS * 2 + 8)
    }

    /// Insert a vector
    pub fn insert(&mut self, vector: &MicroVector<DIM>) -> Result<usize, &'static str> {
        if self.nodes.len() >= CAPACITY {
            return Err("Index full");
        }

        let new_idx = self.nodes.len();
        let new_layer = self.random_layer();

        // Create node
        let mut node = HNSWNode::<DIM>::default();
        node.vector = vector.data.clone();
        node.id = vector.id;
        node.max_layer = new_layer;

        // First node is simple
        if self.entry_point.is_none() {
            self.nodes.push(node).map_err(|_| "Push failed")?;
            self.entry_point = Some(new_idx);
            self.max_layer = new_layer;
            return Ok(new_idx);
        }

        let entry = self.entry_point.unwrap();

        // Add node first so we can reference it
        self.nodes.push(node).map_err(|_| "Push failed")?;

        // Search for neighbors from top layer down
        let mut current = entry;

        // Traverse upper layers
        for layer in (new_layer as usize + 1..=self.max_layer as usize).rev() {
            current = self.greedy_search_layer(current, &vector.data, layer);
        }

        // Insert at each layer
        for layer in (0..=(new_layer as usize).min(self.max_layer as usize)).rev() {
            let neighbors = self.search_layer(current, &vector.data, layer, self.config.ef_construction);

            // Connect to best neighbors
            let max_neighbors = if layer == 0 { self.config.m_max0 } else { self.config.m };
            let mut added = 0;

            for result in neighbors.iter().take(max_neighbors) {
                if added >= MAX_NEIGHBORS {
                    break;
                }

                // Add bidirectional connection
                if let Some(new_node) = self.nodes.get_mut(new_idx) {
                    let _ = new_node.neighbors[layer].push(result.index as u16);
                }

                if let Some(neighbor_node) = self.nodes.get_mut(result.index) {
                    if neighbor_node.neighbors[layer].len() < MAX_NEIGHBORS {
                        let _ = neighbor_node.neighbors[layer].push(new_idx as u16);
                    }
                }

                added += 1;
            }

            if !neighbors.is_empty() {
                current = neighbors[0].index;
            }
        }

        // Update entry point if new node has higher layer
        if new_layer > self.max_layer {
            self.entry_point = Some(new_idx);
            self.max_layer = new_layer;
        }

        Ok(new_idx)
    }

    /// Search for k nearest neighbors
    pub fn search(&self, query: &[i8], k: usize) -> HVec<SearchResult, 32> {
        let mut results = HVec::new();

        if self.entry_point.is_none() || k == 0 {
            return results;
        }

        let entry = self.entry_point.unwrap();

        // Traverse from top layer
        let mut current = entry;
        for layer in (1..=self.max_layer as usize).rev() {
            current = self.greedy_search_layer(current, query, layer);
        }

        // Search layer 0 with ef expansion
        let candidates = self.search_layer(current, query, 0, self.config.ef_search);

        // Return top k
        for result in candidates.into_iter().take(k) {
            let _ = results.push(result);
        }

        results
    }

    /// Search specific layer
    fn search_layer(&self, entry: usize, query: &[i8], layer: usize, ef: usize) -> HVec<SearchResult, 64> {
        let mut visited = [false; CAPACITY];
        let mut candidates: BinaryHeap<SearchResult, Min, 64> = BinaryHeap::new();
        let mut results: HVec<SearchResult, 64> = HVec::new();

        visited[entry] = true;
        let entry_dist = self.distance(query, entry);

        let _ = candidates.push(SearchResult {
            id: self.nodes[entry].id,
            distance: entry_dist,
            index: entry,
        });
        let _ = results.push(SearchResult {
            id: self.nodes[entry].id,
            distance: entry_dist,
            index: entry,
        });

        while let Some(current) = candidates.pop() {
            // Early termination
            if results.len() >= ef {
                if let Some(worst) = results.iter().max_by_key(|r| r.distance) {
                    if current.distance > worst.distance {
                        break;
                    }
                }
            }

            // Explore neighbors
            if let Some(node) = self.nodes.get(current.index) {
                if layer < node.neighbors.len() {
                    for &neighbor_idx in node.neighbors[layer].iter() {
                        let neighbor_idx = neighbor_idx as usize;
                        if neighbor_idx < CAPACITY && !visited[neighbor_idx] {
                            visited[neighbor_idx] = true;

                            let dist = self.distance(query, neighbor_idx);

                            // Add if better than worst in results
                            let should_add = results.len() < ef ||
                                results.iter().any(|r| dist < r.distance);

                            if should_add {
                                let result = SearchResult {
                                    id: self.nodes[neighbor_idx].id,
                                    distance: dist,
                                    index: neighbor_idx,
                                };
                                let _ = candidates.push(result);
                                let _ = results.push(result);

                                // Keep results bounded
                                if results.len() > ef * 2 {
                                    results.sort_by_key(|r| r.distance);
                                    results.truncate(ef);
                                }
                            }
                        }
                    }
                }
            }
        }

        // Sort and truncate
        results.sort_by_key(|r| r.distance);
        results
    }

    /// Greedy search on a single layer
    fn greedy_search_layer(&self, entry: usize, query: &[i8], layer: usize) -> usize {
        let mut current = entry;
        let mut current_dist = self.distance(query, current);

        loop {
            let mut improved = false;

            if let Some(node) = self.nodes.get(current) {
                if layer < node.neighbors.len() {
                    for &neighbor_idx in node.neighbors[layer].iter() {
                        let neighbor_idx = neighbor_idx as usize;
                        if neighbor_idx < self.nodes.len() {
                            let dist = self.distance(query, neighbor_idx);
                            if dist < current_dist {
                                current = neighbor_idx;
                                current_dist = dist;
                                improved = true;
                            }
                        }
                    }
                }
            }

            if !improved {
                break;
            }
        }

        current
    }

    /// Calculate distance between query and stored vector
    fn distance(&self, query: &[i8], idx: usize) -> i32 {
        if let Some(node) = self.nodes.get(idx) {
            self.config.metric.distance(query, &node.vector)
        } else {
            i32::MAX
        }
    }

    /// Generate random layer (exponential distribution)
    fn random_layer(&mut self) -> u8 {
        // Simple LCG random
        self.rng_state = self.rng_state.wrapping_mul(1103515245).wrapping_add(12345);
        let rand = self.rng_state;

        // Count leading zeros gives exponential distribution
        let layer = (rand.leading_zeros() / 4) as u8;
        layer.min(MAX_LAYERS as u8 - 1)
    }

    /// Get vector by index
    pub fn get(&self, idx: usize) -> Option<&[i8]> {
        self.nodes.get(idx).map(|n| n.vector.as_slice())
    }

    /// Get ID by index
    pub fn get_id(&self, idx: usize) -> Option<u32> {
        self.nodes.get(idx).map(|n| n.id)
    }
}

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

    #[test]
    fn test_hnsw_basic() {
        let mut index: MicroHNSW<8, 100> = MicroHNSW::new(HNSWConfig::default());

        // Insert vectors
        for i in 0..10 {
            let data: HVec<i8, 8> = (0..8).map(|j| (i * 10 + j) as i8).collect();
            let vec = MicroVector { data, id: i as u32 };
            index.insert(&vec).unwrap();
        }

        assert_eq!(index.len(), 10);
    }

    #[test]
    fn test_hnsw_search() {
        let mut index: MicroHNSW<4, 100> = MicroHNSW::new(HNSWConfig::default());

        // Insert specific vectors
        let vectors = [
            [10i8, 0, 0, 0],
            [0i8, 10, 0, 0],
            [0i8, 0, 10, 0],
            [11i8, 1, 0, 0], // Close to first
        ];

        for (i, v) in vectors.iter().enumerate() {
            let data: HVec<i8, 4> = v.iter().copied().collect();
            let vec = MicroVector { data, id: i as u32 };
            index.insert(&vec).unwrap();
        }

        // Search for vector close to first
        let query = [10i8, 0, 0, 0];
        let results = index.search(&query, 2);

        assert!(!results.is_empty());
        assert_eq!(results[0].id, 0); // Exact match should be first
    }
}