kizzasi-model 0.2.1

Model architectures for Kizzasi AGSP - Mamba, RWKV, S4, Transformer
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
520
521
522
523
524
525
526
//! Batched Inference Support
//!
//! Provides efficient batched inference for all model architectures.
//! Manages batch-aware state handling, padding, and dynamic batching.
//!
//! # Features
//!
//! - **Batch-aware state management**: Separate hidden states per batch item
//! - **Efficient padding**: Dynamic sequence length handling
//! - **Dynamic batching**: Adaptive batch size optimization
//! - **Memory efficient**: Shared computation when possible
//!
//! # Example
//!
//! ```rust,ignore
//! use kizzasi_model::batch::BatchedModel;
//! use kizzasi_model::mamba::Mamba;
//!
//! let model = Mamba::new(config)?;
//! let batched = BatchedModel::new(model, batch_size);
//!
//! // Process batch of inputs
//! let outputs = batched.predict_batch(&inputs)?;
//! ```

use crate::error::{ModelError, ModelResult};
use crate::AutoregressiveModel;
use kizzasi_core::HiddenState;
use scirs2_core::ndarray::{s, Array2, Array3};

/// Batched wrapper for autoregressive models
///
/// Manages multiple sequences in parallel with independent states
pub struct BatchedModel<M: AutoregressiveModel> {
    /// Underlying model
    model: M,
    /// Batch size
    batch_size: usize,
    /// Hidden states for each batch item [batch_size, num_layers, state_shape]
    batch_states: Vec<Vec<HiddenState>>,
    /// Sequence lengths for each batch item
    sequence_lengths: Vec<usize>,
    /// Maximum sequence length in current batch
    max_length: usize,
}

impl<M: AutoregressiveModel> BatchedModel<M> {
    /// Create a new batched model wrapper
    ///
    /// # Arguments
    ///
    /// * `model` - The underlying autoregressive model
    /// * `batch_size` - Number of sequences to process in parallel
    pub fn new(model: M, batch_size: usize) -> ModelResult<Self> {
        if batch_size == 0 {
            return Err(ModelError::invalid_config("batch_size must be > 0"));
        }

        // Initialize states for each batch item
        // Get initial states from the model to ensure correct dimensions
        let template_states = model.get_states();

        // Clone template states for each batch item
        let batch_states = (0..batch_size).map(|_| template_states.clone()).collect();

        Ok(Self {
            model,
            batch_size,
            batch_states,
            sequence_lengths: vec![0; batch_size],
            max_length: 0,
        })
    }

    /// Get batch size
    pub fn batch_size(&self) -> usize {
        self.batch_size
    }

    /// Predict for a batch of inputs
    ///
    /// # Arguments
    ///
    /// * `inputs` - Batch of inputs [batch_size, input_dim]
    ///
    /// # Returns
    ///
    /// Batch of predictions [batch_size, output_dim]
    pub fn predict_batch(&mut self, inputs: &Array2<f32>) -> ModelResult<Array2<f32>> {
        let (batch_size, _input_dim) = inputs.dim();

        if batch_size != self.batch_size {
            return Err(ModelError::dimension_mismatch(
                "batch predict",
                self.batch_size,
                batch_size,
            ));
        }

        let output_dim = self.model.hidden_dim();
        let mut outputs = Array2::zeros((batch_size, output_dim));

        // Process each item in the batch
        for batch_idx in 0..batch_size {
            let input = inputs.row(batch_idx).to_owned();

            // Set model state for this batch item
            self.model
                .set_states(self.batch_states[batch_idx].clone())?;

            // Predict using step method from SignalPredictor trait
            let output = self.model.step(&input)?;

            // Store output
            outputs.row_mut(batch_idx).assign(&output);

            // Update stored state for this batch item
            self.batch_states[batch_idx] = self.model.get_states();

            // Update sequence length
            self.sequence_lengths[batch_idx] += 1;
        }

        self.max_length = *self.sequence_lengths.iter().max().unwrap_or(&0);

        Ok(outputs)
    }

