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

//! Part 05: Inference configuration, model execution paths, and error handling
//!
//! Coverage for src/inference/mod.rs including:
//! - Q4KWeight construction and validation
//! - Q4KWeight matvec execution paths
//! - Error propagation and recovery
//! - Memory statistics and compression ratios

use crate::error::RealizarError;
use crate::inference::Q4KWeight;

// ============================================================================
// Q4KWeight Construction Tests
// ============================================================================

#[test]
fn test_q4k_weight_new_minimal_valid() {
    let in_dim = 256;
    let out_dim = 1;
    let bytes_per_row = 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim);
    assert!(weight.is_ok());

    let w = weight.expect("w");
    assert_eq!(w.in_dim, 256);
    assert_eq!(w.out_dim, 1);
}

#[test]
fn test_q4k_weight_new_multiple_rows() {
    let in_dim = 256;
    let out_dim = 8;
    let bytes_per_row = 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim);
    assert!(weight.is_ok());

    let w = weight.expect("w");
    assert_eq!(w.out_dim, 8);
    assert_eq!(w.data.len(), 8 * 144);
}

#[test]
fn test_q4k_weight_new_multiple_blocks_per_row() {
    let in_dim: usize = 512;
    let out_dim: usize = 2;
    let blocks_per_row = in_dim.div_ceil(256);
    let bytes_per_row = blocks_per_row * 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim);
    assert!(weight.is_ok());

    let w = weight.expect("w");
    assert_eq!(w.in_dim, 512);
    assert_eq!(w.memory_bytes(), 2 * 288);
}

#[test]
fn test_q4k_weight_new_non_multiple_of_256() {
    let in_dim: usize = 300;
    let out_dim: usize = 1;
    let blocks_per_row = in_dim.div_ceil(256);
    let bytes_per_row = blocks_per_row * 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim);
    assert!(weight.is_ok());
}

// ============================================================================
// Q4KWeight Invalid Construction Tests
// ============================================================================

#[test]
fn test_q4k_weight_new_data_too_small() {
    let in_dim = 256;
    let out_dim = 1;
    let data = vec![0u8; 100];

    let result = Q4KWeight::new(data, in_dim, out_dim);
    assert!(result.is_err());

    if let Err(err) = result {
        match err {
            RealizarError::InvalidShape { reason } => {
                assert!(reason.contains("doesn't match"));
                assert!(reason.contains("100"));
                assert!(reason.contains("144"));
            },
            _ => panic!("Expected InvalidShape error"),
        }
    }
}

#[test]
fn test_q4k_weight_new_data_too_large() {
    let data = vec![0u8; 200];
    let result = Q4KWeight::new(data, 256, 1);
    assert!(result.is_err());
}

#[test]
fn test_q4k_weight_new_empty_data() {
    let data: Vec<u8> = vec![];
    let result = Q4KWeight::new(data, 256, 1);
    assert!(result.is_err());
}

#[test]
fn test_q4k_weight_new_zero_output_dim() {
    let data: Vec<u8> = vec![];
    let result = Q4KWeight::new(data, 256, 0);
    assert!(result.is_ok());

    let w = result.expect("w");
    assert_eq!(w.out_dim, 0);
    assert_eq!(w.memory_bytes(), 0);
}

#[test]
fn test_q4k_weight_new_data_slightly_off() {
    let data = vec![0u8; 143];
    let result = Q4KWeight::new(data, 256, 1);
    assert!(result.is_err());
}

// ============================================================================
// Q4KWeight Memory Statistics Tests
// ============================================================================

#[test]
fn test_q4k_weight_memory_bytes() {
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 256, 1).expect("weight");
    assert_eq!(weight.memory_bytes(), 144);

    let data = vec![0u8; 10 * 144];
    let weight = Q4KWeight::new(data, 256, 10).expect("weight");
    assert_eq!(weight.memory_bytes(), 10 * 144);
}

#[test]
fn test_q4k_weight_f32_equivalent_bytes() {
    let data = vec![0u8; 4 * 144];
    let weight = Q4KWeight::new(data, 256, 4).expect("weight");
    assert_eq!(weight.f32_equivalent_bytes(), 256 * 4 * 4);
}

#[test]
fn test_q4k_weight_f32_equivalent_large() {
    let in_dim: usize = 4096;
    let out_dim: usize = 4096;
    let blocks_per_row = in_dim.div_ceil(256);
    let bytes_per_row = blocks_per_row * 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim).expect("weight");
    assert_eq!(weight.f32_equivalent_bytes(), 4096 * 4096 * 4);
}

#[test]
fn test_q4k_weight_compression_ratio() {
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 256, 1).expect("weight");

    // F32 bytes: 256 * 1 * 4 = 1024, Q4_K bytes: 144, Ratio: ~7.11
    let ratio = weight.compression_ratio();
    assert!(ratio > 7.0, "Expected ratio > 7.0, got {}", ratio);
    assert!(ratio < 8.0, "Expected ratio < 8.0, got {}", ratio);
}

#[test]
fn test_q4k_weight_compression_ratio_consistency() {
    let sizes: [(usize, usize); 4] = [(256, 1), (256, 10), (512, 4), (1024, 2)];

    for (in_dim, out_dim) in sizes {
        let blocks_per_row = in_dim.div_ceil(256);
        let bytes_per_row = blocks_per_row * 144;
        let data = vec![0u8; out_dim * bytes_per_row];

        let weight = Q4KWeight::new(data, in_dim, out_dim).expect("weight");
        let ratio = weight.compression_ratio();

        assert!(
            ratio > 7.0,
            "Ratio for {}x{} was {}",
            in_dim,
            out_dim,
            ratio
        );
    }
}

