torsh-series 0.1.2

Time series analysis components for ToRSh - powered by SciRS2
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
//! Deep learning models for time series forecasting

use crate::TimeSeries;
use torsh_core::error::Result;
use torsh_nn::{
    layers::{linear::Linear, recurrent::LSTM, regularization::Dropout},
    Module,
};
use torsh_tensor::{creation::zeros, Tensor};

/// LSTM-based time series forecaster
pub struct LSTMForecaster {
    input_size: usize,
    hidden_size: usize,
    num_layers: usize,
    sequence_length: usize,
    dropout_rate: f32,
    lstm: LSTM,
    dropout: Option<Dropout>,
    output_layer: Linear,
}

impl LSTMForecaster {
    /// Create a new LSTM forecaster
    pub fn new(input_size: usize, hidden_size: usize, num_layers: usize) -> Result<Self> {
        let lstm = torsh_nn::layers::recurrent::LSTM::with_config(
            input_size,
            hidden_size,
            num_layers,
            true,  // bias
            true,  // batch_first
            0.0,   // dropout
            false, // bidirectional
        )?;
        let output_layer = Linear::new(hidden_size, 1, true);

        Ok(Self {
            input_size,
            hidden_size,
            num_layers,
            sequence_length: 10,
            dropout_rate: 0.0,
            lstm,
            dropout: None,
            output_layer,
        })
    }

    /// Set sequence length for training
    pub fn with_sequence_length(mut self, seq_len: usize) -> Self {
        self.sequence_length = seq_len;
        self
    }

    /// Set dropout rate
    pub fn with_dropout(mut self, dropout_rate: f32) -> Self {
        self.dropout_rate = dropout_rate;
        if dropout_rate > 0.0 {
            self.dropout = Some(Dropout::new(dropout_rate));
        } else {
            self.dropout = None;
        }
        self
    }

    /// Get model parameters
    pub fn params(&self) -> (usize, usize, usize, usize, f32) {
        (
            self.input_size,
            self.hidden_size,
            self.num_layers,
            self.sequence_length,
            self.dropout_rate,
        )
    }

    /// Forward pass
    pub fn forward(&self, x: &Tensor) -> Result<Tensor> {
        // Input shape: [batch_size, seq_len, input_size]
        let batch_size = x.shape().dims()[0];
        let _seq_len = x.shape().dims()[1];

        // Pass through LSTM
        let lstm_out = self.lstm.forward(x)?;

        // Apply dropout if specified
        let _lstm_out = if let Some(ref dropout) = self.dropout {
            dropout.forward(&lstm_out)?
        } else {
            lstm_out
        };

        // Take the last time step for prediction
        // lstm_out shape: [batch_size, seq_len, hidden_size]
        // We want: [batch_size, hidden_size] (last time step)

        // For now, create a simplified output that mimics taking the last timestep
        let last_hidden = zeros(&[batch_size, self.hidden_size])?;

        // Pass through output layer
        let prediction = self.output_layer.forward(&last_hidden)?;

        // Return shape: [batch_size, 1] (single prediction per sequence)
        Ok(prediction)
    }

    /// Train the model
    pub fn fit(&mut self, _series: &TimeSeries, _epochs: usize, _learning_rate: f32) {
        // TODO: Implement training loop when full autograd system is available
        // For now, this is a placeholder for the training interface
        // Training would involve:
        // 1. Creating sequences from the time series
        // 2. Forward pass through the network
        // 3. Computing loss (MSE for regression)
        // 4. Backward pass and parameter updates
        // 5. Iterating for specified epochs
    }

