ruvector-cnn 2.0.6

CNN feature extraction for image embeddings with SIMD acceleration
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
//! Integration tests for ruvector-cnn
//!
//! Tests cover:
//! - End-to-end: image -> embedding
//! - CnnEmbedder usage
//! - Multiple embedder configurations
//! - Error handling

use ruvector_cnn::{CnnEmbedder, EmbeddingConfig, EmbeddingExtractor};

// ============================================================================
// CnnEmbedder Basic Tests
// ============================================================================

#[test]
fn test_cnn_embedder_creation() {
    let embedder = CnnEmbedder::new(EmbeddingConfig::default())
        .expect("Failed to create embedder");

    assert_eq!(embedder.embedding_dim(), 512);
    assert_eq!(embedder.input_size(), 224);
}

#[test]
fn test_cnn_embedder_v3_small() {
    let embedder = CnnEmbedder::new_v3_small()
        .expect("Failed to create V3 Small embedder");

    assert_eq!(embedder.embedding_dim(), 576);
}

#[test]
fn test_cnn_embedder_v3_large() {
    let embedder = CnnEmbedder::new_v3_large()
        .expect("Failed to create V3 Large embedder");

    assert_eq!(embedder.embedding_dim(), 960);
}

#[test]
fn test_embedding_config_default() {
    let config = EmbeddingConfig::default();

    assert_eq!(config.input_size, 224);
    assert_eq!(config.embedding_dim, 512);
    assert!(config.normalize);
    assert!(!config.quantized);
}

// ============================================================================
// End-to-End Embedding Extraction Tests
// ============================================================================

#[test]
fn test_image_to_embedding_pipeline() {
    let config = EmbeddingConfig {
        input_size: 64,
        embedding_dim: 128,
        normalize: true,
        quantized: false,
    };

    let embedder = CnnEmbedder::new(config).expect("Failed to create embedder");

    // Create a test image (RGBA format, 64x64)
    let image: Vec<u8> = (0..(64 * 64 * 4))
        .map(|i| (i % 256) as u8)
        .collect();

    let embedding = embedder.extract(&image, 64, 64).expect("Extraction failed");

    // Verify embedding properties
    assert_eq!(embedding.len(), 128, "Embedding dimension mismatch");

    // Verify no NaN or Inf
    assert!(embedding.iter().all(|x| x.is_finite()), "Embedding contains non-finite values");
}

#[test]
fn test_image_to_embedding_normalized() {
    let config = EmbeddingConfig {
        input_size: 32,
        embedding_dim: 64,
        normalize: true,
        quantized: false,
    };

    let embedder = CnnEmbedder::new(config).expect("Failed to create embedder");

    let image: Vec<u8> = vec![128; 32 * 32 * 4];
    let embedding = embedder.extract(&image, 32, 32).expect("Extraction failed");

    // Verify normalized (L2 norm = 1 or very small if all zeros)
    let norm: f32 = embedding.iter().map(|x| x * x).sum::<f32>().sqrt();
    assert!(
        (norm - 1.0).abs() < 1e-4 || norm < 1e-10,
        "Expected normalized embedding, got norm={}",
        norm
    );
}

#[test]
fn test_different_image_sizes() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 64,
        embedding_dim: 32,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Test with 64x64 image
    let image_64 = vec![128u8; 64 * 64 * 4];
    let emb = embedder.extract(&image_64, 64, 64).expect("Failed");
    assert_eq!(emb.len(), 32);
}

#[test]
fn test_grayscale_vs_color_images() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 32,
        embedding_dim: 16,
        normalize: false,
        quantized: false,
    }).expect("Failed to create embedder");

    // Uniform gray image (all pixels same value)
    let gray_image: Vec<u8> = vec![128; 32 * 32 * 4];

    // Colorful image (varying pixels)
    let color_image: Vec<u8> = (0..(32 * 32 * 4))
        .map(|i| ((i * 37) % 256) as u8)
        .collect();

    let emb_gray = embedder.extract(&gray_image, 32, 32).expect("Failed");
    let emb_color = embedder.extract(&color_image, 32, 32).expect("Failed");

    // Both should produce valid embeddings
    assert_eq!(emb_gray.len(), 16);
    assert_eq!(emb_color.len(), 16);

    // They should be different
    let diff_count = emb_gray.iter().zip(emb_color.iter())
        .filter(|(a, b)| (*a - *b).abs() > 1e-10)
        .count();

    assert!(diff_count > 0, "Different images should produce different embeddings");
}

