entrenar 0.7.8

Training & Optimization library with autograd, LoRA, quantization, and model merging
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
//! SLERP (Spherical Linear intERPolation) merge algorithm
//!
//! SLERP blends two models using spherical interpolation, which is better
//! than linear interpolation for unit-normalized weight spaces.

use super::{validate_models, MergeError, Model};
use crate::autograd::Tensor;
use ndarray::Array1;
use std::collections::HashMap;

/// Configuration for SLERP merge
#[derive(Clone, Debug)]
pub struct SlerpConfig {
    /// Interpolation parameter: t ∈ [0, 1]
    /// t=0.0 -> 100% model1
    /// t=0.5 -> 50/50 blend
    /// t=1.0 -> 100% model2
    pub t: f32,
}

impl Default for SlerpConfig {
    fn default() -> Self {
        Self { t: 0.5 }
    }
}

impl SlerpConfig {
    pub fn new(t: f32) -> Result<Self, MergeError> {
        if !(0.0..=1.0).contains(&t) {
            return Err(MergeError::InvalidConfig(format!(
                "Interpolation parameter t must be in [0.0, 1.0], got {t}"
            )));
        }
        Ok(Self { t })
    }
}

/// SLERP merge: spherical linear interpolation between two models
///
/// # Arguments
/// * `model1` - First model (t=0)
/// * `model2` - Second model (t=1)
/// * `config` - SLERP configuration (interpolation parameter t)
///
/// # Returns
/// Interpolated model at parameter t
///
/// # Algorithm
/// For each parameter w1, w2:
/// 1. Compute angle: θ = arccos(w1·w2 / (|w1||w2|))
/// 2. If θ ≈ 0 (parallel vectors), use linear interpolation
/// 3. Otherwise: w = (sin((1-t)θ)/sinθ)*w1 + (sin(tθ)/sinθ)*w2
///
/// # Notes
/// - SLERP is rotation-invariant and maintains constant angular velocity
/// - Falls back to linear interpolation for nearly parallel weights
/// - Only works for 2 models (unlike TIES/DARE which support N models)
pub fn slerp_merge(
    model1: &Model,
    model2: &Model,
    config: &SlerpConfig,
) -> Result<Model, MergeError> {
    validate_models(&[model1.clone(), model2.clone()])?;

    let mut merged = HashMap::new();

    for (name, tensor1) in model1 {
        let tensor2 = &model2[name];
        let merged_tensor = slerp_tensor(tensor1, tensor2, config.t);
        merged.insert(name.clone(), merged_tensor);
    }

    Ok(merged)
}

/// Spherical linear interpolation between two tensors
fn slerp_tensor(tensor1: &Tensor, tensor2: &Tensor, t: f32) -> Tensor {
    let w1 = tensor1.data();
    let w2 = tensor2.data();

    // Compute dot product and norms
    let dot = w1.iter().zip(w2.iter()).map(|(a, b)| a * b).sum::<f32>();
    let norm1 = w1.iter().map(|x| x * x).sum::<f32>().sqrt();
    let norm2 = w2.iter().map(|x| x * x).sum::<f32>().sqrt();

    // Handle zero vectors
    if norm1 < 1e-8 || norm2 < 1e-8 {
        return linear_interp_tensor(tensor1, tensor2, t);
    }

    // Compute cosine of angle
    let cos_theta = (dot / (norm1 * norm2)).clamp(-1.0, 1.0);

    // If vectors are nearly parallel (cos_theta ≈ 1), use linear interpolation
    const EPSILON: f32 = 1e-4;
    if (cos_theta - 1.0).abs() < EPSILON {
        return linear_interp_tensor(tensor1, tensor2, t);
    }

    // Compute theta and sin(theta)
    let theta = cos_theta.acos();
    let sin_theta = theta.sin();

    // Spherical interpolation
    // w = (sin((1-t)θ)/sinθ)*w1 + (sin(tθ)/sinθ)*w2
    let coef1 = ((1.0 - t) * theta).sin() / sin_theta;
    let coef2 = (t * theta).sin() / sin_theta;

    let interpolated: Array1<f32> =
        w1.iter().zip(w2.iter()).map(|(a, b)| coef1 * a + coef2 * b).collect();

    Tensor::new(interpolated, false)
}

