realizar 0.8.5

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
impl ModelFixture {
    // =========================================================================
    // GGUF Fixtures
    // =========================================================================

    /// Create a GGUF model fixture
    ///
    /// # Arguments
    /// * `name` - Model name (used for filename)
    /// * `config` - Model configuration
    ///
    /// # Panics
    /// Panics if fixture creation fails (test should fail fast)
    #[must_use]
    pub fn gguf(name: &str, config: ModelConfig) -> Self {
        Self::try_gguf(name, config).expect("Failed to create GGUF fixture")
    }

    /// Try to create a GGUF model fixture
    pub fn try_gguf(name: &str, config: ModelConfig) -> Result<Self> {
        let temp_dir = TempDir::new().map_err(|e| RealizarError::IoError {
            message: format!("create_temp_dir: {}", e),
        })?;

        let filename = format!("{}.gguf", name);
        let path = temp_dir.path().join(&filename);

        // Generate GGUF data
        let data = Self::generate_gguf_data(&config);

        // Write to file
        fs::write(&path, &data).map_err(|e| RealizarError::IoError {
            message: format!("write_gguf to {}: {}", path.display(), e),
        })?;

        Ok(Self {
            path,
            _temp_dir: temp_dir,
            format: ModelFormat::Gguf,
            config,
        })
    }

    /// Create a GGUF fixture with invalid magic (for error testing)
    #[must_use]
    pub fn gguf_invalid_magic(name: &str) -> Self {
        Self::try_gguf_invalid_magic(name).expect("Failed to create invalid GGUF fixture")
    }

    /// Try to create a GGUF fixture with invalid magic
    pub fn try_gguf_invalid_magic(name: &str) -> Result<Self> {
        let temp_dir = TempDir::new().map_err(|e| RealizarError::IoError {
            message: format!("create_temp_dir: {}", e),
        })?;

        let filename = format!("{}.gguf", name);
        let path = temp_dir.path().join(&filename);

        // Invalid GGUF: wrong magic
        let mut data = Vec::new();
        data.extend_from_slice(&0xDEADBEEFu32.to_le_bytes()); // Invalid magic
        data.extend_from_slice(&3u32.to_le_bytes()); // Version 3
        data.extend_from_slice(&0u64.to_le_bytes()); // 0 tensors
        data.extend_from_slice(&0u64.to_le_bytes()); // 0 metadata
        data.resize(32, 0); // Align

        fs::write(&path, &data).map_err(|e| RealizarError::IoError {
            message: format!("write_gguf to {}: {}", path.display(), e),
        })?;

        Ok(Self {
            path,
            _temp_dir: temp_dir,
            format: ModelFormat::Gguf,
            config: ModelConfig::tiny(),
        })
    }

    /// Create a GGUF fixture with unsupported version
    #[must_use]
    pub fn gguf_invalid_version(name: &str) -> Self {
        Self::try_gguf_invalid_version(name).expect("Failed to create invalid version fixture")
    }

    /// Try to create GGUF with invalid version
    pub fn try_gguf_invalid_version(name: &str) -> Result<Self> {
        let temp_dir = TempDir::new().map_err(|e| RealizarError::IoError {
            message: format!("create_temp_dir: {}", e),
        })?;

        let filename = format!("{}.gguf", name);
        let path = temp_dir.path().join(&filename);

        // Invalid GGUF: unsupported version
        let mut data = Vec::new();
        data.extend_from_slice(&0x46554747u32.to_le_bytes()); // Valid magic "GGUF"
        data.extend_from_slice(&999u32.to_le_bytes()); // Invalid version
        data.extend_from_slice(&0u64.to_le_bytes());
        data.extend_from_slice(&0u64.to_le_bytes());
        data.resize(32, 0);

        fs::write(&path, &data).map_err(|e| RealizarError::IoError {
            message: format!("write_gguf to {}: {}", path.display(), e),
        })?;

        Ok(Self {
            path,
            _temp_dir: temp_dir,
            format: ModelFormat::Gguf,
            config: ModelConfig::tiny(),
        })
    }

    // =========================================================================
    // SafeTensors Fixtures
    // =========================================================================

    /// Create a SafeTensors model fixture
    #[must_use]
    pub fn safetensors(name: &str, config: ModelConfig) -> Self {
        Self::try_safetensors(name, config).expect("Failed to create SafeTensors fixture")
    }

