trustformers-optim 0.1.0

Optimizers for TrustformeRS
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
use anyhow::Result;
use std::collections::HashMap;
use trustformers_core::tensor::Tensor;

#[derive(Debug, Clone)]
pub struct QuantizationConfig {
    pub scale: f32,
    pub zero_point: i8,
    pub min_val: f32,
    pub max_val: f32,
}

impl QuantizationConfig {
    pub fn new(min_val: f32, max_val: f32) -> Self {
        let scale = (max_val - min_val) / 255.0;
        let zero_point = (-min_val / scale).round().clamp(-128.0, 127.0) as i8;

        Self {
            scale,
            zero_point,
            min_val,
            max_val,
        }
    }

    pub fn quantize(&self, value: f32) -> i8 {
        let quantized = ((value - self.min_val) / self.scale).round() - 128.0;
        quantized.clamp(-128.0, 127.0) as i8
    }

    pub fn dequantize(&self, quantized: i8) -> f32 {
        (quantized as f32 + 128.0) * self.scale + self.min_val
    }
}

#[derive(Debug, Clone)]
pub struct QuantizedState {
    pub data: Vec<i8>,
    pub config: QuantizationConfig,
}

impl QuantizedState {
    pub fn new(values: &[f32]) -> Self {
        let min_val = values.iter().fold(f32::INFINITY, |a, &b| a.min(b));
        let max_val = values.iter().fold(f32::NEG_INFINITY, |a, &b| a.max(b));

        let config = QuantizationConfig::new(min_val, max_val);
        let data: Vec<i8> = values.iter().map(|&v| config.quantize(v)).collect();

        Self { data, config }
    }

    pub fn to_f32(&self) -> Vec<f32> {
        self.data.iter().map(|&q| self.config.dequantize(q)).collect()
    }

    pub fn update(&mut self, new_values: &[f32]) {
        let min_val = new_values.iter().fold(f32::INFINITY, |a, &b| a.min(b));
        let max_val = new_values.iter().fold(f32::NEG_INFINITY, |a, &b| a.max(b));

        self.config = QuantizationConfig::new(min_val, max_val);
        self.data = new_values.iter().map(|&v| self.config.quantize(v)).collect();
    }
}

#[derive(Debug)]
pub struct Adam8bit {
    pub learning_rate: f32,
    pub beta1: f32,
    pub beta2: f32,
    pub epsilon: f32,
    pub weight_decay: f32,
    pub step: usize,
    pub momentum_states: HashMap<String, QuantizedState>,
    pub variance_states: HashMap<String, QuantizedState>,
}

impl Default for Adam8bit {
    fn default() -> Self {
        Self {
            learning_rate: 1e-3,
            beta1: 0.9,
            beta2: 0.999,
            epsilon: 1e-8,
            weight_decay: 0.0,
            step: 0,
            momentum_states: HashMap::new(),
            variance_states: HashMap::new(),
        }
    }
}

impl Adam8bit {
    pub fn new(learning_rate: f32) -> Self {
        Self {
            learning_rate,
            ..Default::default()
        }
    }

    pub fn with_config(
        learning_rate: f32,
        beta1: f32,
        beta2: f32,
        epsilon: f32,
        weight_decay: f32,
    ) -> Self {
        Self {
            learning_rate,
            beta1,
            beta2,
            epsilon,
            weight_decay,
            step: 0,
            momentum_states: HashMap::new(),
            variance_states: HashMap::new(),
        }
    }