/// Linear interpolation fallback for parallel vectors
fn linear_interp_tensor(tensor1: &Tensor, tensor2: &Tensor, t: f32) -> Tensor {
    let w1 = tensor1.data();
    let w2 = tensor2.data();

    let interpolated: Array1<f32> =
        w1.iter().zip(w2.iter()).map(|(a, b)| (1.0 - t) * a + t * b).collect();

    Tensor::new(interpolated, false)
}

#[cfg(test)]
mod tests {
    use super::*;
    use proptest::prelude::*;

    #[test]
    fn test_slerp_at_endpoints() {
        let t1 = Tensor::from_vec(vec![1.0, 2.0, 3.0], false);
        let t2 = Tensor::from_vec(vec![4.0, 5.0, 6.0], false);

        // t=0.0 should return tensor1
        let result = slerp_tensor(&t1, &t2, 0.0);
        for (a, b) in result.data().iter().zip(t1.data().iter()) {
            assert!((a - b).abs() < 1e-6);
        }

        // t=1.0 should return tensor2
        let result = slerp_tensor(&t1, &t2, 1.0);
        for (a, b) in result.data().iter().zip(t2.data().iter()) {
            assert!((a - b).abs() < 1e-6);
        }
    }

    #[test]
    fn test_slerp_midpoint() {
        let t1 = Tensor::from_vec(vec![1.0, 0.0], false);
        let t2 = Tensor::from_vec(vec![0.0, 1.0], false);

        // t=0.5 should be close to (1/√2, 1/√2) for perpendicular vectors
        let result = slerp_tensor(&t1, &t2, 0.5);
        let expected_val = 1.0 / 2.0f32.sqrt();

        assert!((result.data()[0] - expected_val).abs() < 1e-5);
        assert!((result.data()[1] - expected_val).abs() < 1e-5);
    }

    #[test]
    fn test_linear_interp_fallback_for_parallel() {
        let t1 = Tensor::from_vec(vec![1.0, 2.0, 3.0], false);
        let t2 = Tensor::from_vec(vec![2.0, 4.0, 6.0], false); // Parallel (2x t1)

        let result = slerp_tensor(&t1, &t2, 0.5);

        // Should fall back to linear interpolation
        let expected = [1.5, 3.0, 4.5]; // (1+2)/2, (2+4)/2, (3+6)/2
        for (a, e) in result.data().iter().zip(expected.iter()) {
            assert!((a - e).abs() < 1e-5);
        }
    }

    #[test]
    fn test_slerp_config_validation() {
        assert!(SlerpConfig::new(0.0).is_ok());
        assert!(SlerpConfig::new(0.5).is_ok());
        assert!(SlerpConfig::new(1.0).is_ok());
        assert!(SlerpConfig::new(-0.1).is_err());
        assert!(SlerpConfig::new(1.1).is_err());
    }

    #[test]
    fn test_slerp_merge() {
        let mut model1 = HashMap::new();
        model1.insert("w".to_string(), Tensor::from_vec(vec![1.0, 0.0], false));

        let mut model2 = HashMap::new();
        model2.insert("w".to_string(), Tensor::from_vec(vec![0.0, 1.0], false));

        let config = SlerpConfig::new(0.5).expect("slerp config creation should succeed");
        let merged = slerp_merge(&model1, &model2, &config).expect("config should be valid");

        // Midpoint of perpendicular unit vectors
        let expected_val = 1.0 / 2.0f32.sqrt();
        assert!((merged["w"].data()[0] - expected_val).abs() < 1e-5);
        assert!((merged["w"].data()[1] - expected_val).abs() < 1e-5);
    }

