rustorch 0.6.29

Production-ready PyTorch-compatible deep learning library in Rust with special mathematical functions (gamma, Bessel, error functions), statistical distributions, Fourier transforms (FFT/RFFT), matrix decomposition (SVD/QR/LU/eigenvalue), automatic differentiation, neural networks, computer vision transforms, complete GPU acceleration (CUDA/Metal/OpenCL), SIMD optimizations, parallel processing, WebAssembly browser support, comprehensive distributed learning support, and performance validation
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
//! Advanced Optimizer Tests
//! 高度なオプティマイザーテスト
//!
//! Comprehensive tests for LAMB, AdaBound, and L-BFGS optimizers

use rustorch::optim::{AdaBound, LineSearchMethod, Optimizer, LAMB, LBFGS};
use rustorch::tensor::Tensor;
use std::collections::HashMap;

#[test]
fn test_lamb_basic_functionality() {
    let mut optimizer = LAMB::new(0.01);
    let param = Tensor::<f32>::ones(&[4, 4]);
    let grad = Tensor::<f32>::ones(&[4, 4]) * 0.1;

    let initial_data = param.data.as_slice().unwrap().to_vec();

    // Perform optimization step
    optimizer.step(&param, &grad);

    let updated_data = param.data.as_slice().unwrap();

    // Verify parameters were updated
    assert_ne!(initial_data[0], updated_data[0]);
    assert_eq!(optimizer.step_count(), 1);
}

#[test]
fn test_lamb_large_batch_adaptation() {
    let mut optimizer = LAMB::with_params(0.01, 0.9, 0.999, 1e-6, 0.01);
    let param = Tensor::<f32>::ones(&[8, 8]);
    let grad = Tensor::<f32>::ones(&[8, 8]) * 0.2;

    // Simulate multiple steps for large batch training
    for i in 0..10 {
        let step_grad = &grad * (1.0 + i as f32 * 0.1);
        optimizer.step(&param, &step_grad);
    }

    assert_eq!(optimizer.step_count(), 10);

    // Test state persistence
    let state = optimizer.state_dict();
    assert_eq!(state["step_count"], 10.0);
    assert_eq!(state["learning_rate"], 0.01);
}

#[test]
fn test_lamb_without_bias_correction() {
    let mut optimizer = LAMB::without_bias_correction(0.05, 0.8, 0.95, 1e-5, 0.02);
    let param = Tensor::<f32>::zeros(&[3, 3]);
    let grad = Tensor::<f32>::ones(&[3, 3]) * 0.05;

    optimizer.step(&param, &grad);

    // Verify it works without bias correction
    assert_eq!(optimizer.step_count(), 1);

    // Test setting bias correction
    optimizer.set_bias_correction(true);
    optimizer.step(&param, &grad);

    assert_eq!(optimizer.step_count(), 2);
}

#[test]
fn test_adabound_basic_functionality() {
    let mut optimizer = AdaBound::new(0.01);
    let param = Tensor::<f32>::ones(&[5, 5]);
    let grad = Tensor::<f32>::ones(&[5, 5]) * 0.1;

    let initial_data = param.data.as_slice().unwrap().to_vec();

    // Perform optimization step
    optimizer.step(&param, &grad);

    let updated_data = param.data.as_slice().unwrap();

    // Verify parameters were updated
    assert_ne!(initial_data[0], updated_data[0]);
    assert_eq!(optimizer.step_count(), 1);
}

#[test]
fn test_adabound_convergence_behavior() {
    let mut optimizer = AdaBound::with_params(0.1, 0.05, 0.9, 0.999, 1e-8, 0.01, 1e-3);
    let param = Tensor::<f32>::ones(&[2, 2]) * 2.0;
    let grad = Tensor::<f32>::ones(&[2, 2]) * 0.2;

    let initial_data = param.data.as_slice().unwrap().to_vec();

    // Perform multiple steps to test convergence behavior
    for _ in 0..20 {
        optimizer.step(&param, &grad);
    }

    // Verify optimization occurred
    let final_data = param.data.as_slice().unwrap();
    assert_ne!(initial_data[0], final_data[0]);
    assert_eq!(optimizer.step_count(), 20);

    // Test that the optimizer is still functional after many steps
    let pre_step_data = param.data.as_slice().unwrap().to_vec();
    optimizer.step(&param, &grad);
    let post_step_data = param.data.as_slice().unwrap();
    assert_ne!(pre_step_data[0], post_step_data[0]);
}

#[test]
fn test_adabound_parameter_customization() {
    let mut optimizer = AdaBound::with_params(0.02, 0.08, 0.85, 0.95, 1e-6, 0.05, 2e-3);

    // Test parameter setting
    optimizer.set_final_lr(0.04);
    optimizer.set_gamma(1e-3);

    let param = Tensor::<f32>::ones(&[3, 3]);
    let grad = Tensor::<f32>::ones(&[3, 3]) * 0.1;

    optimizer.step(&param, &grad);

    // Verify state dictionary
    let state = optimizer.state_dict();
    assert_eq!(state["learning_rate"], 0.02);
    assert_eq!(state["final_lr"], 0.04);
    assert_eq!(state["gamma"], 1e-3);
}