    /// Predict multiple steps for a batch
    ///
    /// # Arguments
    ///
    /// * `inputs` - Batch of input sequences [batch_size, seq_len, input_dim]
    ///
    /// # Returns
    ///
    /// Batch of prediction sequences [batch_size, seq_len, output_dim]
    pub fn predict_sequence_batch(&mut self, inputs: &Array3<f32>) -> ModelResult<Array3<f32>> {
        let (batch_size, seq_len, _input_dim) = inputs.dim();

        if batch_size != self.batch_size {
            return Err(ModelError::dimension_mismatch(
                "batch forward_sequence",
                self.batch_size,
                batch_size,
            ));
        }

        let output_dim = self.model.hidden_dim();
        let mut outputs = Array3::zeros((batch_size, seq_len, output_dim));

        // Process each timestep
        for t in 0..seq_len {
            // Extract inputs for this timestep
            let step_inputs = inputs.slice(s![.., t, ..]).to_owned();

            // Predict for all batch items
            let step_outputs = self.predict_batch(&step_inputs)?;

            // Store outputs
            outputs.slice_mut(s![.., t, ..]).assign(&step_outputs);
        }

        Ok(outputs)
    }

    /// Reset states for specific batch items
    ///
    /// # Arguments
    ///
    /// * `indices` - Indices of batch items to reset
    pub fn reset_batch_items(&mut self, indices: &[usize]) -> ModelResult<()> {
        // Reset model and get fresh initial states
        self.model.reset();
        let template_states = self.model.get_states();

        for &idx in indices {
            if idx >= self.batch_size {
                return Err(ModelError::invalid_config(format!(
                    "batch index {} out of range for batch_size {}",
                    idx, self.batch_size
                )));
            }

            // Reset state for this batch item
            self.batch_states[idx] = template_states.clone();
            self.sequence_lengths[idx] = 0;
        }

        Ok(())
    }

    /// Reset all batch states
    pub fn reset_all(&mut self) {
        // Reset model and get fresh initial states
        self.model.reset();
        let template_states = self.model.get_states();

        self.batch_states = (0..self.batch_size)
            .map(|_| template_states.clone())
            .collect();

        self.sequence_lengths = vec![0; self.batch_size];
        self.max_length = 0;
    }

    /// Get sequence lengths for all batch items
    pub fn sequence_lengths(&self) -> &[usize] {
        &self.sequence_lengths
    }

    /// Get maximum sequence length in the batch
    pub fn max_sequence_length(&self) -> usize {
        self.max_length
    }

    /// Get states for a specific batch item
    pub fn get_batch_item_states(&self, batch_idx: usize) -> ModelResult<&Vec<HiddenState>> {
        if batch_idx >= self.batch_size {
            return Err(ModelError::invalid_config(format!(
                "batch index {} out of range for batch_size {}",
                batch_idx, self.batch_size
            )));
        }
        Ok(&self.batch_states[batch_idx])
    }

    /// Set states for a specific batch item
    pub fn set_batch_item_states(
        &mut self,
        batch_idx: usize,
        states: Vec<HiddenState>,
    ) -> ModelResult<()> {
        if batch_idx >= self.batch_size {
            return Err(ModelError::invalid_config(format!(
                "batch index {} out of range for batch_size {}",
                batch_idx, self.batch_size
            )));
        }

        if states.len() != self.model.num_layers() {
            return Err(ModelError::invalid_config(format!(
                "expected {} layer states, got {}",
                self.model.num_layers(),
                states.len()
            )));
        }

        self.batch_states[batch_idx] = states;
        Ok(())
    }

    /// Get reference to underlying model
    pub fn model(&self) -> &M {
        &self.model
    }

    /// Get mutable reference to underlying model
    pub fn model_mut(&mut self) -> &mut M {
        &mut self.model
    }
}

/// Dynamic batching strategy
///
/// Automatically adjusts batch size based on memory constraints
/// and computational efficiency
pub struct DynamicBatcher<M: AutoregressiveModel> {
    /// Base model
    #[allow(dead_code)]
    model: M,
    /// Minimum batch size
    min_batch_size: usize,
    /// Maximum batch size
    max_batch_size: usize,
    /// Current optimal batch size
    current_batch_size: usize,
    /// Target latency in microseconds
    target_latency_us: u64,
}