    /// Try to create a SafeTensors fixture
    pub fn try_safetensors(name: &str, config: ModelConfig) -> Result<Self> {
        let temp_dir = TempDir::new().map_err(|e| RealizarError::IoError {
            message: format!("create_temp_dir: {}", e),
        })?;

        let filename = format!("{}.safetensors", name);
        let path = temp_dir.path().join(&filename);

        // Generate SafeTensors data
        let data = Self::generate_safetensors_data(&config);

        fs::write(&path, &data).map_err(|e| RealizarError::IoError {
            message: format!("write_safetensors to {}: {}", path.display(), e),
        })?;

        // Generate config.json (required for SafeTensors inference)
        let config_json = format!(
            r#"{{"hidden_size":{},"num_hidden_layers":{},"num_attention_heads":{},"num_key_value_heads":{},"vocab_size":{},"intermediate_size":{},"max_position_embeddings":{},"rope_theta":{},"rms_norm_eps":{},"model_type":"{}"}}"#,
            config.hidden_dim,
            config.num_layers,
            config.num_heads,
            config.num_kv_heads,
            config.vocab_size,
            config.intermediate_dim,
            config.context_length,
            config.rope_theta,
            config.eps,
            config.architecture
        );
        let config_path = temp_dir.path().join("config.json");
        fs::write(&config_path, config_json).map_err(|e| RealizarError::IoError {
            message: format!("write_config to {}: {}", config_path.display(), e),
        })?;

        Ok(Self {
            path,
            _temp_dir: temp_dir,
            format: ModelFormat::SafeTensors,
            config,
        })
    }

    // =========================================================================
    // APR Fixtures
    // =========================================================================

    /// Create an APR model fixture
    #[must_use]
    pub fn apr(name: &str, config: ModelConfig) -> Self {
        Self::try_apr(name, config).expect("Failed to create APR fixture")
    }

    /// Try to create an APR fixture
    pub fn try_apr(name: &str, config: ModelConfig) -> Result<Self> {
        let temp_dir = TempDir::new().map_err(|e| RealizarError::IoError {
            message: format!("create_temp_dir: {}", e),
        })?;

        let filename = format!("{}.apr", name);
        let path = temp_dir.path().join(&filename);

        // Generate APR v2 data
        let data = Self::generate_apr_data(&config);

        fs::write(&path, &data).map_err(|e| RealizarError::IoError {
            message: format!("write_apr to {}: {}", path.display(), e),
        })?;

        Ok(Self {
            path,
            _temp_dir: temp_dir,
            format: ModelFormat::Apr,
            config,
        })
    }

    // =========================================================================
    // Accessors
    // =========================================================================

    /// Get path to the model file
    #[must_use]
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Get model format
    #[must_use]
    pub fn format(&self) -> ModelFormat {
        self.format
    }

    /// Get model configuration
    #[must_use]
    pub fn config(&self) -> &ModelConfig {
        &self.config
    }

    /// Read model file bytes
    pub fn read_bytes(&self) -> Result<Vec<u8>> {
        fs::read(&self.path).map_err(|e| RealizarError::IoError {
            message: format!("read_fixture {}: {}", self.path.display(), e),
        })
    }

    // =========================================================================
    // Data Generation (Internal)
    // =========================================================================

    /// Generate valid GGUF data for config
    fn generate_gguf_data(config: &ModelConfig) -> Vec<u8> {
        use crate::gguf::test_factory::GGUFBuilder;

        let arch = &config.architecture;

        // Build minimal GGUF with required tensors
        let builder = GGUFBuilder::new()
            .architecture(arch)
            .hidden_dim(arch, config.hidden_dim as u32)
            .num_layers(arch, config.num_layers as u32)
            .num_heads(arch, config.num_heads as u32)
            .num_kv_heads(arch, config.num_kv_heads as u32)
            .context_length(arch, config.context_length as u32)
            .rope_freq_base(arch, config.rope_theta)
            .rms_epsilon(arch, config.eps)
            .ffn_hidden_dim(arch, config.intermediate_dim as u32);

        // Add token embedding (F32)
        let embed_data: Vec<f32> = (0..config.vocab_size * config.hidden_dim)
            .map(|i| (i as f32) * 0.001)
            .collect();
        let builder = builder.add_f32_tensor(
            "token_embd.weight",
            &[config.hidden_dim as u64, config.vocab_size as u64],
            &embed_data,
        );

        // Add output norm
        let norm_data: Vec<f32> = vec![1.0; config.hidden_dim];
        let builder = builder.add_f32_tensor(
            "output_norm.weight",
            &[config.hidden_dim as u64],
            &norm_data,
        );

        // Add layer weights (Q4_K for compression)
        let head_dim = config.hidden_dim / config.num_heads;
        let kv_dim = config.num_kv_heads * head_dim;
        let qkv_dim = config.hidden_dim + 2 * kv_dim;

        let mut final_builder = builder;
        for layer in 0..config.num_layers {
            // Attention norm
            let norm_data: Vec<f32> = vec![1.0; config.hidden_dim];
            final_builder = final_builder.add_f32_tensor(
                &format!("blk.{}.attn_norm.weight", layer),
                &[config.hidden_dim as u64],
                &norm_data,
            );

            // QKV (Q4_K)
            let qkv_data = Self::create_q4k_data(config.hidden_dim, qkv_dim);
            final_builder = final_builder.add_q4_k_tensor(
                &format!("blk.{}.attn_qkv.weight", layer),
                &[qkv_dim as u64, config.hidden_dim as u64],
                &qkv_data,
            );

            // Attention output
            let attn_out_data = Self::create_q4k_data(config.hidden_dim, config.hidden_dim);
            final_builder = final_builder.add_q4_k_tensor(
                &format!("blk.{}.attn_output.weight", layer),
                &[config.hidden_dim as u64, config.hidden_dim as u64],
                &attn_out_data,
            );

            // FFN up
            let ffn_up_data = Self::create_q4k_data(config.hidden_dim, config.intermediate_dim);
            final_builder = final_builder.add_q4_k_tensor(
                &format!("blk.{}.ffn_up.weight", layer),
                &[config.intermediate_dim as u64, config.hidden_dim as u64],
                &ffn_up_data,
            );

            // FFN down
            let ffn_down_data = Self::create_q4k_data(config.intermediate_dim, config.hidden_dim);
            final_builder = final_builder.add_q4_k_tensor(
                &format!("blk.{}.ffn_down.weight", layer),
                &[config.hidden_dim as u64, config.intermediate_dim as u64],
                &ffn_down_data,
            );

            // FFN gate (for SwiGLU)
            if config.architecture == "llama" || config.architecture == "qwen2" {
                let ffn_gate_data =
                    Self::create_q4k_data(config.hidden_dim, config.intermediate_dim);
                final_builder = final_builder.add_q4_k_tensor(
                    &format!("blk.{}.ffn_gate.weight", layer),
                    &[config.intermediate_dim as u64, config.hidden_dim as u64],
                    &ffn_gate_data,
                );
            }

            // FFN norm
            let ffn_norm_data: Vec<f32> = vec![1.0; config.hidden_dim];
            final_builder = final_builder.add_f32_tensor(
                &format!("blk.{}.ffn_norm.weight", layer),
                &[config.hidden_dim as u64],
                &ffn_norm_data,
            );
        }

        // Output/LM head (tied with embeddings in many models)
        let lm_head_data = Self::create_q4k_data(config.hidden_dim, config.vocab_size);
        final_builder = final_builder.add_q4_k_tensor(
            "output.weight",
            &[config.vocab_size as u64, config.hidden_dim as u64],
            &lm_head_data,
        );

        final_builder.build()
    }