    #[test]
    fn test_linear_interp_basic() {
        let t1 = Tensor::from_vec(vec![0.0, 0.0], false);
        let t2 = Tensor::from_vec(vec![10.0, 20.0], false);

        let result = linear_interp_tensor(&t1, &t2, 0.3);
        assert!((result.data()[0] - 3.0).abs() < 1e-6);
        assert!((result.data()[1] - 6.0).abs() < 1e-6);
    }

    #[test]
    fn test_slerp_zero_vector_fallback() {
        let t1 = Tensor::from_vec(vec![0.0, 0.0], false);
        let t2 = Tensor::from_vec(vec![1.0, 1.0], false);

        // Should fall back to linear interpolation for zero vector
        let result = slerp_tensor(&t1, &t2, 0.5);
        assert!((result.data()[0] - 0.5).abs() < 1e-6);
        assert!((result.data()[1] - 0.5).abs() < 1e-6);
    }

    #[test]
    fn test_slerp_negative_vectors() {
        let t1 = Tensor::from_vec(vec![1.0, 0.0], false);
        let t2 = Tensor::from_vec(vec![-1.0, 0.0], false); // Opposite direction

        let result = slerp_tensor(&t1, &t2, 0.5);

        // At midpoint of opposite vectors, SLERP rotates through perpendicular
        // The result should be perpendicular (along y-axis)
        assert!((result.data()[0]).abs() < 1e-5);
    }