#[test]
fn test_lbfgs_basic_functionality() {
    let mut optimizer = LBFGS::new(0.1).unwrap();
    let param = Tensor::<f32>::ones(&[3, 3]);
    let grad = Tensor::<f32>::ones(&[3, 3]) * 0.1;

    let initial_data = param.data.as_slice().unwrap().to_vec();

    // First step (steepest descent)
    optimizer.step(&param, &grad);

    let updated_data = param.data.as_slice().unwrap();

    // Verify parameters were updated
    assert_ne!(initial_data[0], updated_data[0]);
    // Note: LBFGS doesn't expose step_count() method, so we verify functionality differently
    let state = optimizer.state_dict();
    assert_eq!(state["step_count"], 1.0);
}

#[test]
fn test_lbfgs_memory_building() {
    let mut optimizer =
        LBFGS::with_params(0.1, 20, 20, 1e-5, 1e-9, 5, LineSearchMethod::None).unwrap();
    let param = Tensor::<f32>::ones(&[4, 4]) * 3.0;

    // Perform multiple steps to build L-BFGS memory
    for i in 0..8 {
        let grad = Tensor::<f32>::ones(&[4, 4]) * (0.1 * (i + 1) as f32);
        optimizer.step(&param, &grad);
    }

    // Verify steps through state dictionary
    let state = optimizer.state_dict();
    assert_eq!(state["step_count"], 8.0);

    // Memory should be limited to history_size (5)
    // This is tested internally in the implementation

    // Verify other state dictionary fields
    assert!(state.contains_key("max_iter"));
}

#[test]
fn test_lbfgs_convergence_detection() {
    let mut optimizer = LBFGS::new(0.1).unwrap();
    optimizer.set_tolerance_grad(1e-2).unwrap();

    let param = Tensor::<f32>::ones(&[2, 2]);
    let small_grad = Tensor::<f32>::ones(&[2, 2]) * 1e-4; // Below tolerance

    let initial_param = param.clone();

    // Should detect convergence and not update
    optimizer.step(&param, &small_grad);

    let final_data = param.data.as_slice().unwrap();
    let initial_data = initial_param.data.as_slice().unwrap();

    // Parameters should remain unchanged due to convergence
    for (final_val, initial_val) in final_data.iter().zip(initial_data.iter()) {
        assert!((final_val - initial_val).abs() < 1e-6);
    }
}

#[test]
fn test_lbfgs_line_search_methods() {
    let optimizers = vec![
        LBFGS::with_params(0.1, 20, 20, 1e-5, 1e-9, 5, LineSearchMethod::None).unwrap(),
        LBFGS::with_params(
            0.1,
            20,
            20,
            1e-5,
            1e-9,
            5,
            LineSearchMethod::Backtracking { c1: 1e-4, rho: 0.5 },
        )
        .unwrap(),
        LBFGS::with_params(
            0.1,
            20,
            20,
            1e-5,
            1e-9,
            5,
            LineSearchMethod::StrongWolfe { c1: 1e-4, c2: 0.9 },
        )
        .unwrap(),
    ];

    for mut optimizer in optimizers {
        let param = Tensor::<f32>::ones(&[3, 3]);
        let grad = Tensor::<f32>::ones(&[3, 3]) * 0.05;

        let initial_data = param.data.as_slice().unwrap().to_vec();

        optimizer.step(&param, &grad);

        let updated_data = param.data.as_slice().unwrap();

        // All line search methods should work
        assert_ne!(initial_data[0], updated_data[0]);
        let state = optimizer.state_dict();
        assert_eq!(state["step_count"], 1.0);
    }
}

#[test]
fn test_all_optimizers_state_management() {
    let mut lamb = LAMB::new(0.01);
    let mut adabound = AdaBound::new(0.01);
    let mut lbfgs = LBFGS::new(0.1).unwrap();

    let param = Tensor::<f32>::ones(&[2, 2]);
    let grad = Tensor::<f32>::ones(&[2, 2]) * 0.1;

    // Test all optimizers can handle state management
    let optimizers: Vec<&mut dyn Optimizer> = vec![&mut lamb, &mut adabound, &mut lbfgs];

    for optimizer in optimizers {
        // Test state saving
        let _initial_state = optimizer.state_dict();

        // Perform optimization
        optimizer.step(&param, &grad);

        // Test state loading
        let mut new_state = HashMap::new();
        new_state.insert("learning_rate".to_string(), 0.05);
        optimizer.load_state_dict(new_state);

        assert_eq!(optimizer.learning_rate(), 0.05);
    }
}

