torsh-optim 0.2.0

Optimization algorithms for ToRSh with PyTorch-compatible API
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
//! Optimizer Performance Benchmark
//!
//! This example compares the performance of different optimizers on
//! standard optimization problems, measuring:
//! - Convergence speed (iterations to threshold)
//! - Final loss achieved
//! - Step time (performance)
//! - Memory usage (approximate)
//!
//! Run with: cargo run --example optimizer_benchmark_comparison --release

use parking_lot::RwLock;
use std::sync::Arc;
use std::time::Instant;
use torsh_core::error::Result;
use torsh_optim::prelude::*;
use torsh_tensor::Tensor;

/// Benchmark result for a single optimizer
#[derive(Debug, Clone)]
struct BenchmarkResult {
    optimizer_name: String,
    final_loss: f32,
    iterations: usize,
    total_time_ms: f64,
    time_per_step_us: f64,
    converged: bool,
}

impl BenchmarkResult {
    fn print(&self) {
        println!(
            "  {:20} | Loss: {:8.6} | Steps: {:4} | Time: {:6.2}ms | Per-step: {:6.2}ยตs | {}",
            self.optimizer_name,
            self.final_loss,
            self.iterations,
            self.total_time_ms,
            self.time_per_step_us,
            if self.converged { "โœ“" } else { "โœ—" }
        );
    }
}

/// Run optimization benchmark for a single optimizer
fn benchmark_optimizer<O: Optimizer>(
    name: &str,
    mut optimizer: O,
    param: Arc<RwLock<Tensor>>,
    max_iterations: usize,
    convergence_threshold: f32,
) -> Result<BenchmarkResult> {
    let start = Instant::now();
    let mut iterations = 0;
    let mut final_loss = f32::INFINITY;
    let mut converged = false;

    for i in 0..max_iterations {
        // Compute gradient: f(x) = x^2, df/dx = 2x
        let grad = { param.read().mul_scalar(2.0)? };
        param.write().set_grad(Some(grad));

        // Optimization step
        optimizer.step().map_err(|e| {
            torsh_core::error::TorshError::RuntimeError(format!("Step failed: {:?}", e))
        })?;

        // Compute loss
        let loss = {
            let val = param.read().to_vec()?[0];
            val * val
        };

        final_loss = loss;
        iterations = i + 1;

        optimizer.zero_grad();

        // Check convergence
        if loss < convergence_threshold {
            converged = true;
            break;
        }
    }

    let elapsed = start.elapsed();
    let total_time_ms = elapsed.as_secs_f64() * 1000.0;
    let time_per_step_us = (total_time_ms * 1000.0) / iterations as f64;

    Ok(BenchmarkResult {
        optimizer_name: name.to_string(),
        final_loss,
        iterations,
        total_time_ms,
        time_per_step_us,
        converged,
    })
}

