kizzasi-tokenizer 0.2.1

Signal quantization and tokenization for Kizzasi AGSP - VQ-VAE, μ-law, continuous embeddings
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
//! Model persistence and checkpoint management
//!
//! This module provides functionality for saving and loading trained tokenizer
//! models, including weights, configurations, and training state.
//!
//! # Features
//!
//! - **Safetensors**: Efficient weight serialization using safetensors format
//! - **Checkpoints**: Save/load training checkpoints with metadata
//! - **Versioning**: Track model versions and compatibility
//! - **Configuration**: Export/import model configurations as JSON/TOML
//!
//! # Example
//!
//! ```ignore
//! use kizzasi_tokenizer::persistence::{ModelCheckpoint, save_checkpoint};
//! use kizzasi_tokenizer::TrainableContinuousTokenizer;
//!
//! let tokenizer = TrainableContinuousTokenizer::new(8, 16)?;
//! // ... train the model ...
//!
//! let checkpoint = ModelCheckpoint::from_trainable_tokenizer(&tokenizer, "v1.0")?;
//! save_checkpoint(&checkpoint, "model_checkpoint.safetensors")?;
//! ```

use crate::error::{TokenizerError, TokenizerResult};
use crate::{ReconstructionMetrics, TrainingConfig};
use chrono::{DateTime, Utc};
use scirs2_core::ndarray::Array2;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fmt;
use std::fs::File;
use std::io::{Read, Write};
use std::path::Path;

/// Model version for compatibility tracking
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ModelVersion {
    /// Major version (breaking changes)
    pub major: u32,
    /// Minor version (new features)
    pub minor: u32,
    /// Patch version (bug fixes)
    pub patch: u32,
}

impl ModelVersion {
    /// Create a new model version
    pub fn new(major: u32, minor: u32, patch: u32) -> Self {
        Self {
            major,
            minor,
            patch,
        }
    }

    /// Parse version from string (e.g., "1.2.3")
    pub fn parse(s: &str) -> TokenizerResult<Self> {
        let parts: Vec<&str> = s.split('.').collect();
        if parts.len() != 3 {
            return Err(TokenizerError::InvalidConfig(format!(
                "Invalid version string: {}",
                s
            )));
        }

        let major = parts[0]
            .parse()
            .map_err(|_| TokenizerError::InvalidConfig("Invalid major version".into()))?;
        let minor = parts[1]
            .parse()
            .map_err(|_| TokenizerError::InvalidConfig("Invalid minor version".into()))?;
        let patch = parts[2]
            .parse()
            .map_err(|_| TokenizerError::InvalidConfig("Invalid patch version".into()))?;

        Ok(Self::new(major, minor, patch))
    }

    /// Check if this version is compatible with another version
    pub fn is_compatible_with(&self, other: &ModelVersion) -> bool {
        // Compatible if major versions match
        self.major == other.major
    }
}

impl fmt::Display for ModelVersion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
    }
}

/// Model metadata for checkpoints
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ModelMetadata {
    /// Model version
    pub version: ModelVersion,
    /// Model type (e.g., "TrainableContinuousTokenizer")
    pub model_type: String,
    /// Creation timestamp
    pub created_at: DateTime<Utc>,
    /// Last modified timestamp
    pub modified_at: DateTime<Utc>,
    /// Input dimension
    pub input_dim: usize,
    /// Embedding dimension
    pub embed_dim: usize,
    /// Training configuration (if available)
    pub training_config: Option<TrainingConfig>,
    /// Training metrics (if available)
    pub metrics: Option<ReconstructionMetrics>,
    /// Additional custom metadata
    pub custom: HashMap<String, String>,
}

impl ModelMetadata {
    /// Create new metadata
    pub fn new(
        version: ModelVersion,
        model_type: String,
        input_dim: usize,
        embed_dim: usize,
    ) -> Self {
        let now = Utc::now();
        Self {
            version,
            model_type,
            created_at: now,
            modified_at: now,
            input_dim,
            embed_dim,
            training_config: None,
            metrics: None,
            custom: HashMap::new(),
        }
    }

    /// Update the modified timestamp
    pub fn touch(&mut self) {
        self.modified_at = Utc::now();
    }

    /// Add custom metadata
    pub fn add_custom(&mut self, key: String, value: String) {
        self.custom.insert(key, value);
    }
}