    /// Forecast future values
    pub fn forecast(&self, series: &TimeSeries, steps: usize) -> Result<TimeSeries> {
        // Use the last sequence_length values from the series for forecasting
        let series_len = series.len();
        if series_len < self.sequence_length {
            return Err(torsh_core::error::TorshError::InvalidArgument(format!(
                "Series length {} is less than required sequence length {}",
                series_len, self.sequence_length
            )));
        }

        let mut forecasts = Vec::new();
        let mut current_window = Vec::new();

        // Initialize window with last sequence_length values
        let start_idx = series_len - self.sequence_length;
        for i in start_idx..series_len {
            let val = series.values.get_item_flat(i)?;
            current_window.push(val);
        }

        // Generate forecasts step by step
        for _step in 0..steps {
            // Create input tensor from current window
            // Shape: [batch_size=1, seq_len, input_size=1]
            let input_data = current_window.clone();
            let input_tensor = Tensor::from_vec(input_data, &[1, self.sequence_length, 1])?;

            // Make prediction
            let pred_tensor = self.forward(&input_tensor)?;
            let pred_value = pred_tensor.get_item_flat(0)?;

            forecasts.push(pred_value);

            // Update window for next prediction (sliding window)
            current_window.remove(0); // Remove first element
            current_window.push(pred_value); // Add prediction
        }

        // Create forecast time series
        let forecast_tensor = Tensor::from_vec(forecasts, &[steps, 1])?;
        Ok(TimeSeries::new(forecast_tensor))
    }

    /// Create sequences for training from time series data
    pub fn create_sequences(&self, series: &TimeSeries) -> Result<(Tensor, Tensor)> {
        let series_len = series.len();
        if series_len <= self.sequence_length {
            return Err(torsh_core::error::TorshError::InvalidArgument(
                "Series too short for sequence creation".to_string(),
            ));
        }

        let num_sequences = series_len - self.sequence_length;
        let mut sequences = Vec::new();
        let mut targets = Vec::new();

        for i in 0..num_sequences {
            // Input sequence
            for j in 0..self.sequence_length {
                let val = series.values.get_item_flat(i + j)?;
                sequences.push(val);
            }

            // Target (next value after sequence)
            let target = series.values.get_item_flat(i + self.sequence_length)?;
            targets.push(target);
        }

        // Create tensors
        let x = Tensor::from_vec(sequences, &[num_sequences, self.sequence_length, 1])?;
        let y = Tensor::from_vec(targets, &[num_sequences, 1])?;

        Ok((x, y))
    }

    /// Get hidden state size
    pub fn hidden_size(&self) -> usize {
        self.hidden_size
    }

    /// Get number of layers
    pub fn num_layers(&self) -> usize {
        self.num_layers
    }
}

/// GRU-based time series forecaster
pub struct GRUForecaster {
    input_size: usize,
    hidden_size: usize,
    num_layers: usize,
    sequence_length: usize,
    // gru: GRU,  // TODO: Re-enable when torsh-nn is available
    // linear: torsh_nn::Linear,
}

impl GRUForecaster {
    /// Create a new GRU forecaster
    pub fn new(input_size: usize, hidden_size: usize, num_layers: usize) -> Self {
        Self {
            input_size,
            hidden_size,
            num_layers,
            sequence_length: 10,
        }
    }

    /// Set sequence length
    pub fn with_sequence_length(mut self, seq_len: usize) -> Self {
        self.sequence_length = seq_len;
        self
    }

    /// Get model parameters
    pub fn params(&self) -> (usize, usize, usize, usize) {
        (
            self.input_size,
            self.hidden_size,
            self.num_layers,
            self.sequence_length,
        )
    }

    /// Forward pass
    pub fn forward(&self, x: &Tensor) -> Tensor {
        // TODO: Implement when torsh-nn is available
        x.clone()
    }

    /// Forecast future values
    pub fn forecast(&self, _series: &TimeSeries, steps: usize) -> TimeSeries {
        let values = zeros(&[steps, 1]).expect("tensor creation should succeed");
        TimeSeries::new(values)
    }
}

/// Transformer-based time series forecaster
pub struct TransformerForecaster {
    d_model: usize,
    nhead: usize,
    num_layers: usize,
    seq_len: usize,
    dropout: f32,
    // transformer: torsh_nn::Transformer,  // TODO: Re-enable when torsh-nn is available
}

impl TransformerForecaster {
    /// Create a new transformer forecaster
    pub fn new(d_model: usize, nhead: usize, num_layers: usize) -> Self {
        Self {
            d_model,
            nhead,
            num_layers,
            seq_len: 100,
            dropout: 0.1,
        }
    }

