realizar 0.8.4

Pure Rust ML inference engine built from scratch - model serving for GGUF and safetensors
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

// =============================================================================
// Tests
// =============================================================================

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

    #[test]
    fn test_gelu_zero() {
        let mut input = vec![0.0];
        gelu(&mut input);
        assert!((input[0] - 0.0).abs() < 1e-6);
    }

    #[test]
    fn test_gelu_positive() {
        let mut input = vec![1.0];
        gelu(&mut input);
        // GELU(1) ≈ 0.8413
        assert!((input[0] - 0.8413).abs() < 0.01);
    }

    #[test]
    fn test_silu_zero() {
        let mut input = vec![0.0];
        silu(&mut input);
        assert!((input[0] - 0.0).abs() < 1e-6);
    }

    #[test]
    fn test_silu_positive() {
        let mut input = vec![1.0];
        silu(&mut input);
        // SiLU(1) = 1 * sigmoid(1) ≈ 0.7311
        assert!((input[0] - 0.7311).abs() < 0.01);
    }

    #[test]
    fn test_argmax() {
        let logits = vec![0.1, 0.5, 0.3, 0.9, 0.2];
        assert_eq!(argmax(&logits), 3);
    }

    #[test]
    fn test_argmax_negative() {
        let logits = vec![-1.0, -0.5, -2.0];
        assert_eq!(argmax(&logits), 1);
    }

    #[test]
    fn test_softmax_uniform() {
        let mut logits = vec![0.0, 0.0, 0.0];
        softmax(&mut logits);
        for &p in &logits {
            assert!((p - 1.0 / 3.0).abs() < 1e-6);
        }
    }

    #[test]
    fn test_softmax_sums_to_one() {
        let mut logits = vec![1.0, 2.0, 3.0];
        softmax(&mut logits);
        let sum: f32 = logits.iter().sum();
        assert!((sum - 1.0).abs() < 1e-6);
    }

    #[test]
    fn test_add_bias() {
        let mut output = vec![1.0, 2.0, 3.0, 4.0];
        let bias = vec![0.1, 0.2];
        add_bias(&mut output, &bias);
        assert!((output[0] - 1.1).abs() < 1e-6);
        assert!((output[1] - 2.2).abs() < 1e-6);
        assert!((output[2] - 3.1).abs() < 1e-6);
        assert!((output[3] - 4.2).abs() < 1e-6);
    }

    #[test]
    fn test_rms_norm_unit_weight() {
        let input = vec![1.0, 2.0, 3.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let output = rms_norm(&input, &weight, 1e-5);

        // Check output is normalized
        let sum_sq: f32 = output.iter().map(|x| x * x).sum();
        let rms = (sum_sq / 4.0).sqrt();
        assert!((rms - 1.0).abs() < 0.1); // Approximately unit RMS
    }

    #[test]
    fn test_layer_norm_no_bias() {
        let input = vec![1.0, 2.0, 3.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let output = layer_norm(&input, &weight, None, 1e-5);
        assert_eq!(output.len(), 4);
    }

    #[test]
    fn test_layer_norm_with_bias() {
        let input = vec![1.0, 2.0];
        let weight = vec![1.0, 1.0];
        let bias = vec![0.5, 0.5];
        let output = layer_norm(&input, &weight, Some(&bias), 1e-5);
        assert_eq!(output.len(), 2);
        // GH-278: True LayerNorm subtracts mean (1.5), so normalized = [-1.0, 1.0]
        // After bias: [-0.5, 1.5]
        assert!((output[0] - (-0.5)).abs() < 0.01, "output[0]={}", output[0]);
        assert!((output[1] - 1.5).abs() < 0.01, "output[1]={}", output[1]);
    }

    // =========================================================================
    // Additional tests for rms_norm_into (zero-allocation path)
    // =========================================================================

    #[test]
    fn test_rms_norm_into_unit_weight() {
        let input = vec![1.0, 2.0, 3.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let mut output = vec![0.0; 4];
        rms_norm_into(&input, &weight, 1e-5, &mut output);

        // Check output is normalized
        let sum_sq: f32 = output.iter().map(|x| x * x).sum();
        let rms = (sum_sq / 4.0).sqrt();
        assert!((rms - 1.0).abs() < 0.1);
    }

    #[test]
    fn test_rms_norm_into_zeros() {
        let input = vec![0.0, 0.0, 0.0, 0.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let mut output = vec![999.0; 4];
        rms_norm_into(&input, &weight, 1e-5, &mut output);

        // Output should be near zero (only eps prevents division by zero)
        for &val in &output {
            assert!(val.abs() < 1e-3);
        }
    }

    #[test]
    fn test_rms_norm_into_with_weight_scaling() {
        let input = vec![1.0, 1.0, 1.0, 1.0];
        let weight = vec![2.0, 0.5, 1.0, 3.0];
        let mut output = vec![0.0; 4];
        rms_norm_into(&input, &weight, 1e-5, &mut output);

        // Each output should be scaled by weight
        // Input RMS = 1.0, so output ≈ weight
        assert!((output[0] - 2.0).abs() < 0.1);
        assert!((output[1] - 0.5).abs() < 0.1);
        assert!((output[2] - 1.0).abs() < 0.1);
        assert!((output[3] - 3.0).abs() < 0.1);
    }

    #[test]
    fn test_rms_norm_into_negative_values() {
        let input = vec![-1.0, -2.0, 3.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let mut output = vec![0.0; 4];
        rms_norm_into(&input, &weight, 1e-5, &mut output);

        // Signs should be preserved
        assert!(output[0] < 0.0);
        assert!(output[1] < 0.0);
        assert!(output[2] > 0.0);
        assert!(output[3] > 0.0);
    }

    // =========================================================================
    // Additional tests for layer_norm_into (zero-allocation path)
    // =========================================================================

    #[test]
    fn test_layer_norm_into_no_bias() {
        let input = vec![1.0, 2.0, 3.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let mut output = vec![0.0; 4];
        layer_norm_into(&input, &weight, None, 1e-5, &mut output);

        assert_eq!(output.len(), 4);
        // Should be normalized
        for &val in &output {
            assert!(val.is_finite());
        }
    }

    #[test]
    fn test_layer_norm_into_with_bias() {
        let input = vec![1.0, 2.0];
        let weight = vec![1.0, 1.0];
        let bias = vec![10.0, 20.0];
        let mut output = vec![0.0; 2];
        layer_norm_into(&input, &weight, Some(&bias), 1e-5, &mut output);

        // Bias should be added
        assert!(output[0] > 9.0);
        assert!(output[1] > 19.0);
    }

    #[test]
    fn test_layer_norm_into_zeros() {
        let input = vec![0.0, 0.0, 0.0, 0.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let mut output = vec![999.0; 4];
        layer_norm_into(&input, &weight, None, 1e-5, &mut output);

        // Should handle zeros gracefully
        for &val in &output {
            assert!(val.is_finite());
            assert!(val.abs() < 1e-2);
        }
    }

    // =========================================================================
    // Additional tests for gelu activation
    // =========================================================================

    #[test]
    fn test_gelu_negative() {
        let mut input = vec![-1.0];
        gelu(&mut input);
        // GELU(-1) ≈ -0.1587
        assert!((input[0] - (-0.1587)).abs() < 0.01);
    }

    #[test]
    fn test_gelu_large_positive() {
        let mut input = vec![10.0];
        gelu(&mut input);
        // GELU(x) → x for large positive x
        assert!((input[0] - 10.0).abs() < 0.01);
    }

    #[test]
    fn test_gelu_large_negative() {
        let mut input = vec![-10.0];
        gelu(&mut input);
        // GELU(x) → 0 for large negative x
        assert!(input[0].abs() < 0.01);
    }

    #[test]
    fn test_gelu_batch() {
        let mut input = vec![0.0, 1.0, -1.0, 2.0];
        gelu(&mut input);
        assert!((input[0] - 0.0).abs() < 0.01);
        assert!((input[1] - 0.8413).abs() < 0.01);
        assert!((input[2] - (-0.1587)).abs() < 0.01);
        assert!(input[3] > 1.9); // GELU(2) ≈ 1.96
    }

    // =========================================================================
    // Additional tests for silu activation
    // =========================================================================

    #[test]
    fn test_silu_negative() {
        let mut input = vec![-1.0];
        silu(&mut input);
        // SiLU(-1) = -1 * sigmoid(-1) ≈ -0.2689
        assert!((input[0] - (-0.2689)).abs() < 0.01);
    }

    #[test]
    fn test_silu_large_positive() {
        let mut input = vec![10.0];
        silu(&mut input);
        // SiLU(x) → x for large positive x (sigmoid → 1)
        assert!((input[0] - 10.0).abs() < 0.01);
    }

    #[test]
    fn test_silu_large_negative() {
        let mut input = vec![-10.0];
        silu(&mut input);
        // SiLU(x) → 0 for large negative x (sigmoid → 0)
        assert!(input[0].abs() < 0.001);
    }

    #[test]
    fn test_silu_batch() {
        let mut input = vec![0.0, 1.0, -1.0, 2.0];
        silu(&mut input);
        assert!((input[0] - 0.0).abs() < 0.01);
        assert!((input[1] - 0.7311).abs() < 0.01);
        assert!((input[2] - (-0.2689)).abs() < 0.01);
        assert!(input[3] > 1.7); // SiLU(2) ≈ 1.76
    }

    // =========================================================================
    // Additional tests for argmax
    // =========================================================================

    #[test]
    fn test_argmax_single_element() {
        let logits = vec![42.0];
        assert_eq!(argmax(&logits), 0);
    }

    #[test]
    fn test_argmax_all_same() {
        let logits = vec![1.0, 1.0, 1.0, 1.0];
        // First occurrence wins
        assert_eq!(argmax(&logits), 0);
    }

    #[test]
    fn test_argmax_infinity() {
        let logits = vec![1.0, f32::INFINITY, 3.0];
        assert_eq!(argmax(&logits), 1);
    }

    #[test]
    fn test_argmax_with_nan() {
        // NaN should not be selected as max
        let logits = vec![f32::NAN, 1.0, 2.0];
        // NaN comparisons are false, so 2.0 at index 2 should win
        assert_eq!(argmax(&logits), 2);
    }

    // =========================================================================
    // Additional tests for softmax
    // =========================================================================

    #[test]
    fn test_softmax_single_element() {
        let mut logits = vec![5.0];
        softmax(&mut logits);
        assert!((logits[0] - 1.0).abs() < 1e-6);
    }

    #[test]
    fn test_softmax_large_values() {
        // Should not overflow due to numerical stability (subtract max)
        let mut logits = vec![1000.0, 1001.0, 1002.0];
        softmax(&mut logits);
        let sum: f32 = logits.iter().sum();
        assert!((sum - 1.0).abs() < 1e-6);
        // Largest should have highest probability
        assert!(logits[2] > logits[1]);
        assert!(logits[1] > logits[0]);
    }

    #[test]
    fn test_softmax_negative_values() {
        let mut logits = vec![-1.0, -2.0, -3.0];
        softmax(&mut logits);
        let sum: f32 = logits.iter().sum();
        assert!((sum - 1.0).abs() < 1e-6);
        // Least negative should have highest probability
        assert!(logits[0] > logits[1]);
        assert!(logits[1] > logits[2]);
    }

    #[test]
    fn test_softmax_dominance() {
        // One very large value should dominate
        let mut logits = vec![0.0, 0.0, 100.0];
        softmax(&mut logits);
        assert!(logits[2] > 0.99);
        assert!(logits[0] < 0.01);
        assert!(logits[1] < 0.01);
    }

    // =========================================================================
    // Additional tests for add_bias
    // =========================================================================

    #[test]
    fn test_add_bias_single_element() {
        let mut output = vec![1.0];
        let bias = vec![0.5];
        add_bias(&mut output, &bias);
        assert!((output[0] - 1.5).abs() < 1e-6);
    }

    #[test]
    fn test_add_bias_multiple_sequences() {
        let mut output = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]; // 3 sequences of dim 2
        let bias = vec![0.1, 0.2];
        add_bias(&mut output, &bias);
        assert!((output[0] - 1.1).abs() < 1e-6);
        assert!((output[1] - 2.2).abs() < 1e-6);
        assert!((output[2] - 3.1).abs() < 1e-6);
        assert!((output[3] - 4.2).abs() < 1e-6);
        assert!((output[4] - 5.1).abs() < 1e-6);
        assert!((output[5] - 6.2).abs() < 1e-6);
    }

    #[test]
    fn test_add_bias_negative() {
        let mut output = vec![1.0, 2.0];
        let bias = vec![-0.5, -1.0];
        add_bias(&mut output, &bias);
        assert!((output[0] - 0.5).abs() < 1e-6);
        assert!((output[1] - 1.0).abs() < 1e-6);
    }

    // =========================================================================
    // Additional tests for rms_norm
    // =========================================================================

    #[test]
    fn test_rms_norm_multiple_sequences() {
        let input = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0]; // 2 sequences of dim 4
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let output = rms_norm(&input, &weight, 1e-5);

        assert_eq!(output.len(), 8);
        // Each sequence should be independently normalized
        let seq1_sum_sq: f32 = output[0..4].iter().map(|x| x * x).sum();
        let seq2_sum_sq: f32 = output[4..8].iter().map(|x| x * x).sum();
        let rms1 = (seq1_sum_sq / 4.0).sqrt();
        let rms2 = (seq2_sum_sq / 4.0).sqrt();
        assert!((rms1 - 1.0).abs() < 0.1);
        assert!((rms2 - 1.0).abs() < 0.1);
    }

    #[test]
    fn test_rms_norm_zeros() {
        let input = vec![0.0, 0.0, 0.0, 0.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let output = rms_norm(&input, &weight, 1e-5);

        // Output should be near zero
        for &val in &output {
            assert!(val.abs() < 1e-3);
        }
    }

    #[test]
    fn test_rms_norm_preserves_sign() {
        let input = vec![-3.0, 2.0, -1.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let output = rms_norm(&input, &weight, 1e-5);

        assert!(output[0] < 0.0);
        assert!(output[1] > 0.0);
        assert!(output[2] < 0.0);
        assert!(output[3] > 0.0);
    }

    // =========================================================================
    // Additional tests for layer_norm
    // =========================================================================

    #[test]
    fn test_layer_norm_multiple_sequences() {
        let input = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]; // 2 sequences of dim 3
        let weight = vec![1.0, 1.0, 1.0];
        let output = layer_norm(&input, &weight, None, 1e-5);

        assert_eq!(output.len(), 6);
        // Each sequence should be independently normalized
        for &val in &output {
            assert!(val.is_finite());
        }
    }

    #[test]
    fn test_layer_norm_preserves_sign() {
        let input = vec![-3.0, 2.0, -1.0, 4.0];
        let weight = vec![1.0, 1.0, 1.0, 1.0];
        let output = layer_norm(&input, &weight, None, 1e-5);

        assert!(output[0] < 0.0);
        assert!(output[1] > 0.0);
        assert!(output[2] < 0.0);
        assert!(output[3] > 0.0);
    }

    #[test]
    fn test_layer_norm_weight_scaling() {
        // GH-278: True LayerNorm - verify weight scaling of normalized values
        // Use unit weight first, then scaled weight, check ratio
        let input = vec![1.0, 3.0, 2.0, 4.0];
        let unit_weight = vec![1.0, 1.0, 1.0, 1.0];
        let scaled_weight = vec![2.0, 0.5, 1.0, 3.0];
        let unit_out = layer_norm(&input, &unit_weight, None, 1e-5);
        let scaled_out = layer_norm(&input, &scaled_weight, None, 1e-5);

        // scaled_out[i] should equal unit_out[i] * scaled_weight[i]
        for i in 0..4 {
            let expected = unit_out[i] * scaled_weight[i];
            assert!(
                (scaled_out[i] - expected).abs() < 1e-5,
                "index {}: expected {}, got {}", i, expected, scaled_out[i]
            );
        }
    }
}