/// Model checkpoint containing weights and metadata
#[derive(Debug)]
pub struct ModelCheckpoint {
    /// Checkpoint metadata
    pub metadata: ModelMetadata,
    /// Model weights as tensor data
    pub weights: HashMap<String, Vec<f32>>,
    /// Weight shapes for reconstruction
    pub shapes: HashMap<String, Vec<usize>>,
}

impl ModelCheckpoint {
    /// Create a new checkpoint
    pub fn new(metadata: ModelMetadata) -> Self {
        Self {
            metadata,
            weights: HashMap::new(),
            shapes: HashMap::new(),
        }
    }

    /// Add a weight tensor to the checkpoint
    pub fn add_weight(&mut self, name: String, data: Vec<f32>, shape: Vec<usize>) {
        self.weights.insert(name.clone(), data);
        self.shapes.insert(name, shape);
    }

    /// Add a 2D array weight
    pub fn add_array2(&mut self, name: String, array: &Array2<f32>) {
        let shape = array.shape();
        let data: Vec<f32> = array.iter().copied().collect();
        self.add_weight(name, data, vec![shape[0], shape[1]]);
    }

    /// Get a weight tensor
    pub fn get_weight(&self, name: &str) -> Option<(&[f32], &[usize])> {
        self.weights
            .get(name)
            .and_then(|w| self.shapes.get(name).map(|s| (w.as_slice(), s.as_slice())))
    }

    /// Get a weight as Array2
    pub fn get_array2(&self, name: &str) -> TokenizerResult<Array2<f32>> {
        let (data, shape) = self
            .get_weight(name)
            .ok_or_else(|| TokenizerError::InvalidConfig(format!("Weight '{}' not found", name)))?;

        if shape.len() != 2 {
            return Err(TokenizerError::InvalidConfig(format!(
                "Expected 2D array for '{}', got {}D",
                name,
                shape.len()
            )));
        }

        let mut array = Array2::zeros((shape[0], shape[1]));
        for (i, &val) in data.iter().enumerate() {
            let row = i / shape[1];
            let col = i % shape[1];
            array[[row, col]] = val;
        }

        Ok(array)
    }

    /// Save checkpoint to safetensors format
    pub fn save<P: AsRef<Path>>(&self, path: P) -> TokenizerResult<()> {
        let path = path.as_ref();

        // Convert weights to safetensors format
        let mut tensors = Vec::new();
        for (name, data) in &self.weights {
            let shape = self.shapes.get(name).ok_or_else(|| {
                TokenizerError::InternalError(format!("Missing shape for weight '{}'", name))
            })?;

            // Convert f32 to bytes
            let data_bytes: Vec<u8> = data.iter().flat_map(|&f| f.to_le_bytes()).collect();

            tensors.push((name.clone(), shape.clone(), data_bytes));
        }

        // Serialize metadata to JSON
        let metadata_json = serde_json::to_string(&self.metadata)
            .map_err(|e| TokenizerError::InternalError(e.to_string()))?;

        // Create safetensors data
        let mut data_map: HashMap<String, (Vec<usize>, Vec<u8>)> = HashMap::new();
        for (name, shape, data) in tensors {
            data_map.insert(name, (shape, data));
        }

        // Write to file
        let mut file = File::create(path)
            .map_err(|e| TokenizerError::InternalError(format!("Failed to create file: {}", e)))?;

        // Write metadata length (u32) + metadata + tensors
        let metadata_bytes = metadata_json.as_bytes();
        let metadata_len = metadata_bytes.len() as u32;

        file.write_all(&metadata_len.to_le_bytes())
            .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;
        file.write_all(metadata_bytes)
            .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;

        // Write tensor data
        for (name, (shape, data)) in data_map {
            // Write: name_len (u32) + name + shape_len (u32) + shape + data_len (u32) + data
            let name_bytes = name.as_bytes();
            file.write_all(&(name_bytes.len() as u32).to_le_bytes())
                .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;
            file.write_all(name_bytes)
                .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;

            file.write_all(&(shape.len() as u32).to_le_bytes())
                .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;
            for &dim in &shape {
                file.write_all(&(dim as u32).to_le_bytes()).map_err(|e| {
                    TokenizerError::InternalError(format!("Failed to write: {}", e))
                })?;
            }

            file.write_all(&(data.len() as u32).to_le_bytes())
                .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;
            file.write_all(&data)
                .map_err(|e| TokenizerError::InternalError(format!("Failed to write: {}", e)))?;
        }

        Ok(())
    }