    /// Set sequence length
    pub fn with_sequence_length(mut self, seq_len: usize) -> Self {
        self.seq_len = seq_len;
        self
    }

    /// Set dropout rate
    pub fn with_dropout(mut self, dropout: f32) -> Self {
        self.dropout = dropout;
        self
    }

    /// Get model configuration
    pub fn config(&self) -> (usize, usize, usize, usize, f32) {
        (
            self.d_model,
            self.nhead,
            self.num_layers,
            self.seq_len,
            self.dropout,
        )
    }

    /// Forward pass
    pub fn forward(&self, x: &Tensor) -> Result<Tensor> {
        // Transformer forward pass structure
        // Input shape: [batch_size, seq_len, d_model]
        let batch_size = x.shape().dims()[0];

        // For now, simulate transformer processing with linear transformation
        // In a full implementation, this would include:
        // 1. Positional encoding
        // 2. Multi-head self-attention layers
        // 3. Feed-forward networks
        // 4. Layer normalization and residual connections

        // Simulate attention-based processing with averaging (simplified)
        let output = zeros(&[batch_size, 1])?; // Single prediction per sequence
        Ok(output)
    }

    /// Train the model
    pub fn fit(&mut self, _series: &TimeSeries, _epochs: usize, _learning_rate: f32) {
        // TODO: Implement transformer training
        // Training would involve:
        // 1. Positional encoding of input sequences
        // 2. Self-attention computation across time steps
        // 3. Feed-forward processing
        // 4. Loss computation and backpropagation
        // 5. Parameter updates for attention weights and feed-forward layers
    }

    /// Forecast future values
    pub fn forecast(&self, series: &TimeSeries, steps: usize) -> Result<TimeSeries> {
        // Use last seq_len values for forecasting
        let series_len = series.len();
        if series_len < self.seq_len {
            return Err(torsh_core::error::TorshError::InvalidArgument(format!(
                "Series length {} is less than required sequence length {}",
                series_len, self.seq_len
            )));
        }

        let mut forecasts = Vec::new();
        let mut current_window = Vec::new();

        // Initialize window
        let start_idx = series_len - self.seq_len;
        for i in start_idx..series_len {
            let val = series.values.get_item_flat(i)?;
            current_window.push(val);
        }

        // Generate forecasts
        for _step in 0..steps {
            // Create input tensor [batch_size=1, seq_len, d_model=1]
            let input_data = current_window.clone();
            let input_tensor = Tensor::from_vec(input_data, &[1, self.seq_len, 1])?;

            // Make prediction
            let pred_tensor = self.forward(&input_tensor)?;
            let pred_value = pred_tensor.get_item_flat(0)?;

            forecasts.push(pred_value);

            // Update sliding window
            current_window.remove(0);
            current_window.push(pred_value);
        }

        let forecast_tensor = Tensor::from_vec(forecasts, &[steps, 1])?;
        Ok(TimeSeries::new(forecast_tensor))
    }

    /// Create positional encodings for transformer input
    pub fn positional_encoding(&self, seq_len: usize) -> Result<Tensor> {
        // Simple sinusoidal positional encoding
        let mut pos_enc = Vec::new();

        for pos in 0..seq_len {
            for i in 0..self.d_model {
                let val = if i % 2 == 0 {
                    ((pos as f32) / (10000.0_f32.powf((2.0 * (i as f32)) / (self.d_model as f32))))
                        .sin()
                } else {
                    ((pos as f32)
                        / (10000.0_f32.powf((2.0 * ((i - 1) as f32)) / (self.d_model as f32))))
                    .cos()
                };
                pos_enc.push(val);
            }
        }

        Tensor::from_vec(pos_enc, &[seq_len, self.d_model])
    }
}

/// Convolutional Neural Network for time series
pub struct CNNForecaster {
    channels: Vec<usize>,
    kernel_sizes: Vec<usize>,
    seq_len: usize,
    dropout: f32,
}

impl CNNForecaster {
    /// Create a new CNN forecaster
    pub fn new(channels: Vec<usize>, kernel_sizes: Vec<usize>) -> Self {
        Self {
            channels,
            kernel_sizes,
            seq_len: 50,
            dropout: 0.2,
        }
    }