    // Property tests

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(200))]

        #[test]
        fn prop_slerp_config_valid_range(t in 0.0f32..=1.0) {
            let config = SlerpConfig::new(t);
            prop_assert!(config.is_ok());
        }

        #[test]
        fn prop_slerp_config_invalid_negative(t in -10.0f32..-0.01) {
            let config = SlerpConfig::new(t);
            prop_assert!(config.is_err());
        }

        #[test]
        fn prop_slerp_config_invalid_above_one(t in 1.01f32..10.0) {
            let config = SlerpConfig::new(t);
            prop_assert!(config.is_err());
        }

        #[test]
        fn prop_slerp_t0_returns_first(
            values1 in proptest::collection::vec(-10.0f32..10.0, 3..10),
            values2 in proptest::collection::vec(-10.0f32..10.0, 3..10)
        ) {
            let len = values1.len().min(values2.len());
            let v1: Vec<f32> = values1.into_iter().take(len).collect();
            let v2: Vec<f32> = values2.into_iter().take(len).collect();

            let t1 = Tensor::from_vec(v1.clone(), false);
            let t2 = Tensor::from_vec(v2, false);

            let result = slerp_tensor(&t1, &t2, 0.0);

            for (orig, res) in v1.iter().zip(result.data().iter()) {
                prop_assert!(
                    (orig - res).abs() < 1e-5,
                    "t=0 should return first tensor: {} vs {}",
                    orig,
                    res
                );
            }
        }

        #[test]
        fn prop_slerp_t1_returns_second(
            values1 in proptest::collection::vec(-10.0f32..10.0, 3..10),
            values2 in proptest::collection::vec(-10.0f32..10.0, 3..10)
        ) {
            let len = values1.len().min(values2.len());
            let v1: Vec<f32> = values1.into_iter().take(len).collect();
            let v2: Vec<f32> = values2.into_iter().take(len).collect();

            let t1 = Tensor::from_vec(v1, false);
            let t2 = Tensor::from_vec(v2.clone(), false);

            let result = slerp_tensor(&t1, &t2, 1.0);

            for (orig, res) in v2.iter().zip(result.data().iter()) {
                prop_assert!(
                    (orig - res).abs() < 1e-5,
                    "t=1 should return second tensor: {} vs {}",
                    orig,
                    res
                );
            }
        }

        #[test]
        fn prop_linear_interp_bounded(
            values1 in proptest::collection::vec(-100.0f32..100.0, 3..10),
            values2 in proptest::collection::vec(-100.0f32..100.0, 3..10),
            t in 0.0f32..=1.0
        ) {
            let len = values1.len().min(values2.len());
            let v1: Vec<f32> = values1.into_iter().take(len).collect();
            let v2: Vec<f32> = values2.into_iter().take(len).collect();

            let t1 = Tensor::from_vec(v1.clone(), false);
            let t2 = Tensor::from_vec(v2.clone(), false);

            let result = linear_interp_tensor(&t1, &t2, t);

            // Result should be within bounds of inputs
            for i in 0..len {
                let min_val = v1[i].min(v2[i]);
                let max_val = v1[i].max(v2[i]);
                prop_assert!(
                    result.data()[i] >= min_val - 1e-5 && result.data()[i] <= max_val + 1e-5,
                    "Linear interp out of bounds: {} not in [{}, {}]",
                    result.data()[i],
                    min_val,
                    max_val
                );
            }
        }

        #[test]
        fn prop_slerp_symmetric(
            values1 in proptest::collection::vec(1.0f32..10.0, 3..6),
            values2 in proptest::collection::vec(1.0f32..10.0, 3..6),
            t in 0.1f32..0.9
        ) {
            let len = values1.len().min(values2.len());
            let v1: Vec<f32> = values1.into_iter().take(len).collect();
            let v2: Vec<f32> = values2.into_iter().take(len).collect();

            let t1 = Tensor::from_vec(v1.clone(), false);
            let t2 = Tensor::from_vec(v2.clone(), false);

            // slerp(a, b, t) should have similar properties to slerp(b, a, 1-t)
            let result1 = slerp_tensor(&t1, &t2, t);
            let result2 = slerp_tensor(&t2, &t1, 1.0 - t);

            for (r1, r2) in result1.data().iter().zip(result2.data().iter()) {
                prop_assert!(
                    (r1 - r2).abs() < 1e-4,
                    "SLERP not symmetric: {} vs {}",
                    r1,
                    r2
                );
            }
        }

        #[test]
        fn prop_linear_interp_t0_returns_first(
            values1 in proptest::collection::vec(-100.0f32..100.0, 3..10),
            values2 in proptest::collection::vec(-100.0f32..100.0, 3..10)
        ) {
            let len = values1.len().min(values2.len());
            let v1: Vec<f32> = values1.into_iter().take(len).collect();
            let v2: Vec<f32> = values2.into_iter().take(len).collect();

            let t1 = Tensor::from_vec(v1.clone(), false);
            let t2 = Tensor::from_vec(v2, false);

            let result = linear_interp_tensor(&t1, &t2, 0.0);

            for (orig, res) in v1.iter().zip(result.data().iter()) {
                prop_assert!(
                    (orig - res).abs() < 1e-6,
                    "t=0 should return first: {} vs {}",
                    orig,
                    res
                );
            }
        }

        #[test]
        fn prop_linear_interp_midpoint_is_average(
            values1 in proptest::collection::vec(-100.0f32..100.0, 3..10),
            values2 in proptest::collection::vec(-100.0f32..100.0, 3..10)
        ) {
            let len = values1.len().min(values2.len());
            let v1: Vec<f32> = values1.into_iter().take(len).collect();
            let v2: Vec<f32> = values2.into_iter().take(len).collect();

            let t1 = Tensor::from_vec(v1.clone(), false);
            let t2 = Tensor::from_vec(v2.clone(), false);

            let result = linear_interp_tensor(&t1, &t2, 0.5);

            for i in 0..len {
                let expected = f32::midpoint(v1[i], v2[i]);
                prop_assert!(
                    (result.data()[i] - expected).abs() < 1e-5,
                    "Midpoint not average: {} vs {}",
                    result.data()[i],
                    expected
                );
            }
        }
    }
}