#[test]
fn test_optimizer_performance_comparison() {
    let param = Tensor::<f32>::ones(&[10, 10]) * 5.0;
    let target = Tensor::<f32>::zeros(&[10, 10]);

    let mut lamb = LAMB::new(0.01);
    let mut adabound = AdaBound::new(0.01);
    let mut lbfgs = LBFGS::new(0.1).unwrap();

    // Simple quadratic optimization problem
    // Minimize ||param - target||^2

    let initial_param = param.clone();
    let param_lamb = initial_param.clone();
    let param_adabound = initial_param.clone();
    let param_lbfgs = initial_param.clone();

    // Run each optimizer for multiple steps
    for _ in 0..10 {
        // Gradient = 2 * (param - target)
        let grad_lamb = (&param_lamb - &target) * 2.0;
        let grad_adabound = (&param_adabound - &target) * 2.0;
        let grad_lbfgs = (&param_lbfgs - &target) * 2.0;

        lamb.step(&param_lamb, &grad_lamb);
        adabound.step(&param_adabound, &grad_adabound);
        lbfgs.step(&param_lbfgs, &grad_lbfgs);
    }

    // All optimizers should have made progress toward the target
    // Calculate distances using sum of squares (manual norm calculation)
    let initial_sum_squares = initial_param
        .data
        .iter()
        .map(|&x| x * x)
        .sum::<f32>()
        .sqrt();
    let lamb_sum_squares = param_lamb.data.iter().map(|&x| x * x).sum::<f32>().sqrt();
    let adabound_sum_squares = param_adabound
        .data
        .iter()
        .map(|&x| x * x)
        .sum::<f32>()
        .sqrt();
    let lbfgs_sum_squares = param_lbfgs.data.iter().map(|&x| x * x).sum::<f32>().sqrt();

    // All should reduce the distance to target (though rates may vary)
    assert!(lamb_sum_squares < initial_sum_squares);
    assert!(adabound_sum_squares < initial_sum_squares);
    assert!(lbfgs_sum_squares < initial_sum_squares);
}

#[test]
fn test_optimizers_with_different_tensor_shapes() {
    let shapes = vec![
        vec![1],          // 1D
        vec![5, 5],       // 2D
        vec![2, 3, 4],    // 3D
        vec![2, 2, 2, 2], // 4D
    ];

    for shape in shapes {
        let param = Tensor::<f32>::ones(&shape);
        let grad = Tensor::<f32>::ones(&shape) * 0.1;

        let mut lamb = LAMB::new(0.01);
        let mut adabound = AdaBound::new(0.01);
        let mut lbfgs = LBFGS::new(0.05).unwrap();

        let initial_data = param.data.as_slice().unwrap().to_vec();

        // Test all optimizers with this shape
        lamb.step(&param, &grad);
        let lamb_data = param.data.as_slice().unwrap();
        assert_ne!(initial_data[0], lamb_data[0]);

        // Reset parameter
        param.copy_from(&Tensor::<f32>::ones(&shape));

        adabound.step(&param, &grad);
        let adabound_data = param.data.as_slice().unwrap();
        assert_ne!(initial_data[0], adabound_data[0]);

        // Reset parameter
        param.copy_from(&Tensor::<f32>::ones(&shape));

        lbfgs.step(&param, &grad);
        let lbfgs_data = param.data.as_slice().unwrap();
        assert_ne!(initial_data[0], lbfgs_data[0]);
    }
}

#[test]
fn test_nadam_optimizer() {
    use rustorch::optim::NAdam;
    let mut nadam = NAdam::default_params(0.001).expect("Failed to create NAdam optimizer");

    assert_eq!(nadam.learning_rate(), 0.001);

    let param = Tensor::ones(&[1]);
    let grad = Tensor::ones(&[1]);

    let original_value = param.item();
    nadam.step(&param, &grad);

    // Parameters should be updated with NAdam dynamics
    assert_ne!(param.item(), original_value);
}

#[test]
fn test_radam_optimizer() {
    use rustorch::optim::RAdam;
    let mut radam = RAdam::default_params(0.001).expect("Failed to create RAdam optimizer");

    assert_eq!(radam.learning_rate(), 0.001);

    let param = Tensor::ones(&[1]);
    let grad = Tensor::ones(&[1]);

    let original_value = param.item();
    radam.step(&param, &grad);

    // Parameters should be updated with rectified Adam
    assert_ne!(param.item(), original_value);
}

#[test]
fn test_adamax_optimizer() {
    use rustorch::optim::Adamax;
    let mut adamax = Adamax::default_params(0.002).expect("Failed to create Adamax optimizer");

    assert_eq!(adamax.learning_rate(), 0.002);

    let param = Tensor::ones(&[1]);
    let grad = Tensor::ones(&[1]);

    let original_value = param.item();
    adamax.step(&param, &grad);

    // Parameters should be updated using infinity norm
    assert_ne!(param.item(), original_value);
}