    pub fn step(
        &mut self,
        parameters: &mut HashMap<String, Tensor>,
        gradients: &HashMap<String, Tensor>,
    ) -> Result<()> {
        self.step += 1;

        let bias_correction1 = 1.0 - self.beta1.powi(self.step as i32);
        let bias_correction2 = 1.0 - self.beta2.powi(self.step as i32);

        for (name, param) in parameters.iter_mut() {
            let grad = gradients
                .get(name)
                .ok_or_else(|| anyhow::anyhow!("Missing gradient for parameter: {}", name))?;

            let mut param_data = param.data()?;
            let grad_data = grad.data()?;

            if param_data.len() != grad_data.len() {
                return Err(anyhow::anyhow!(
                    "Parameter and gradient size mismatch for: {}",
                    name
                ));
            }

            if !self.momentum_states.contains_key(name) {
                let zeros = vec![0.0; param_data.len()];
                self.momentum_states.insert(name.clone(), QuantizedState::new(&zeros));
                self.variance_states.insert(name.clone(), QuantizedState::new(&zeros));
            }

            let momentum_state = self
                .momentum_states
                .get_mut(name)
                .expect("momentum_state should exist after initialization");
            let variance_state = self
                .variance_states
                .get_mut(name)
                .expect("variance_state should exist after initialization");

            let mut momentum = momentum_state.to_f32();
            let mut variance = variance_state.to_f32();

            for i in 0..param_data.len() {
                let mut grad_val = grad_data[i];

                if self.weight_decay > 0.0 {
                    grad_val += self.weight_decay * param_data[i];
                }

                momentum[i] = self.beta1 * momentum[i] + (1.0 - self.beta1) * grad_val;
                variance[i] = self.beta2 * variance[i] + (1.0 - self.beta2) * grad_val * grad_val;

                let corrected_momentum = momentum[i] / bias_correction1;
                let corrected_variance = variance[i] / bias_correction2;

                param_data[i] -= self.learning_rate * corrected_momentum
                    / (corrected_variance.sqrt() + self.epsilon);
            }

            momentum_state.update(&momentum);
            variance_state.update(&variance);

            // Update the parameter tensor with modified data
            *param = Tensor::new(param_data)?;
        }

        Ok(())
    }

    pub fn memory_usage(&self) -> usize {
        let mut total = 0;
        for state in self.momentum_states.values() {
            total += state.data.len();
        }
        for state in self.variance_states.values() {
            total += state.data.len();
        }
        total
    }

    pub fn memory_savings_vs_fp32(&self) -> f32 {
        let quantized_size = self.memory_usage();
        let fp32_equivalent = quantized_size * 4;
        1.0 - (quantized_size as f32 / fp32_equivalent as f32)
    }
}

#[derive(Debug)]
pub struct AdamW8bit {
    pub learning_rate: f32,
    pub beta1: f32,
    pub beta2: f32,
    pub epsilon: f32,
    pub weight_decay: f32,
    pub step: usize,
    pub momentum_states: HashMap<String, QuantizedState>,
    pub variance_states: HashMap<String, QuantizedState>,
}

impl Default for AdamW8bit {
    fn default() -> Self {
        Self {
            learning_rate: 1e-3,
            beta1: 0.9,
            beta2: 0.999,
            epsilon: 1e-8,
            weight_decay: 1e-2,
            step: 0,
            momentum_states: HashMap::new(),
            variance_states: HashMap::new(),
        }
    }
}

impl AdamW8bit {
    pub fn new(learning_rate: f32) -> Self {
        Self {
            learning_rate,
            ..Default::default()
        }
    }

    pub fn with_config(
        learning_rate: f32,
        beta1: f32,
        beta2: f32,
        epsilon: f32,
        weight_decay: f32,
    ) -> Self {
        Self {
            learning_rate,
            beta1,
            beta2,
            epsilon,
            weight_decay,
            step: 0,
            momentum_states: HashMap::new(),
            variance_states: HashMap::new(),
        }
    }

    pub fn step(
        &mut self,
        parameters: &mut HashMap<String, Tensor>,
        gradients: &HashMap<String, Tensor>,
    ) -> Result<()> {
        self.step += 1;

        let bias_correction1 = 1.0 - self.beta1.powi(self.step as i32);
        let bias_correction2 = 1.0 - self.beta2.powi(self.step as i32);

        for (name, param) in parameters.iter_mut() {
            let grad = gradients
                .get(name)
                .ok_or_else(|| anyhow::anyhow!("Missing gradient for parameter: {}", name))?;

            let mut param_data = param.data()?;
            let grad_data = grad.data()?;

            if param_data.len() != grad_data.len() {
                return Err(anyhow::anyhow!(
                    "Parameter and gradient size mismatch for: {}",
                    name
                ));
            }

            if !self.momentum_states.contains_key(name) {
                let zeros = vec![0.0; param_data.len()];
                self.momentum_states.insert(name.clone(), QuantizedState::new(&zeros));
                self.variance_states.insert(name.clone(), QuantizedState::new(&zeros));
            }

            let momentum_state = self
                .momentum_states
                .get_mut(name)
                .expect("momentum_state should exist after initialization");
            let variance_state = self
                .variance_states
                .get_mut(name)
                .expect("variance_state should exist after initialization");

            let mut momentum = momentum_state.to_f32();
            let mut variance = variance_state.to_f32();

            for i in 0..param_data.len() {
                let grad_val = grad_data[i];

                momentum[i] = self.beta1 * momentum[i] + (1.0 - self.beta1) * grad_val;
                variance[i] = self.beta2 * variance[i] + (1.0 - self.beta2) * grad_val * grad_val;

                let corrected_momentum = momentum[i] / bias_correction1;
                let corrected_variance = variance[i] / bias_correction2;

                let update = corrected_momentum / (corrected_variance.sqrt() + self.epsilon);

                param_data[i] = param_data[i] * (1.0 - self.learning_rate * self.weight_decay)
                    - self.learning_rate * update;
            }

            momentum_state.update(&momentum);
            variance_state.update(&variance);

            // Update the parameter tensor with modified data
            *param = Tensor::new(param_data)?;
        }

        Ok(())
    }