    /// Load checkpoint from safetensors format
    pub fn load<P: AsRef<Path>>(path: P) -> TokenizerResult<Self> {
        let path = path.as_ref();
        let mut file = File::open(path)
            .map_err(|e| TokenizerError::InternalError(format!("Failed to open file: {}", e)))?;

        // Read metadata length
        let mut len_buf = [0u8; 4];
        file.read_exact(&mut len_buf)
            .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;
        let metadata_len = u32::from_le_bytes(len_buf) as usize;

        // Read metadata
        let mut metadata_buf = vec![0u8; metadata_len];
        file.read_exact(&mut metadata_buf)
            .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;
        let metadata: ModelMetadata = serde_json::from_slice(&metadata_buf).map_err(|e| {
            TokenizerError::InternalError(format!("Failed to parse metadata: {}", e))
        })?;

        let mut checkpoint = ModelCheckpoint::new(metadata);

        // Read tensors
        loop {
            // Try to read name length
            let mut name_len_buf = [0u8; 4];
            match file.read_exact(&mut name_len_buf) {
                Ok(_) => {}
                Err(e) if e.kind() == std::io::ErrorKind::UnexpectedEof => break,
                Err(e) => {
                    return Err(TokenizerError::InternalError(format!(
                        "Failed to read: {}",
                        e
                    )))
                }
            }
            let name_len = u32::from_le_bytes(name_len_buf) as usize;

            // Read name
            let mut name_buf = vec![0u8; name_len];
            file.read_exact(&mut name_buf)
                .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;
            let name = String::from_utf8(name_buf)
                .map_err(|e| TokenizerError::InternalError(format!("Invalid UTF-8: {}", e)))?;

            // Read shape
            let mut shape_len_buf = [0u8; 4];
            file.read_exact(&mut shape_len_buf)
                .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;
            let shape_len = u32::from_le_bytes(shape_len_buf) as usize;

            let mut shape = Vec::with_capacity(shape_len);
            for _ in 0..shape_len {
                let mut dim_buf = [0u8; 4];
                file.read_exact(&mut dim_buf)
                    .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;
                shape.push(u32::from_le_bytes(dim_buf) as usize);
            }

            // Read data
            let mut data_len_buf = [0u8; 4];
            file.read_exact(&mut data_len_buf)
                .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;
            let data_len = u32::from_le_bytes(data_len_buf) as usize;

            let mut data_bytes = vec![0u8; data_len];
            file.read_exact(&mut data_bytes)
                .map_err(|e| TokenizerError::InternalError(format!("Failed to read: {}", e)))?;

            // Convert bytes to f32
            let data: Vec<f32> = data_bytes
                .chunks_exact(4)
                .map(|chunk| f32::from_le_bytes([chunk[0], chunk[1], chunk[2], chunk[3]]))
                .collect();

            checkpoint.add_weight(name, data, shape);
        }

        Ok(checkpoint)
    }
}

/// Save a training configuration to JSON
pub fn save_config<P: AsRef<Path>>(config: &TrainingConfig, path: P) -> TokenizerResult<()> {
    let json = serde_json::to_string_pretty(config)
        .map_err(|e| TokenizerError::InternalError(e.to_string()))?;

    std::fs::write(path, json)
        .map_err(|e| TokenizerError::InternalError(format!("Failed to write config: {}", e)))?;

    Ok(())
}