// ============================================================================
// Embedding Similarity Tests
// ============================================================================

#[test]
fn test_similar_images_similar_embeddings() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 32,
        embedding_dim: 32,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Two similar images (same content, slight variation)
    let image1: Vec<u8> = vec![128; 32 * 32 * 4];
    let image2: Vec<u8> = vec![130; 32 * 32 * 4]; // Slightly brighter

    // Very different image
    let image3: Vec<u8> = (0..(32 * 32 * 4))
        .map(|i| ((i * 37) % 256) as u8)
        .collect();

    let emb1 = embedder.extract(&image1, 32, 32).expect("Failed");
    let emb2 = embedder.extract(&image2, 32, 32).expect("Failed");
    let emb3 = embedder.extract(&image3, 32, 32).expect("Failed");

    // Compute cosine similarities (embeddings are normalized)
    let sim_12: f32 = emb1.iter().zip(emb2.iter()).map(|(a, b)| a * b).sum();
    let sim_13: f32 = emb1.iter().zip(emb3.iter()).map(|(a, b)| a * b).sum();

    // Similar images should have higher similarity
    // Note: With random weights, this may not always hold, but the test structure is correct
    assert!(sim_12.is_finite());
    assert!(sim_13.is_finite());
}

// ============================================================================
// EmbeddingExtractor Trait Tests
// ============================================================================

#[test]
fn test_embedding_extractor_trait() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 32,
        embedding_dim: 64,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Use trait methods
    assert_eq!(embedder.embedding_dim(), 64);

    let image = vec![128u8; 32 * 32 * 4];
    let embedding = EmbeddingExtractor::extract(&embedder, &image, 32, 32)
        .expect("Trait extraction failed");

    assert_eq!(embedding.len(), 64);
}

// ============================================================================
// Error Handling Tests
// ============================================================================

#[test]
fn test_invalid_image_dimensions() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 64,
        embedding_dim: 32,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Image data doesn't match dimensions (too small)
    let image: Vec<u8> = vec![128; 100];

    let result = embedder.extract(&image, 64, 64);

    assert!(result.is_err(), "Should fail with mismatched dimensions");
}

#[test]
fn test_zero_dimension_image() {
    use std::panic;

    let embedder = CnnEmbedder::new(EmbeddingConfig::default())
        .expect("Failed to create embedder");

    let image: Vec<u8> = vec![];

    // Zero dimension should either return an error or panic
    // (currently panics due to index bounds check in SIMD code)
    let result = panic::catch_unwind(panic::AssertUnwindSafe(|| {
        embedder.extract(&image, 0, 0)
    }));

    // Either panicked or returned an error is acceptable for invalid input
    let failed = result.is_err() || result.map(|r| r.is_err()).unwrap_or(false);
    assert!(failed, "Should fail with zero dimensions (either panic or error)");
}

// ============================================================================
// Determinism Tests
// ============================================================================

#[test]
fn test_extraction_deterministic() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 32,
        embedding_dim: 16,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    let image = vec![128u8; 32 * 32 * 4];

    let emb1 = embedder.extract(&image, 32, 32).expect("Failed");
    let emb2 = embedder.extract(&image, 32, 32).expect("Failed");

    // Same image should produce same embedding
    for (v1, v2) in emb1.iter().zip(emb2.iter()) {
        assert_eq!(v1, v2, "Extraction should be deterministic");
    }
}

// ============================================================================
// Concurrency Tests
// ============================================================================