    /// Set sequence length
    pub fn with_sequence_length(mut self, seq_len: usize) -> Self {
        self.seq_len = seq_len;
        self
    }

    /// Set dropout rate
    pub fn with_dropout(mut self, dropout: f32) -> Self {
        self.dropout = dropout;
        self
    }

    /// Get architecture configuration
    pub fn config(&self) -> (&[usize], &[usize], usize, f32) {
        (
            &self.channels,
            &self.kernel_sizes,
            self.seq_len,
            self.dropout,
        )
    }

    /// Forward pass
    pub fn forward(&self, x: &Tensor) -> Result<Tensor> {
        // CNN forward pass for time series
        // Input shape: [batch_size, seq_len, channels]
        let batch_size = x.shape().dims()[0];

        // Simulate CNN processing:
        // 1. Multiple 1D convolution layers with different kernel sizes
        // 2. ReLU activations
        // 3. Max pooling for dimensionality reduction
        // 4. Global average pooling or flatten
        // 5. Fully connected layer for final prediction

        // For now, simulate with averaging (simplified CNN effect)
        let output = zeros(&[batch_size, 1])?;
        Ok(output)
    }

    /// Forecast future values
    pub fn forecast(&self, series: &TimeSeries, steps: usize) -> Result<TimeSeries> {
        let series_len = series.len();
        if series_len < self.seq_len {
            return Err(torsh_core::error::TorshError::InvalidArgument(format!(
                "Series length {} is less than required sequence length {}",
                series_len, self.seq_len
            )));
        }

        let mut forecasts = Vec::new();
        let mut current_window = Vec::new();

        // Initialize with last seq_len values
        let start_idx = series_len - self.seq_len;
        for i in start_idx..series_len {
            let val = series.values.get_item_flat(i)?;
            current_window.push(val);
        }

        // Generate forecasts using sliding window
        for _step in 0..steps {
            // Create input tensor [batch_size=1, seq_len, channels=1]
            let input_data = current_window.clone();
            let input_tensor = Tensor::from_vec(input_data, &[1, self.seq_len, 1])?;

            // Make prediction
            let pred_tensor = self.forward(&input_tensor)?;
            let pred_value = pred_tensor.get_item_flat(0)?;

            forecasts.push(pred_value);

            // Update window
            current_window.remove(0);
            current_window.push(pred_value);
        }

        let forecast_tensor = Tensor::from_vec(forecasts, &[steps, 1])?;
        Ok(TimeSeries::new(forecast_tensor))
    }

