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
//! Kernel Equivalence Tests
//!
//! Validates that SIMD and scalar implementations produce identical results:
//! - SIMD vs scalar equivalence
//! - Random input fuzzing
//! - Edge case coverage

#[cfg(target_arch = "x86_64")]
use ruvector_cnn::int8::kernels::simd::{conv2d_int8_simd, matmul_int8_simd};

use ruvector_cnn::int8::kernels::scalar::{conv2d_int8_scalar, matmul_int8_scalar};
use ruvector_cnn::int8::QuantParams;

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

    /// Compare two i32 vectors for equality with tolerance
    fn assert_vectors_equal(a: &[i32], b: &[i32], tolerance: i32, context: &str) {
        assert_eq!(
            a.len(),
            b.len(),
            "{}: Vector lengths differ: {} vs {}",
            context,
            a.len(),
            b.len()
        );

        for (i, (&va, &vb)) in a.iter().zip(b.iter()).enumerate() {
            let diff = (va - vb).abs();
            assert!(
                diff <= tolerance,
                "{}: Element {} differs by {}: {} vs {}",
                context, i, diff, va, vb
            );
        }
    }

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_matmul_simd_vs_scalar() {
        if !is_x86_feature_detected!("avx2") {
            println!("Skipping SIMD test: AVX2 not available");
            return;
        }

        println!("\n=== MatMul SIMD vs Scalar Equivalence ===");

        let test_cases = vec![
            ("small_square", 16, 16, 16),
            ("medium_square", 64, 64, 64),
            ("tall_narrow", 128, 32, 64),
            ("wide_short", 32, 128, 64),
            ("large_square", 128, 128, 128),
        ];

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        for (name, m, n, k) in test_cases {
            let mut rng = fastrand::Rng::with_seed(42);

            // Generate random INT8 matrices
            let a: Vec<i8> = (0..m * k).map(|_| rng.i8(..)).collect();
            let b: Vec<i8> = (0..k * n).map(|_| rng.i8(..)).collect();

            // Compute with scalar
            let result_scalar = matmul_int8_scalar(&a, &b, params, m, n, k);

            // Compute with SIMD
            let result_simd = unsafe { matmul_int8_simd(&a, &b, params, m, n, k) };

            // Compare results
            assert_vectors_equal(
                &result_scalar,
                &result_simd,
                0, // Exact match required
                &format!("matmul_{}", name),
            );

            println!("✓ {:<20} {}x{}x{} - SIMD matches scalar", name, m, n, k);
        }
    }

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_conv2d_simd_vs_scalar() {
        if !is_x86_feature_detected!("avx2") {
            println!("Skipping SIMD test: AVX2 not available");
            return;
        }

        println!("\n=== Conv2D SIMD vs Scalar Equivalence ===");

        let test_cases = vec![
            ("small_3x3", 28, 28, 16, 3, 1),
            ("medium_3x3", 56, 56, 32, 3, 1),
            ("large_3x3", 112, 112, 64, 3, 1),
            ("stride_2", 56, 56, 32, 3, 2),
            ("5x5_kernel", 56, 56, 32, 5, 1),
        ];

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        for (name, h, w, c, k, stride) in test_cases {
            let mut rng = fastrand::Rng::with_seed(123);

            // Generate random input and kernel
            let input: Vec<i8> = (0..h * w * c).map(|_| rng.i8(..)).collect();
            let kernel: Vec<i8> = (0..k * k * c).map(|_| rng.i8(..)).collect();

            // Compute with scalar
            let result_scalar = conv2d_int8_scalar(&input, &kernel, params, h, w, c, k, stride);

            // Compute with SIMD
            let result_simd =
                unsafe { conv2d_int8_simd(&input, &kernel, params, h, w, c, k, stride) };

            // Compare results
            assert_vectors_equal(
                &result_scalar,
                &result_simd,
                0, // Exact match required
                &format!("conv2d_{}", name),
            );

            println!(
                "✓ {:<20} {}x{}x{} k={} s={} - SIMD matches scalar",
                name, h, w, c, k, stride
            );
        }
    }

    #[test]
    fn test_matmul_scalar_determinism() {
        println!("\n=== MatMul Scalar Determinism ===");

        let m = 64;
        let n = 64;
        let k = 64;

        let mut rng = fastrand::Rng::with_seed(456);
        let a: Vec<i8> = (0..m * k).map(|_| rng.i8(..)).collect();
        let b: Vec<i8> = (0..k * n).map(|_| rng.i8(..)).collect();

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        // Compute multiple times
        let result1 = matmul_int8_scalar(&a, &b, params, m, n, k);
        let result2 = matmul_int8_scalar(&a, &b, params, m, n, k);
        let result3 = matmul_int8_scalar(&a, &b, params, m, n, k);

        // All results should be identical
        assert_eq!(result1, result2, "First and second runs differ");
        assert_eq!(result2, result3, "Second and third runs differ");

        println!("✓ Scalar matmul is deterministic across 3 runs");
    }

    #[test]
    fn test_conv2d_scalar_determinism() {
        println!("\n=== Conv2D Scalar Determinism ===");

        let h = 56;
        let w = 56;
        let c = 32;
        let k = 3;
        let stride = 1;

        let mut rng = fastrand::Rng::with_seed(789);
        let input: Vec<i8> = (0..h * w * c).map(|_| rng.i8(..)).collect();
        let kernel: Vec<i8> = (0..k * k * c).map(|_| rng.i8(..)).collect();

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        // Compute multiple times
        let result1 = conv2d_int8_scalar(&input, &kernel, params, h, w, c, k, stride);
        let result2 = conv2d_int8_scalar(&input, &kernel, params, h, w, c, k, stride);
        let result3 = conv2d_int8_scalar(&input, &kernel, params, h, w, c, k, stride);

        // All results should be identical
        assert_eq!(result1, result2, "First and second runs differ");
        assert_eq!(result2, result3, "Second and third runs differ");

        println!("✓ Scalar conv2d is deterministic across 3 runs");
    }

    #[test]
    fn test_matmul_fuzz_random_inputs() {
        println!("\n=== MatMul Random Input Fuzzing ===");

        let num_tests = 20;
        let mut passed = 0;

        for seed in 0..num_tests {
            let mut rng = fastrand::Rng::with_seed(seed);

            // Random dimensions
            let m = rng.usize(8..128);
            let n = rng.usize(8..128);
            let k = rng.usize(8..128);

            // Random matrices
            let a: Vec<i8> = (0..m * k).map(|_| rng.i8(..)).collect();
            let b: Vec<i8> = (0..k * n).map(|_| rng.i8(..)).collect();

            // Random quantization params
            let scale = rng.f32() * 0.1 + 0.001; // [0.001, 0.101]
            let zero_point = rng.i8(-64..64);

            let params = QuantParams { scale, zero_point };

            // Should not panic
            let result = matmul_int8_scalar(&a, &b, params, m, n, k);

            // Verify output size
            assert_eq!(
                result.len(),
                m * n,
                "Output size mismatch for {}x{}x{}",
                m,
                n,
                k
            );

            passed += 1;
        }

        println!("✓ Passed {}/{} random fuzz tests", passed, num_tests);
    }

    #[test]
    fn test_conv2d_fuzz_random_inputs() {
        println!("\n=== Conv2D Random Input Fuzzing ===");

        let num_tests = 20;
        let mut passed = 0;

        for seed in 0..num_tests {
            let mut rng = fastrand::Rng::with_seed(seed);

            // Random dimensions
            let h = rng.usize(16..64);
            let w = rng.usize(16..64);
            let c = rng.usize(4..32);
            let k = rng.choice([3, 5, 7]).unwrap();
            let stride = rng.choice([1, 2]).unwrap();

            // Skip if output would be too small
            if h < k || w < k {
                continue;
            }

            // Random input and kernel
            let input: Vec<i8> = (0..h * w * c).map(|_| rng.i8(..)).collect();
            let kernel: Vec<i8> = (0..k * k * c).map(|_| rng.i8(..)).collect();

            // Random quantization params
            let scale = rng.f32() * 0.1 + 0.001;
            let zero_point = rng.i8(-64..64);

            let params = QuantParams { scale, zero_point };

            // Should not panic
            let result = conv2d_int8_scalar(&input, &kernel, params, h, w, c, k, stride);

            // Verify output size
            let expected_h = (h - k) / stride + 1;
            let expected_w = (w - k) / stride + 1;
            assert_eq!(
                result.len(),
                expected_h * expected_w,
                "Output size mismatch for {}x{}x{} k={} s={}",
                h,
                w,
                c,
                k,
                stride
            );

            passed += 1;
        }

        println!("✓ Passed {}/{} random fuzz tests", passed, num_tests);
    }

    #[test]
    fn test_matmul_edge_cases() {
        println!("\n=== MatMul Edge Cases ===");

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        // Edge case 1: All zeros
        let a = vec![0i8; 16 * 16];
        let b = vec![0i8; 16 * 16];
        let result = matmul_int8_scalar(&a, &b, params, 16, 16, 16);
        assert!(result.iter().all(|&x| x == 0), "All zeros case failed");
        println!("✓ All zeros");

        // Edge case 2: Identity-like (ones on diagonal)
        let mut a = vec![0i8; 16 * 16];
        for i in 0..16 {
            a[i * 16 + i] = 1;
        }
        let b = vec![1i8; 16 * 16];
        let result = matmul_int8_scalar(&a, &b, params, 16, 16, 16);
        // Each row should sum to 16
        for i in 0..16 {
            let row_sum: i32 = result[i * 16..(i + 1) * 16].iter().sum();
            assert_eq!(row_sum, 16, "Identity-like case failed at row {}", i);
        }
        println!("✓ Identity-like");

        // Edge case 3: Max values
        let a = vec![127i8; 8 * 8];
        let b = vec![127i8; 8 * 8];
        let result = matmul_int8_scalar(&a, &b, params, 8, 8, 8);
        // Should not overflow (using i32 accumulator)
        let max_val = *result.iter().max().unwrap();
        assert!(max_val > 0, "Max values case produced non-positive result");
        println!("✓ Max values (no overflow)");

        // Edge case 4: Min values
        let a = vec![-128i8; 8 * 8];
        let b = vec![-128i8; 8 * 8];
        let result = matmul_int8_scalar(&a, &b, params, 8, 8, 8);
        // Product of negatives should be positive
        let min_val = *result.iter().min().unwrap();
        assert!(min_val > 0, "Min values case produced non-positive result");
        println!("✓ Min values");

        // Edge case 5: Mixed signs
        let a = vec![127i8; 8 * 8];
        let b = vec![-128i8; 8 * 8];
        let result = matmul_int8_scalar(&a, &b, params, 8, 8, 8);
        // Product of opposite signs should be negative
        let max_val = *result.iter().max().unwrap();
        assert!(max_val < 0, "Mixed signs case failed");
        println!("✓ Mixed signs");
    }

    #[test]
    fn test_conv2d_edge_cases() {
        println!("\n=== Conv2D Edge Cases ===");

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        // Edge case 1: All zeros
        let input = vec![0i8; 28 * 28 * 3];
        let kernel = vec![0i8; 3 * 3 * 3];
        let result = conv2d_int8_scalar(&input, &kernel, params, 28, 28, 3, 3, 1);
        assert!(result.iter().all(|&x| x == 0), "All zeros case failed");
        println!("✓ All zeros");

        // Edge case 2: Uniform input and kernel
        let input = vec![1i8; 28 * 28 * 3];
        let kernel = vec![1i8; 3 * 3 * 3];
        let result = conv2d_int8_scalar(&input, &kernel, params, 28, 28, 3, 3, 1);
        // Each output should be 3*3*3 = 27
        assert!(
            result.iter().all(|&x| x == 27),
            "Uniform case failed: expected 27, got {:?}",
            &result[..5]
        );
        println!("✓ Uniform (all ones)");

        // Edge case 3: Sparse input (mostly zeros)
        let mut input = vec![0i8; 28 * 28 * 3];
        input[0] = 1;
        input[100] = 1;
        input[200] = 1;
        let kernel = vec![1i8; 3 * 3 * 3];
        let result = conv2d_int8_scalar(&input, &kernel, params, 28, 28, 3, 3, 1);
        // Most outputs should be 0 or small
        let non_zero_count = result.iter().filter(|&&x| x != 0).count();
        assert!(
            non_zero_count < result.len() / 2,
            "Sparse case failed: too many non-zeros"
        );
        println!("✓ Sparse input");

        // Edge case 4: Large stride
        let input = vec![1i8; 56 * 56 * 16];
        let kernel = vec![1i8; 3 * 3 * 16];
        let result = conv2d_int8_scalar(&input, &kernel, params, 56, 56, 16, 3, 2);
        let expected_size = ((56 - 3) / 2 + 1) * ((56 - 3) / 2 + 1);
        assert_eq!(
            result.len(),
            expected_size,
            "Large stride output size mismatch"
        );
        println!("✓ Large stride (s=2)");

        // Edge case 5: Minimal size
        let input = vec![1i8; 3 * 3 * 1];
        let kernel = vec![1i8; 3 * 3 * 1];
        let result = conv2d_int8_scalar(&input, &kernel, params, 3, 3, 1, 3, 1);
        assert_eq!(result.len(), 1, "Minimal size case failed");
        assert_eq!(result[0], 9, "Minimal size value mismatch");
        println!("✓ Minimal size (3x3 -> 1x1)");
    }

    #[test]
    fn test_matmul_boundary_dimensions() {
        println!("\n=== MatMul Boundary Dimensions ===");

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        // Very tall and narrow
        let a = vec![1i8; 256 * 4];
        let b = vec![1i8; 4 * 8];
        let result = matmul_int8_scalar(&a, &b, params, 256, 8, 4);
        assert_eq!(result.len(), 256 * 8, "Tall-narrow dimension mismatch");
        println!("✓ Tall-narrow (256x4 × 4x8)");

        // Very wide and short
        let a = vec![1i8; 4 * 256];
        let b = vec![1i8; 256 * 8];
        let result = matmul_int8_scalar(&a, &b, params, 4, 8, 256);
        assert_eq!(result.len(), 4 * 8, "Wide-short dimension mismatch");
        println!("✓ Wide-short (4x256 × 256x8)");

        // Vector-vector (outer product)
        let a = vec![1i8; 16 * 1];
        let b = vec![1i8; 1 * 16];
        let result = matmul_int8_scalar(&a, &b, params, 16, 16, 1);
        assert_eq!(result.len(), 16 * 16, "Vector-vector dimension mismatch");
        println!("✓ Vector-vector outer product (16x1 × 1x16)");
    }

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_simd_alignment_independence() {
        if !is_x86_feature_detected!("avx2") {
            println!("Skipping SIMD alignment test: AVX2 not available");
            return;
        }

        println!("\n=== SIMD Alignment Independence ===");

        let params = QuantParams {
            scale: 0.01,
            zero_point: 0,
        };

        // Test matmul with various sizes (aligned and unaligned)
        let sizes = vec![
            (15, 15, 15), // Unaligned
            (16, 16, 16), // Aligned to 16
            (17, 17, 17), // Unaligned
            (31, 31, 31), // Unaligned
            (32, 32, 32), // Aligned to 32
            (33, 33, 33), // Unaligned
        ];

        for (m, n, k) in sizes {
            let mut rng = fastrand::Rng::with_seed(42 + m);
            let a: Vec<i8> = (0..m * k).map(|_| rng.i8(..)).collect();
            let b: Vec<i8> = (0..k * n).map(|_| rng.i8(..)).collect();

            let result_scalar = matmul_int8_scalar(&a, &b, params, m, n, k);
            let result_simd = unsafe { matmul_int8_simd(&a, &b, params, m, n, k) };

            assert_vectors_equal(
                &result_scalar,
                &result_simd,
                0,
                &format!("alignment_{}x{}x{}", m, n, k),
            );

            println!("{}x{}x{} - SIMD matches scalar", m, n, k);
        }
    }
}