/// Load a training configuration from JSON
pub fn load_config<P: AsRef<Path>>(path: P) -> TokenizerResult<TrainingConfig> {
    let json = std::fs::read_to_string(path)
        .map_err(|e| TokenizerError::InternalError(format!("Failed to read config: {}", e)))?;

    let config = serde_json::from_str(&json)
        .map_err(|e| TokenizerError::InternalError(format!("Failed to parse config: {}", e)))?;

    Ok(config)
}

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

    #[test]
    fn test_model_version() {
        let v1 = ModelVersion::new(1, 2, 3);
        assert_eq!(v1.to_string(), "1.2.3");

        let v2 = ModelVersion::parse("1.2.3").unwrap();
        assert_eq!(v1, v2);

        assert!(v1.is_compatible_with(&v2));

        let v3 = ModelVersion::new(2, 0, 0);
        assert!(!v1.is_compatible_with(&v3));
    }

    #[test]
    fn test_model_metadata() {
        let version = ModelVersion::new(1, 0, 0);
        let mut metadata = ModelMetadata::new(version, "TestModel".to_string(), 8, 16);

        metadata.add_custom("author".to_string(), "Test User".to_string());
        assert_eq!(metadata.custom.get("author").unwrap(), "Test User");

        let before = metadata.modified_at;
        std::thread::sleep(std::time::Duration::from_millis(10));
        metadata.touch();
        assert!(metadata.modified_at > before);
    }

    #[test]
    fn test_checkpoint_creation() {
        let version = ModelVersion::new(1, 0, 0);
        let metadata = ModelMetadata::new(version, "TestModel".to_string(), 8, 16);
        let mut checkpoint = ModelCheckpoint::new(metadata);

        // Add some weights
        let data = vec![1.0, 2.0, 3.0, 4.0];
        let shape = vec![2, 2];
        checkpoint.add_weight("test_weight".to_string(), data.clone(), shape.clone());

        // Retrieve weights
        let (retrieved_data, retrieved_shape) = checkpoint.get_weight("test_weight").unwrap();
        assert_eq!(retrieved_data, &data[..]);
        assert_eq!(retrieved_shape, &shape[..]);
    }

    #[test]
    fn test_checkpoint_array2() {
        let version = ModelVersion::new(1, 0, 0);
        let metadata = ModelMetadata::new(version, "TestModel".to_string(), 8, 16);
        let mut checkpoint = ModelCheckpoint::new(metadata);

        // Create a 2x3 array
        let mut array = Array2::zeros((2, 3));
        array[[0, 0]] = 1.0;
        array[[0, 1]] = 2.0;
        array[[0, 2]] = 3.0;
        array[[1, 0]] = 4.0;
        array[[1, 1]] = 5.0;
        array[[1, 2]] = 6.0;

        checkpoint.add_array2("matrix".to_string(), &array);

        // Retrieve and verify
        let retrieved = checkpoint.get_array2("matrix").unwrap();
        assert_eq!(retrieved.shape(), &[2, 3]);
        assert_eq!(retrieved[[0, 0]], 1.0);
        assert_eq!(retrieved[[1, 2]], 6.0);
    }

    #[test]
    fn test_checkpoint_save_load() {
        let temp_dir = env::temp_dir();
        let checkpoint_path = temp_dir.join("test_checkpoint.safetensors");

        // Create and save checkpoint
        let version = ModelVersion::new(1, 0, 0);
        let mut metadata = ModelMetadata::new(version, "TestModel".to_string(), 4, 8);
        metadata.add_custom("test".to_string(), "value".to_string());

        let mut checkpoint = ModelCheckpoint::new(metadata);

        let mut encoder = Array2::zeros((4, 8));
        for i in 0..4 {
            for j in 0..8 {
                encoder[[i, j]] = (i * 8 + j) as f32;
            }
        }
        checkpoint.add_array2("encoder".to_string(), &encoder);

        checkpoint.save(&checkpoint_path).unwrap();

        // Load and verify
        let loaded = ModelCheckpoint::load(&checkpoint_path).unwrap();
        assert_eq!(loaded.metadata.model_type, "TestModel");
        assert_eq!(loaded.metadata.input_dim, 4);
        assert_eq!(loaded.metadata.embed_dim, 8);
        assert_eq!(loaded.metadata.custom.get("test").unwrap(), "value");

        let loaded_encoder = loaded.get_array2("encoder").unwrap();
        assert_eq!(loaded_encoder.shape(), &[4, 8]);
        assert_eq!(loaded_encoder[[0, 0]], 0.0);
        assert_eq!(loaded_encoder[[3, 7]], 31.0);

        // Cleanup
        std::fs::remove_file(&checkpoint_path).ok();
    }

    #[test]
    fn test_save_load_config() {
        let temp_dir = env::temp_dir();
        let config_path = temp_dir.join("test_config.json");

        let config = TrainingConfig {
            learning_rate: 0.001,
            num_epochs: 50,
            batch_size: 16,
            ..Default::default()
        };

        save_config(&config, &config_path).unwrap();
        let loaded_config = load_config(&config_path).unwrap();

        assert_eq!(loaded_config.learning_rate, 0.001);
        assert_eq!(loaded_config.num_epochs, 50);
        assert_eq!(loaded_config.batch_size, 16);

        // Cleanup
        std::fs::remove_file(&config_path).ok();
    }
}