impl<M: AutoregressiveModel> DynamicBatcher<M> {
    /// Create a new dynamic batcher
    ///
    /// # Arguments
    ///
    /// * `model` - The underlying model
    /// * `min_batch_size` - Minimum batch size
    /// * `max_batch_size` - Maximum batch size
    /// * `target_latency_us` - Target latency per batch in microseconds
    pub fn new(
        model: M,
        min_batch_size: usize,
        max_batch_size: usize,
        target_latency_us: u64,
    ) -> ModelResult<Self> {
        if min_batch_size == 0 {
            return Err(ModelError::invalid_config("min_batch_size must be > 0"));
        }
        if max_batch_size < min_batch_size {
            return Err(ModelError::invalid_config(
                "max_batch_size must be >= min_batch_size",
            ));
        }

        Ok(Self {
            model,
            min_batch_size,
            max_batch_size,
            current_batch_size: min_batch_size,
            target_latency_us,
        })
    }

    /// Get current optimal batch size
    pub fn current_batch_size(&self) -> usize {
        self.current_batch_size
    }

    /// Update batch size based on observed latency
    ///
    /// # Arguments
    ///
    /// * `observed_latency_us` - Observed latency for last batch
    pub fn update_batch_size(&mut self, observed_latency_us: u64) {
        // Simple adaptive strategy
        if observed_latency_us < self.target_latency_us {
            // We have headroom, can increase batch size
            self.current_batch_size = (self.current_batch_size + 1).min(self.max_batch_size);
        } else if observed_latency_us > self.target_latency_us * 2 {
            // Too slow, decrease batch size
            self.current_batch_size = (self.current_batch_size - 1).max(self.min_batch_size);
        }
        // Otherwise keep current batch size
    }

    /// Reset to minimum batch size
    pub fn reset(&mut self) {
        self.current_batch_size = self.min_batch_size;
    }
}

/// Batch padding utilities
pub mod padding {
    use super::*;

    /// Pad batch to maximum length
    ///
    /// # Arguments
    ///
    /// * `sequences` - Variable-length sequences
    /// * `pad_value` - Value to use for padding
    ///
    /// # Returns
    ///
    /// Padded array [batch_size, max_len, features] and original lengths
    pub fn pad_sequences(sequences: &[Array2<f32>], pad_value: f32) -> (Array3<f32>, Vec<usize>) {
        if sequences.is_empty() {
            return (Array3::zeros((0, 0, 0)), vec![]);
        }

        let batch_size = sequences.len();
        let max_len = sequences.iter().map(|s| s.nrows()).max().unwrap_or(0);
        let feature_dim = sequences[0].ncols();

        let mut padded = Array3::from_elem((batch_size, max_len, feature_dim), pad_value);
        let mut lengths = Vec::with_capacity(batch_size);

        for (batch_idx, seq) in sequences.iter().enumerate() {
            let seq_len = seq.nrows();
            lengths.push(seq_len);

            for t in 0..seq_len {
                for f in 0..feature_dim {
                    padded[[batch_idx, t, f]] = seq[[t, f]];
                }
            }
        }

        (padded, lengths)
    }