#[test]
fn test_concurrent_extraction() {
    use std::sync::Arc;
    use std::thread;

    let embedder = Arc::new(
        CnnEmbedder::new(EmbeddingConfig {
            input_size: 32,
            embedding_dim: 16,
            normalize: true,
            quantized: false,
        }).expect("Failed to create embedder")
    );

    let handles: Vec<_> = (0..4)
        .map(|i| {
            let embedder = Arc::clone(&embedder);
            thread::spawn(move || {
                let image: Vec<u8> = vec![(i * 50) as u8; 32 * 32 * 4];
                embedder.extract(&image, 32, 32)
            })
        })
        .collect();

    let results: Vec<_> = handles.into_iter()
        .map(|h| h.join().expect("Thread panicked"))
        .collect();

    // All extractions should succeed
    for result in results {
        assert!(result.is_ok());
        let embedding = result.unwrap();
        assert_eq!(embedding.len(), 16);
    }
}

// ============================================================================
// Memory Tests
// ============================================================================

#[test]
fn test_multiple_extractions_no_leak() {
    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 32,
        embedding_dim: 16,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Process many images to check for memory leaks
    for i in 0..100 {
        let image: Vec<u8> = vec![(i % 256) as u8; 32 * 32 * 4];
        let _embedding = embedder.extract(&image, 32, 32).expect("Failed");
    }

    // If we get here without OOM, memory is being managed correctly
    assert!(true);
}

// ============================================================================
// Contrastive Learning Integration
// ============================================================================

#[test]
fn test_embedder_with_infonce() {
    use ruvector_cnn::contrastive::InfoNCELoss;

    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 16,
        embedding_dim: 8,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Create augmented pairs (simulate SimCLR)
    let images: Vec<Vec<u8>> = (0..4)
        .map(|i| vec![(i * 50) as u8; 16 * 16 * 4])
        .collect();

    // Extract embeddings (convert f32 to f64 for InfoNCE)
    let embeddings: Vec<Vec<f64>> = images.iter()
        .map(|img| {
            let emb = embedder.extract(img, 16, 16).expect("Failed");
            emb.into_iter().map(|x| x as f64).collect()
        })
        .collect();

    // Compute contrastive loss
    let loss_fn = InfoNCELoss::new(0.07);
    let loss = loss_fn.forward(&embeddings, 2);

    assert!(loss > 0.0, "Loss should be positive");
    assert!(loss.is_finite(), "Loss should be finite");
}

#[test]
fn test_embedder_with_triplet() {
    use ruvector_cnn::contrastive::TripletLoss;

    let embedder = CnnEmbedder::new(EmbeddingConfig {
        input_size: 16,
        embedding_dim: 8,
        normalize: true,
        quantized: false,
    }).expect("Failed to create embedder");

    // Create anchor, positive, negative images
    let anchor_img = vec![128u8; 16 * 16 * 4];
    let positive_img = vec![130u8; 16 * 16 * 4];  // Similar to anchor
    let negative_img: Vec<u8> = (0..(16 * 16 * 4))
        .map(|i| ((i * 37) % 256) as u8)
        .collect();

    // Extract embeddings (convert f32 to f64 for TripletLoss)
    let anchor: Vec<f64> = embedder.extract(&anchor_img, 16, 16)
        .expect("Failed").into_iter().map(|x| x as f64).collect();
    let positive: Vec<f64> = embedder.extract(&positive_img, 16, 16)
        .expect("Failed").into_iter().map(|x| x as f64).collect();
    let negative: Vec<f64> = embedder.extract(&negative_img, 16, 16)
        .expect("Failed").into_iter().map(|x| x as f64).collect();

    // Compute triplet loss
    let loss_fn = TripletLoss::new(0.5);
    let loss = loss_fn.forward(&anchor, &positive, &negative);

    assert!(loss >= 0.0, "Loss should be non-negative");
    assert!(loss.is_finite(), "Loss should be finite");
}

// ============================================================================
// SIMD Integration Tests
// ============================================================================