fn main() -> Result<()> {
    println!("โšก Optimizer Performance Benchmark\n");
    println!("{}", "=".repeat(90));
    println!("\n๐Ÿ“Š Problem: Minimize f(x) = xยฒ starting from x=10.0");
    println!("๐ŸŽฏ Target: Loss < 1e-6");
    println!("โฑ๏ธ  Max iterations: 1000\n");

    let max_iterations = 1000;
    let convergence_threshold = 1e-6;
    let initial_value = 10.0;

    let mut results = Vec::new();

    // ========================================================================
    // BENCHMARK: First-Order Optimizers
    // ========================================================================
    println!("\n{}", "=".repeat(90));
    println!("๐Ÿ“š Category 1: First-Order Optimizers");
    println!("{}", "=".repeat(90));
    println!(
        "\n  {:20} | {:^14} | {:^10} | {:^12} | {:^14} | Status",
        "Optimizer", "Final Loss", "Iterations", "Total Time", "Time/Step"
    );
    println!("  {}", "-".repeat(88));

    // SGD
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = SGD::new(vec![param.clone()], 0.1, Some(0.9), None, None, false);
        let result = benchmark_optimizer(
            "SGD",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // Adam
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = Adam::new(
            vec![param.clone()],
            Some(0.1),
            Some((0.9, 0.999)),
            None,
            None,
            false,
        );
        let result = benchmark_optimizer(
            "Adam",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // AdaGrad
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = AdaGrad::new(
            vec![param.clone()],
            Some(1.0),   // lr
            Some(0.0),   // lr_decay
            Some(0.0),   // weight_decay
            None,        // initial_accumulator_value
            Some(1e-10), // eps
        );
        let result = benchmark_optimizer(
            "AdaGrad",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // RMSprop
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = RMSprop::new(
            vec![param.clone()],
            Some(0.01), // lr
            Some(0.99), // alpha
            Some(1e-8), // eps
            Some(0.0),  // weight_decay
            Some(0.0),  // momentum
            false,      // centered
        );
        let result = benchmark_optimizer(
            "RMSprop",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // ========================================================================
    // BENCHMARK: Advanced Adaptive Methods
    // ========================================================================
    println!("\n\n{}", "=".repeat(90));
    println!("๐Ÿ“š Category 2: Advanced Adaptive Methods");
    println!("{}", "=".repeat(90));
    println!(
        "\n  {:20} | {:^14} | {:^10} | {:^12} | {:^14} | Status",
        "Optimizer", "Final Loss", "Iterations", "Total Time", "Time/Step"
    );
    println!("  {}", "-".repeat(88));

    // RAdam
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = RAdam::new(
            vec![param.clone()],
            Some(0.1),
            Some(0.9),
            Some(0.999),
            Some(1e-8),
            None,
        );
        let result = benchmark_optimizer(
            "RAdam",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // AdaBelief
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = AdaBelief::new(vec![param.clone()], 0.1); // Just params and lr
        let result = benchmark_optimizer(
            "AdaBelief",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // NAdam
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = NAdam::new(vec![param.clone()], 0.1); // Just params and lr
        let result = benchmark_optimizer(
            "NAdam",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // ========================================================================
    // BENCHMARK: Modern Optimizers (2023-2024)
    // ========================================================================
    println!("\n\n{}", "=".repeat(90));
    println!("๐Ÿ“š Category 3: Modern Optimizers (2023-2024)");
    println!("{}", "=".repeat(90));
    println!(
        "\n  {:20} | {:^14} | {:^10} | {:^12} | {:^14} | Status",
        "Optimizer", "Final Loss", "Iterations", "Total Time", "Time/Step"
    );
    println!("  {}", "-".repeat(88));

    // Lion
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = Lion::builder()
            .params(vec![param.clone()])
            .lr(0.01)
            .beta1(0.9)
            .beta2(0.99)
            .build();
        let result = benchmark_optimizer(
            "Lion",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // Prodigy
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let optimizer = Prodigy::builder()
            .params(vec![param.clone()])
            .lr(1.0)
            .beta1(0.9)
            .beta2(0.999)
            .build();
        let result = benchmark_optimizer(
            "Prodigy",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // ========================================================================
    // BENCHMARK: Meta-Optimizers
    // ========================================================================
    println!("\n\n{}", "=".repeat(90));
    println!("๐Ÿ“š Category 4: Meta-Optimizers");
    println!("{}", "=".repeat(90));
    println!(
        "\n  {:20} | {:^14} | {:^10} | {:^12} | {:^14} | Status",
        "Optimizer", "Final Loss", "Iterations", "Total Time", "Time/Step"
    );
    println!("  {}", "-".repeat(88));

    // Lookahead(Adam)
    {
        let param = Arc::new(RwLock::new(Tensor::scalar(initial_value)?));
        let base = Adam::new(
            vec![param.clone()],
            Some(0.1),
            Some((0.9, 0.999)),
            None,
            None,
            false,
        );
        let optimizer = Lookahead::new(base, 0.5, 5); // Returns Self, not Result
        let result = benchmark_optimizer(
            "Lookahead(Adam)",
            optimizer,
            param,
            max_iterations,
            convergence_threshold,
        )?;
        result.print();
        results.push(result);
    }

    // ========================================================================
    // ANALYSIS
    // ========================================================================
    println!("\n\n{}", "=".repeat(90));
    println!("๐Ÿ“Š Performance Analysis");
    println!("{}", "=".repeat(90));

    // Find fastest converging
    let fastest = results
        .iter()
        .filter(|r| r.converged)
        .min_by_key(|r| r.iterations);

    if let Some(fastest) = fastest {
        println!("\n๐Ÿ† Fastest Convergence: {}", fastest.optimizer_name);
        println!("   Converged in {} iterations", fastest.iterations);
        println!("   Final loss: {:.6}", fastest.final_loss);
    }

    // Find lowest final loss
    let best_loss = results.iter().min_by(|a, b| {
        a.final_loss
            .partial_cmp(&b.final_loss)
            .unwrap_or(std::cmp::Ordering::Equal)
    });

    if let Some(best) = best_loss {
        println!("\n๐ŸŽฏ Best Final Loss: {}", best.optimizer_name);
        println!("   Final loss: {:.6}", best.final_loss);
        println!("   Iterations: {}", best.iterations);
    }

    // Find fastest per-step
    let fastest_step = results.iter().min_by(|a, b| {
        a.time_per_step_us
            .partial_cmp(&b.time_per_step_us)
            .unwrap_or(std::cmp::Ordering::Equal)
    });

    if let Some(fastest) = fastest_step {
        println!("\nโšก Fastest Per-Step: {}", fastest.optimizer_name);
        println!("   Time per step: {:.2}ยตs", fastest.time_per_step_us);
    }

    // Convergence summary
    let converged_count = results.iter().filter(|r| r.converged).count();
    println!("\n๐Ÿ“ˆ Convergence Summary:");
    println!(
        "   {}/{} optimizers converged to threshold",
        converged_count,
        results.len()
    );

    // ========================================================================
    // RECOMMENDATIONS
    // ========================================================================
    println!("\n\n{}", "=".repeat(90));
    println!("๐Ÿ’ก Recommendations Based on Benchmarks");
    println!("{}", "=".repeat(90));

    println!("\n๐ŸŽฏ For Fast Convergence:");
    println!("   โ†’ Adam, RAdam, or NAdam");
    println!("   โ†’ Reliable, fast, and work out-of-the-box");

    println!("\n๐Ÿ’พ For Memory Efficiency:");
    println!("   โ†’ Lion (only momentum, no second moment)");
    println!("   โ†’ SGD with momentum (minimal state)");

    println!("\n๐Ÿ”ง For No Hyperparameter Tuning:");
    println!("   โ†’ Prodigy (auto-adaptive learning rate)");
    println!("   โ†’ Just use lr=1.0 and go!");

    println!("\nโšก For Speed:");
    println!("   โ†’ SGD (simplest, fastest per-step)");
    println!("   โ†’ But may need more iterations to converge");

    println!("\n๐ŸŽ“ For Best Final Performance:");
    println!("   โ†’ Often depends on the problem");
    println!("   โ†’ Try multiple optimizers with cross-validation");

    println!("\n\n{}", "=".repeat(90));
    println!("โœ… Benchmark completed successfully!");
    println!("๐Ÿ’ก Run with --release flag for accurate timing measurements");
    println!("{}", "=".repeat(90));

    Ok(())
}