    /// Remove padding from batch
    ///
    /// # Arguments
    ///
    /// * `padded` - Padded sequences [batch_size, max_len, features]
    /// * `lengths` - Original sequence lengths
    ///
    /// # Returns
    ///
    /// Variable-length sequences without padding
    pub fn unpad_sequences(padded: &Array3<f32>, lengths: &[usize]) -> Vec<Array2<f32>> {
        let (batch_size, _, feature_dim) = padded.dim();
        assert_eq!(batch_size, lengths.len());

        lengths
            .iter()
            .enumerate()
            .map(|(batch_idx, &seq_len)| {
                let mut seq = Array2::zeros((seq_len, feature_dim));
                for t in 0..seq_len {
                    for f in 0..feature_dim {
                        seq[[t, f]] = padded[[batch_idx, t, f]];
                    }
                }
                seq
            })
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::mamba::{Mamba, MambaConfig};

    #[test]
    fn test_batched_model_creation() {
        let config = MambaConfig::default().hidden_dim(64).num_layers(2);
        let model = Mamba::new(config).expect("Failed to create Mamba model");
        let batched = BatchedModel::new(model, 4);
        assert!(batched.is_ok());

        let batched = batched.expect("Failed to create batched model");
        assert_eq!(batched.batch_size(), 4);
    }

    #[test]
    fn test_batch_prediction() {
        let config = MambaConfig::default().hidden_dim(64).num_layers(2);
        let model = Mamba::new(config).expect("Failed to create Mamba model");
        let mut batched = BatchedModel::new(model, 4).expect("Failed to create batched model");

        let inputs = Array2::zeros((4, 1));
        let outputs = batched.predict_batch(&inputs);
        assert!(outputs.is_ok());

        let outputs = outputs.expect("Failed to predict batch");
        assert_eq!(outputs.dim(), (4, 64));
    }

    #[test]
    fn test_sequence_batch_prediction() {
        let config = MambaConfig::default().hidden_dim(64).num_layers(2);
        let model = Mamba::new(config).expect("Failed to create Mamba model");
        let mut batched = BatchedModel::new(model, 2).expect("Failed to create batched model");

        let inputs = Array3::zeros((2, 10, 1));
        let outputs = batched.predict_sequence_batch(&inputs);
        assert!(outputs.is_ok());

        let outputs = outputs.expect("Failed to predict sequence batch");
        assert_eq!(outputs.dim(), (2, 10, 64));
    }

    #[test]
    fn test_batch_reset() {
        let config = MambaConfig::default().hidden_dim(64).num_layers(2);
        let model = Mamba::new(config).expect("Failed to create Mamba model");
        let mut batched = BatchedModel::new(model, 4).expect("Failed to create batched model");

        // Process some inputs
        let inputs = Array2::zeros((4, 1));
        let _ = batched
            .predict_batch(&inputs)
            .expect("Failed to predict batch");

        // Reset specific items
        batched
            .reset_batch_items(&[0, 2])
            .expect("Failed to reset batch items");
        assert_eq!(batched.sequence_lengths()[0], 0);
        assert_eq!(batched.sequence_lengths()[1], 1);
        assert_eq!(batched.sequence_lengths()[2], 0);
        assert_eq!(batched.sequence_lengths()[3], 1);

        // Reset all
        batched.reset_all();
        assert!(batched.sequence_lengths().iter().all(|&len| len == 0));
    }

    #[test]
    fn test_padding() {
        let seq1 = Array2::from_shape_vec((3, 2), vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0])
            .expect("Failed to create test array");
        let seq2 = Array2::from_shape_vec(
            (5, 2),
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0],
        )
        .expect("Failed to create test array");
        let seq3 = Array2::from_shape_vec((2, 2), vec![1.0, 2.0, 3.0, 4.0])
            .expect("Failed to create test array");

        let sequences = vec![seq1, seq2, seq3];
        let (padded, lengths) = padding::pad_sequences(&sequences, 0.0);

        assert_eq!(padded.dim(), (3, 5, 2));
        assert_eq!(lengths, vec![3, 5, 2]);

        // Verify unpadding
        let unpadded = padding::unpad_sequences(&padded, &lengths);
        assert_eq!(unpadded.len(), 3);
        assert_eq!(unpadded[0].dim(), (3, 2));
        assert_eq!(unpadded[1].dim(), (5, 2));
        assert_eq!(unpadded[2].dim(), (2, 2));
    }

    #[test]
    fn test_dynamic_batcher() {
        let config = MambaConfig::default();
        let model = Mamba::new(config).expect("Failed to create Mamba model");
        let mut batcher =
            DynamicBatcher::new(model, 1, 16, 1000).expect("Failed to create dynamic batcher");

        assert_eq!(batcher.current_batch_size(), 1);

        // Simulate fast execution
        batcher.update_batch_size(500);
        assert_eq!(batcher.current_batch_size(), 2);

        // Simulate slow execution
        batcher.update_batch_size(3000);
        assert_eq!(batcher.current_batch_size(), 1);
    }
}