#[test]
fn test_simd_functions_available() {
    use ruvector_cnn::simd;

    // Test that SIMD functions are available and work
    let a = vec![1.0f32, 2.0, 3.0, 4.0];
    let b = vec![4.0f32, 3.0, 2.0, 1.0];

    let dot = simd::dot_product_simd(&a, &b);

    // 1*4 + 2*3 + 3*2 + 4*1 = 4 + 6 + 6 + 4 = 20
    assert!((dot - 20.0).abs() < 1e-5, "Expected dot product to be 20.0, got {}", dot);
}

#[test]
fn test_simd_relu() {
    use ruvector_cnn::simd;

    let input = vec![-1.0f32, 0.0, 1.0, 2.0, -0.5, 0.5];
    let mut output = vec![0.0f32; input.len()];

    simd::relu_simd(&input, &mut output);

    assert_eq!(output, vec![0.0, 0.0, 1.0, 2.0, 0.0, 0.5]);
}

#[test]
fn test_simd_relu6() {
    use ruvector_cnn::simd;

    let input = vec![-1.0f32, 0.0, 1.0, 5.0, 7.0, 10.0];
    let mut output = vec![0.0f32; input.len()];

    simd::relu6_simd(&input, &mut output);

    // relu6 clamps to [0, 6]
    assert_eq!(output, vec![0.0, 0.0, 1.0, 5.0, 6.0, 6.0]);
}

// ============================================================================
// Layer Integration Tests
// ============================================================================

#[test]
fn test_layers_module_available() {
    use ruvector_cnn::layers::{conv2d_3x3, batch_norm, relu, relu6, hard_swish, global_avg_pool};

    // Test standalone layer functions
    let input = vec![0.5f32; 3 * 8 * 8]; // 3 channels, 8x8
    let weights = vec![0.1f32; 3 * 3 * 3 * 16]; // 3x3 kernel, 3->16 channels

    let conv_out = conv2d_3x3(&input, &weights, 3, 16, 8, 8);
    assert!(!conv_out.is_empty());

    // Test batch norm
    let bn_out = batch_norm(
        &conv_out,
        &vec![1.0f32; 16], // gamma
        &vec![0.0f32; 16], // beta
        &vec![0.0f32; 16], // mean
        &vec![1.0f32; 16], // var
        1e-5,
    );
    assert_eq!(bn_out.len(), conv_out.len());

    // Test activations
    let relu_out = relu(&bn_out);
    assert_eq!(relu_out.len(), bn_out.len());

    let relu6_out = relu6(&bn_out);
    assert_eq!(relu6_out.len(), bn_out.len());

    let hardswish_out = hard_swish(&bn_out);
    assert_eq!(hardswish_out.len(), bn_out.len());

    // Test global avg pool
    let pooled = global_avg_pool(&relu_out, 16);
    assert_eq!(pooled.len(), 16);
}

// ============================================================================
// Tensor Tests
// ============================================================================

#[test]
fn test_tensor_creation() {
    use ruvector_cnn::Tensor;

    let tensor = Tensor::zeros(&[2, 3, 4, 5]);

    assert_eq!(tensor.shape(), &[2, 3, 4, 5]);
    assert_eq!(tensor.numel(), 2 * 3 * 4 * 5);
    assert!(tensor.data().iter().all(|&x| x == 0.0));
}

#[test]
fn test_tensor_ones() {
    use ruvector_cnn::Tensor;

    let tensor = Tensor::ones(&[4, 4, 4, 4]);

    assert_eq!(tensor.numel(), 256);
    assert!(tensor.data().iter().all(|&x| x == 1.0));
}

#[test]
fn test_tensor_from_data() {
    use ruvector_cnn::Tensor;

    let data = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0];
    let tensor = Tensor::from_data(data.clone(), &[2, 3]).expect("Failed to create tensor");

    assert_eq!(tensor.shape(), &[2, 3]);
    assert_eq!(tensor.data(), &data);
}

#[test]
fn test_tensor_from_data_mismatch() {
    use ruvector_cnn::Tensor;

    let data = vec![1.0, 2.0, 3.0, 4.0];
    let result = Tensor::from_data(data, &[2, 3]); // 4 elements, but shape wants 6

    assert!(result.is_err());
}