    /// Generate SafeTensors data for config
    fn generate_safetensors_data(config: &ModelConfig) -> Vec<u8> {
        use crate::gguf::format_factory::SafetensorsBuilder;

        let mut builder = SafetensorsBuilder::new();

        // Token embedding
        let embed_data: Vec<f32> = (0..config.vocab_size * config.hidden_dim)
            .map(|i| (i as f32) * 0.001)
            .collect();
        builder = builder.add_f32_tensor(
            "model.embed_tokens.weight",
            &[config.vocab_size, config.hidden_dim],
            &embed_data,
        );

        // Output norm
        let norm_data: Vec<f32> = vec![1.0; config.hidden_dim];
        builder = builder.add_f32_tensor("model.norm.weight", &[config.hidden_dim], &norm_data);

        // Layer weights
        for layer in 0..config.num_layers {
            // Attention norm
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.input_layernorm.weight", layer),
                &[config.hidden_dim],
                &norm_data,
            );

            // Q projection
            let q_data: Vec<f32> = vec![0.01; config.hidden_dim * config.hidden_dim];
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.self_attn.q_proj.weight", layer),
                &[config.hidden_dim, config.hidden_dim],
                &q_data,
            );

            // K projection
            let kv_dim = config.num_kv_heads * (config.hidden_dim / config.num_heads);
            let k_data: Vec<f32> = vec![0.01; kv_dim * config.hidden_dim];
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.self_attn.k_proj.weight", layer),
                &[kv_dim, config.hidden_dim],
                &k_data,
            );

            // V projection
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.self_attn.v_proj.weight", layer),
                &[kv_dim, config.hidden_dim],
                &k_data,
            );

            // O projection
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.self_attn.o_proj.weight", layer),
                &[config.hidden_dim, config.hidden_dim],
                &q_data,
            );

            // FFN
            let ffn_data: Vec<f32> = vec![0.01; config.hidden_dim * config.intermediate_dim];
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.mlp.up_proj.weight", layer),
                &[config.intermediate_dim, config.hidden_dim],
                &ffn_data,
            );
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.mlp.gate_proj.weight", layer),
                &[config.intermediate_dim, config.hidden_dim],
                &ffn_data,
            );

            let down_data: Vec<f32> = vec![0.01; config.intermediate_dim * config.hidden_dim];
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.mlp.down_proj.weight", layer),
                &[config.hidden_dim, config.intermediate_dim],
                &down_data,
            );

            // Post attention norm
            builder = builder.add_f32_tensor(
                &format!("model.layers.{}.post_attention_layernorm.weight", layer),
                &[config.hidden_dim],
                &norm_data,
            );
        }

        // LM head
        let lm_head_data: Vec<f32> = vec![0.01; config.vocab_size * config.hidden_dim];
        builder = builder.add_f32_tensor(
            "lm_head.weight",
            &[config.vocab_size, config.hidden_dim],
            &lm_head_data,
        );

        builder.build()
    }
}