// ============================================================================
// Q4KWeight Matvec Error Handling Tests
// ============================================================================

#[test]
fn test_q4k_weight_matvec_wrong_input_length() {
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 256, 1).expect("weight");

    // Too short
    let result = weight.matvec(&vec![1.0f32; 128]);
    assert!(result.is_err());
    if let Err(RealizarError::InvalidShape { reason }) = result {
        assert!(reason.contains("128"));
        assert!(reason.contains("256"));
    } else {
        panic!("Expected InvalidShape error");
    }

    // Too long
    let result = weight.matvec(&vec![1.0f32; 512]);
    assert!(result.is_err());
}

#[test]
fn test_q4k_weight_matvec_empty_input() {
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 256, 1).expect("weight");
    let result = weight.matvec(&[]);
    assert!(result.is_err());
}

#[test]
fn test_q4k_weight_matvec_off_by_one() {
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 256, 1).expect("weight");

    assert!(weight.matvec(&vec![1.0f32; 255]).is_err());
    assert!(weight.matvec(&vec![1.0f32; 257]).is_err());
}

// ============================================================================
// Q4KWeight Clone and Field Access Tests
// ============================================================================

#[test]
fn test_q4k_weight_clone_preserves_data() {
    let in_dim = 256;
    let out_dim = 2;
    let data: Vec<u8> = (0..out_dim * 144).map(|i| (i % 256) as u8).collect();

    let weight = Q4KWeight::new(data.clone(), in_dim, out_dim).expect("weight");
    let cloned = weight.clone();

    assert_eq!(weight.in_dim, cloned.in_dim);
    assert_eq!(weight.out_dim, cloned.out_dim);
    assert_eq!(weight.data, cloned.data);
    assert_eq!(weight.memory_bytes(), cloned.memory_bytes());
}

#[test]
fn test_q4k_weight_public_fields() {
    let in_dim: usize = 512;
    let out_dim: usize = 4;
    let blocks_per_row = in_dim.div_ceil(256);
    let bytes_per_row = blocks_per_row * 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim).expect("weight");

    assert_eq!(weight.in_dim, 512);
    assert_eq!(weight.out_dim, 4);
    assert_eq!(weight.data.len(), out_dim * bytes_per_row);
}

#[test]
fn test_q4k_weight_data_content() {
    let data: Vec<u8> = (0..144).map(|i| i as u8).collect();
    let weight = Q4KWeight::new(data.clone(), 256, 1).expect("weight");
    assert_eq!(weight.data, data);
}

// ============================================================================
// Integration: Error Message Quality Tests
// ============================================================================

#[test]
fn test_q4k_weight_error_message_includes_dimensions() {
    let data = vec![0u8; 100];
    let result = Q4KWeight::new(data, 256, 1);
    assert!(result.is_err());

    if let Err(err) = result {
        let msg = err.to_string();
        assert!(
            msg.contains("100") || msg.contains("144"),
            "Error should mention sizes: {}",
            msg
        );
    }
}

#[test]
fn test_q4k_weight_matvec_error_message_quality() {
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 256, 1).expect("weight");

    let result = weight.matvec(&vec![1.0f32; 128]);
    assert!(result.is_err());

    if let Err(err) = result {
        let msg = err.to_string();
        assert!(msg.contains("128") || msg.contains("256"), "Error: {}", msg);
    }
}

// ============================================================================
// Edge Cases: Boundary Conditions
// ============================================================================

#[test]
fn test_q4k_weight_multiple_of_256() {
    for multiplier in 1..=4 {
        let in_dim = 256 * multiplier;
        let blocks_per_row = multiplier;
        let bytes_per_row = blocks_per_row * 144;
        let data = vec![0u8; bytes_per_row];

        let weight = Q4KWeight::new(data, in_dim, 1);
        assert!(weight.is_ok(), "Failed for in_dim={}", in_dim);
        assert_eq!(weight.expect("expected value").in_dim, in_dim);
    }
}

#[test]
fn test_q4k_weight_ceil_division_boundary() {
    // 257 elements requires 2 blocks
    let data = vec![0u8; 2 * 144];
    let weight = Q4KWeight::new(data, 257, 1);
    assert!(weight.is_ok());

    // 255 elements requires 1 block
    let data = vec![0u8; 144];
    let weight = Q4KWeight::new(data, 255, 1);
    assert!(weight.is_ok());
}

// ============================================================================
// Stress Tests: Large Configurations
// ============================================================================

#[test]
fn test_q4k_weight_large_output_dimension() {
    let data = vec![0u8; 1000 * 144];
    let weight = Q4KWeight::new(data, 256, 1000).expect("weight");

    assert_eq!(weight.out_dim, 1000);
    assert_eq!(weight.memory_bytes(), 1000 * 144);
    assert!(weight.compression_ratio() > 7.0);
}

#[test]
fn test_q4k_weight_statistics_consistency() {
    let in_dim: usize = 1024;
    let out_dim: usize = 512;
    let blocks_per_row = in_dim.div_ceil(256);
    let bytes_per_row = blocks_per_row * 144;
    let data = vec![0u8; out_dim * bytes_per_row];

    let weight = Q4KWeight::new(data, in_dim, out_dim).expect("weight");

    let memory = weight.memory_bytes();
    let f32_equiv = weight.f32_equivalent_bytes();
    let ratio = weight.compression_ratio();

    let calculated_ratio = f32_equiv as f32 / memory as f32;
    assert!(
        (ratio - calculated_ratio).abs() < 0.001,
        "Ratio mismatch: {} vs calculated {}",
        ratio,
        calculated_ratio
    );
}