    pub fn memory_usage(&self) -> usize {
        let mut total = 0;
        for state in self.momentum_states.values() {
            total += state.data.len();
        }
        for state in self.variance_states.values() {
            total += state.data.len();
        }
        total
    }

    pub fn memory_savings_vs_fp32(&self) -> f32 {
        let quantized_size = self.memory_usage();
        let fp32_equivalent = quantized_size * 4;
        1.0 - (quantized_size as f32 / fp32_equivalent as f32)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_abs_diff_eq;

    #[test]
    fn test_quantization_config() {
        let config = QuantizationConfig::new(-1.0, 1.0);

        // Test that values map correctly to the quantized range
        assert_eq!(config.quantize(-1.0), -128);
        assert_eq!(config.quantize(1.0), 127);

        // Test middle value
        let mid_quantized = config.quantize(0.0);
        assert!((-1..=1).contains(&mid_quantized));

        // Test round-trip accuracy
        let original = 0.5;
        let quantized = config.quantize(original);
        let reconstructed = config.dequantize(quantized);
        assert_abs_diff_eq!(original, reconstructed, epsilon = 0.02);
    }

    #[test]
    fn test_quantized_state() {
        let values = vec![0.1, -0.5, 0.8, -0.2];
        let state = QuantizedState::new(&values);

        let reconstructed = state.to_f32();

        // Test that we have the right number of values
        assert_eq!(values.len(), reconstructed.len());

        // Test that quantization preserves relative ordering
        assert!(reconstructed[2] > reconstructed[0]); // 0.8 > 0.1
        assert!(reconstructed[1] < reconstructed[0]); // -0.5 < 0.1

        // Test approximate reconstruction (quantization introduces some error)
        for (orig, recon) in values.iter().zip(reconstructed.iter()) {
            assert_abs_diff_eq!(orig, recon, epsilon = 0.1);
        }
    }

    #[test]
    fn test_adam8bit_creation() {
        let optimizer = Adam8bit::new(0.001);
        assert_eq!(optimizer.learning_rate, 0.001);
        assert_eq!(optimizer.beta1, 0.9);
        assert_eq!(optimizer.beta2, 0.999);
        assert_eq!(optimizer.step, 0);
    }

    #[test]
    fn test_adam8bit_memory_usage() {
        let mut optimizer = Adam8bit::new(0.001);

        let mut parameters = HashMap::new();
        let mut gradients = HashMap::new();

        let param_data = vec![1.0, 2.0, 3.0, 4.0];
        let grad_data = vec![0.1, 0.2, 0.3, 0.4];

        parameters.insert(
            "layer1".to_string(),
            Tensor::new(param_data).expect("Failed to create tensor"),
        );
        gradients.insert(
            "layer1".to_string(),
            Tensor::new(grad_data).expect("Failed to create tensor"),
        );

        optimizer.step(&mut parameters, &gradients).expect("Step failed");

        assert_eq!(optimizer.memory_usage(), 8);
        assert!(optimizer.memory_savings_vs_fp32() > 0.7);
    }

    #[test]
    fn test_adamw8bit_creation() {
        let optimizer = AdamW8bit::new(0.001);
        assert_eq!(optimizer.learning_rate, 0.001);
        assert_eq!(optimizer.weight_decay, 0.01);
    }
}