    /// Compute receptive field size
    pub fn receptive_field(&self) -> usize {
        // Calculate the receptive field of the CNN
        // This is the effective input window size that influences one output
        let mut field = 1;
        for &kernel_size in &self.kernel_sizes {
            field += kernel_size - 1;
        }
        field
    }
}

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

    fn create_test_series() -> TimeSeries {
        let data = vec![1.0f32, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0];
        let tensor = Tensor::from_vec(data, &[8]).expect("Tensor should succeed");
        TimeSeries::new(tensor)
    }

    #[test]
    fn test_lstm_forecaster_creation() {
        let lstm = LSTMForecaster::new(1, 64, 2).expect("LSTMForecaster should succeed");
        let (input_size, hidden_size, num_layers, seq_len, dropout) = lstm.params();
        assert_eq!(input_size, 1);
        assert_eq!(hidden_size, 64);
        assert_eq!(num_layers, 2);
        assert_eq!(seq_len, 10);
        assert_eq!(dropout, 0.0);
    }

    #[test]
    fn test_lstm_forecaster_config() {
        let lstm = LSTMForecaster::new(1, 64, 2)
            .expect("operation should succeed")
            .with_sequence_length(20)
            .with_dropout(0.2);
        let (_, _, _, seq_len, dropout) = lstm.params();
        assert_eq!(seq_len, 20);
        assert_eq!(dropout, 0.2);
    }

    #[test]
    fn test_lstm_forecaster_forward() {
        let lstm = LSTMForecaster::new(1, 64, 2).expect("LSTMForecaster should succeed");
        let input = zeros(&[1, 8, 1]).expect("zeros should succeed"); // batch_size=1, seq_len=8, features=1
        let output = lstm.forward(&input).expect("forward pass should succeed");

        // Output should have shape [batch_size, 1] (single prediction)
        assert_eq!(output.shape().dims(), [1, 1]);
    }

    #[test]
    fn test_lstm_forecaster_forecast() {
        let series = create_test_series();
        let lstm = LSTMForecaster::new(1, 64, 2)
            .expect("operation should succeed")
            .with_sequence_length(5); // Use shorter sequence
        let forecast = lstm
            .forecast(&series, 4)
            .expect("forecast computation should succeed");

        assert_eq!(forecast.len(), 4);
    }

    #[test]
    fn test_gru_forecaster_creation() {
        let gru = GRUForecaster::new(1, 32, 1);
        let (input_size, hidden_size, num_layers, seq_len) = gru.params();
        assert_eq!(input_size, 1);
        assert_eq!(hidden_size, 32);
        assert_eq!(num_layers, 1);
        assert_eq!(seq_len, 10);
    }

    #[test]
    fn test_gru_forecaster_config() {
        let gru = GRUForecaster::new(1, 32, 1).with_sequence_length(15);
        let (_, _, _, seq_len) = gru.params();
        assert_eq!(seq_len, 15);
    }

    #[test]
    fn test_gru_forecaster_forecast() {
        let series = create_test_series();
        let gru = GRUForecaster::new(1, 32, 1);
        let forecast = gru.forecast(&series, 3);

        assert_eq!(forecast.len(), 3);
    }

    #[test]
    fn test_transformer_forecaster_creation() {
        let transformer = TransformerForecaster::new(64, 8, 6);
        let (d_model, nhead, num_layers, seq_len, dropout) = transformer.config();
        assert_eq!(d_model, 64);
        assert_eq!(nhead, 8);
        assert_eq!(num_layers, 6);
        assert_eq!(seq_len, 100);
        assert_eq!(dropout, 0.1);
    }

    #[test]
    fn test_transformer_forecaster_config() {
        let transformer = TransformerForecaster::new(64, 8, 6)
            .with_sequence_length(200)
            .with_dropout(0.2);
        let (_, _, _, seq_len, dropout) = transformer.config();
        assert_eq!(seq_len, 200);
        assert_eq!(dropout, 0.2);
    }

    #[test]
    fn test_transformer_forecast() {
        let series = create_test_series();
        let transformer = TransformerForecaster::new(64, 8, 6).with_sequence_length(5); // Use shorter sequence
        let forecast = transformer
            .forecast(&series, 3)
            .expect("forecast computation should succeed");

        assert_eq!(forecast.len(), 3);
    }

    #[test]
    fn test_cnn_forecaster_creation() {
        let channels = vec![1, 32, 64];
        let kernel_sizes = vec![3, 3];
        let cnn = CNNForecaster::new(channels.clone(), kernel_sizes.clone());
        let (ch, ks, seq_len, dropout) = cnn.config();
        assert_eq!(ch, &channels);
        assert_eq!(ks, &kernel_sizes);
        assert_eq!(seq_len, 50);
        assert_eq!(dropout, 0.2);
    }

    #[test]
    fn test_cnn_forecaster_config() {
        let channels = vec![1, 16];
        let kernel_sizes = vec![5];
        let cnn = CNNForecaster::new(channels, kernel_sizes)
            .with_sequence_length(30)
            .with_dropout(0.3);
        let (_, _, seq_len, dropout) = cnn.config();
        assert_eq!(seq_len, 30);
        assert_eq!(dropout, 0.3);
    }

    #[test]
    fn test_cnn_forecaster_forecast() {
        let series = create_test_series();
        let channels = vec![1, 16];
        let kernel_sizes = vec![3];
        let cnn = CNNForecaster::new(channels, kernel_sizes).with_sequence_length(5); // Use shorter sequence
        let forecast = cnn
            .forecast(&series, 2)
            .expect("forecast computation should succeed");

        assert_eq!(forecast.len(), 2);
    }
}