ruvector-attention 2.1.0

Attention mechanisms for ruvector - geometric, graph, and sparse attention
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
//! Dual-space attention combining Euclidean and Hyperbolic geometries
//!
//! This module implements attention that operates in both Euclidean and hyperbolic
//! spaces, combining their complementary properties:
//! - Euclidean: Good for flat, local structure
//! - Hyperbolic: Good for hierarchical, tree-like structure

use crate::error::{AttentionError, AttentionResult};
use crate::hyperbolic::project_to_ball;
use crate::traits::Attention;
use crate::utils::stable_softmax;

/// Compute Poincaré distance between two points
fn poincare_dist(u: &[f32], v: &[f32], curvature: f32) -> f32 {
    let c = curvature.abs();
    let sqrt_c = c.sqrt();

    let diff_sq: f32 = u.iter().zip(v.iter()).map(|(a, b)| (a - b).powi(2)).sum();
    let norm_u_sq: f32 = u.iter().map(|x| x * x).sum();
    let norm_v_sq: f32 = v.iter().map(|x| x * x).sum();

    let denom = (1.0 - c * norm_u_sq).max(1e-7) * (1.0 - c * norm_v_sq).max(1e-7);
    let arg = 1.0 + 2.0 * c * diff_sq / denom;

    (1.0 / sqrt_c) * arg.max(1.0).acosh()
}

/// Configuration for dual-space attention
#[derive(Clone, Debug)]
pub struct DualSpaceConfig {
    pub dim: usize,
    pub curvature: f32,
    pub euclidean_weight: f32,
    pub hyperbolic_weight: f32,
    pub learn_weights: bool,
    pub temperature: f32,
}

impl Default for DualSpaceConfig {
    fn default() -> Self {
        Self {
            dim: 256,
            curvature: 1.0,
            euclidean_weight: 0.5,
            hyperbolic_weight: 0.5,
            learn_weights: false,
            temperature: 1.0,
        }
    }
}

impl DualSpaceConfig {
    pub fn builder() -> DualSpaceConfigBuilder {
        DualSpaceConfigBuilder::default()
    }
}

#[derive(Default)]
pub struct DualSpaceConfigBuilder {
    config: DualSpaceConfig,
}

impl DualSpaceConfigBuilder {
    pub fn dim(mut self, d: usize) -> Self {
        self.config.dim = d;
        self
    }

    pub fn curvature(mut self, c: f32) -> Self {
        self.config.curvature = c;
        self
    }

    pub fn euclidean_weight(mut self, w: f32) -> Self {
        self.config.euclidean_weight = w;
        self
    }

    pub fn hyperbolic_weight(mut self, w: f32) -> Self {
        self.config.hyperbolic_weight = w;
        self
    }

    pub fn temperature(mut self, t: f32) -> Self {
        self.config.temperature = t;
        self
    }

    pub fn build(self) -> DualSpaceConfig {
        self.config
    }
}

/// Dual-space attention layer
pub struct DualSpaceAttention {
    config: DualSpaceConfig,
    scale: f32,
    /// Linear projection for Euclidean space
    w_euclidean: Vec<f32>,
    /// Linear projection for hyperbolic space
    w_hyperbolic: Vec<f32>,
    /// Output projection
    w_out: Vec<f32>,
}

impl DualSpaceAttention {
    pub fn new(config: DualSpaceConfig) -> Self {
        let dim = config.dim;
        let scale = 1.0 / (dim as f32).sqrt();

        // Xavier initialization
        let w_scale = (2.0 / (dim + dim) as f32).sqrt();
        let mut seed = 42u64;
        let mut rand = || {
            seed = seed.wrapping_mul(6364136223846793005).wrapping_add(1);
            ((seed as f32) / (u64::MAX as f32) - 0.5) * 2.0 * w_scale
        };

        let w_euclidean: Vec<f32> = (0..dim * dim).map(|_| rand()).collect();
        let w_hyperbolic: Vec<f32> = (0..dim * dim).map(|_| rand()).collect();
        let w_out: Vec<f32> = (0..dim * dim).map(|_| rand()).collect();

        Self {
            config,
            scale,
            w_euclidean,
            w_hyperbolic,
            w_out,
        }
    }

    /// Project to Euclidean representation
    fn to_euclidean(&self, x: &[f32]) -> Vec<f32> {
        let dim = self.config.dim;
        (0..dim)
            .map(|i| {
                x.iter()
                    .enumerate()
                    .map(|(j, &xj)| xj * self.w_euclidean[i * dim + j])
                    .sum()
            })
            .collect()
    }

    /// Project to hyperbolic representation (Poincaré ball)
    fn to_hyperbolic(&self, x: &[f32]) -> Vec<f32> {
        let dim = self.config.dim;
        let projected: Vec<f32> = (0..dim)
            .map(|i| {
                x.iter()
                    .enumerate()
                    .map(|(j, &xj)| xj * self.w_hyperbolic[i * dim + j])
                    .sum()
            })
            .collect();

        // Project to ball with curvature
        project_to_ball(&projected, self.config.curvature, 1e-5)
    }

    /// Compute Euclidean similarity (dot product)
    fn euclidean_similarity(&self, q: &[f32], k: &[f32]) -> f32 {
        q.iter().zip(k.iter()).map(|(a, b)| a * b).sum::<f32>() * self.scale
    }

    /// Compute hyperbolic similarity (negative Poincaré distance)
    fn hyperbolic_similarity(&self, q: &[f32], k: &[f32]) -> f32 {
        -poincare_dist(q, k, self.config.curvature)
    }

    /// Output projection
    fn project_output(&self, x: &[f32]) -> Vec<f32> {
        let dim = self.config.dim;
        (0..dim)
            .map(|i| {
                x.iter()
                    .enumerate()
                    .map(|(j, &xj)| xj * self.w_out[i * dim + j])
                    .sum()
            })
            .collect()
    }

    /// Get the contribution weights for analysis
    pub fn get_space_contributions(&self, query: &[f32], keys: &[&[f32]]) -> (Vec<f32>, Vec<f32>) {
        let q_euc = self.to_euclidean(query);
        let q_hyp = self.to_hyperbolic(query);

        let euc_scores: Vec<f32> = keys
            .iter()
            .map(|k| {
                let k_euc = self.to_euclidean(k);
                self.euclidean_similarity(&q_euc, &k_euc)
            })
            .collect();

        let hyp_scores: Vec<f32> = keys
            .iter()
            .map(|k| {
                let k_hyp = self.to_hyperbolic(k);
                self.hyperbolic_similarity(&q_hyp, &k_hyp)
            })
            .collect();

        (euc_scores, hyp_scores)
    }
}

impl Attention for DualSpaceAttention {
    fn compute(
        &self,
        query: &[f32],
        keys: &[&[f32]],
        values: &[&[f32]],
    ) -> AttentionResult<Vec<f32>> {
        if keys.is_empty() {
            return Err(AttentionError::InvalidConfig("Empty keys".to_string()));
        }
        if query.len() != self.config.dim {
            return Err(AttentionError::DimensionMismatch {
                expected: self.config.dim,
                actual: query.len(),
            });
        }

        let n = keys.len();
        let value_dim = values[0].len();
        let temp = self.config.temperature;

        // Project query to both spaces
        let q_euc = self.to_euclidean(query);
        let q_hyp = self.to_hyperbolic(query);

        // Compute combined scores
        let mut combined_scores = Vec::with_capacity(n);

        for key in keys.iter() {
            let k_euc = self.to_euclidean(key);
            let k_hyp = self.to_hyperbolic(key);

            let euc_score = self.euclidean_similarity(&q_euc, &k_euc);
            let hyp_score = self.hyperbolic_similarity(&q_hyp, &k_hyp);

            // Weighted combination
            let combined = (self.config.euclidean_weight * euc_score
                + self.config.hyperbolic_weight * hyp_score)
                / temp;

            combined_scores.push(combined);
        }

        // Softmax over combined scores
        let weights = stable_softmax(&combined_scores);

        // Weighted sum of values
        let mut output = vec![0.0f32; value_dim];
        for (w, v) in weights.iter().zip(values.iter()) {
            for (o, &vi) in output.iter_mut().zip(v.iter()) {
                *o += w * vi;
            }
        }

        // Output projection
        if value_dim == self.config.dim {
            Ok(self.project_output(&output))
        } else {
            Ok(output)
        }
    }

    fn compute_with_mask(
        &self,
        query: &[f32],
        keys: &[&[f32]],
        values: &[&[f32]],
        mask: Option<&[bool]>,
    ) -> AttentionResult<Vec<f32>> {
        if let Some(m) = mask {
            let filtered: Vec<(usize, bool)> = m
                .iter()
                .copied()
                .enumerate()
                .filter(|(_, keep)| *keep)
                .collect();
            let filtered_keys: Vec<&[f32]> = filtered.iter().map(|(i, _)| keys[*i]).collect();
            let filtered_values: Vec<&[f32]> = filtered.iter().map(|(i, _)| values[*i]).collect();
            self.compute(query, &filtered_keys, &filtered_values)
        } else {
            self.compute(query, keys, values)
        }
    }

    fn dim(&self) -> usize {
        self.config.dim
    }
}

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

    #[test]
    fn test_dual_space_basic() {
        let config = DualSpaceConfig::builder()
            .dim(64)
            .curvature(1.0)
            .euclidean_weight(0.5)
            .hyperbolic_weight(0.5)
            .build();

        let attn = DualSpaceAttention::new(config);

        let query = vec![0.1; 64];
        let keys: Vec<Vec<f32>> = (0..10).map(|_| vec![0.1; 64]).collect();
        let values: Vec<Vec<f32>> = (0..10).map(|_| vec![1.0; 64]).collect();

        let keys_refs: Vec<&[f32]> = keys.iter().map(|k| k.as_slice()).collect();
        let values_refs: Vec<&[f32]> = values.iter().map(|v| v.as_slice()).collect();

        let result = attn.compute(&query, &keys_refs, &values_refs).unwrap();
        assert_eq!(result.len(), 64);
    }

    #[test]
    fn test_euclidean_dominant() {
        let config = DualSpaceConfig::builder()
            .dim(32)
            .euclidean_weight(1.0)
            .hyperbolic_weight(0.0)
            .build();

        let attn = DualSpaceAttention::new(config);

        let query = vec![0.5; 32];
        let keys: Vec<Vec<f32>> = vec![vec![0.3; 32]; 5];
        let values: Vec<Vec<f32>> = vec![vec![1.0; 32]; 5];

        let keys_refs: Vec<&[f32]> = keys.iter().map(|k| k.as_slice()).collect();
        let values_refs: Vec<&[f32]> = values.iter().map(|v| v.as_slice()).collect();

        let result = attn.compute(&query, &keys_refs, &values_refs).unwrap();
        assert_eq!(result.len(), 32);
    }

    #[test]
    fn test_hyperbolic_dominant() {
        let config = DualSpaceConfig::builder()
            .dim(32)
            .curvature(0.5)
            .euclidean_weight(0.0)
            .hyperbolic_weight(1.0)
            .build();

        let attn = DualSpaceAttention::new(config);

        let query = vec![0.1; 32]; // Small values for Poincaré ball
        let keys: Vec<Vec<f32>> = vec![vec![0.1; 32]; 5];
        let values: Vec<Vec<f32>> = vec![vec![1.0; 32]; 5];

        let keys_refs: Vec<&[f32]> = keys.iter().map(|k| k.as_slice()).collect();
        let values_refs: Vec<&[f32]> = values.iter().map(|v| v.as_slice()).collect();

        let result = attn.compute(&query, &keys_refs, &values_refs).unwrap();
        assert_eq!(result.len(), 32);
    }

    #[test]
    fn test_space_contributions() {
        let config = DualSpaceConfig::builder()
            .dim(16)
            .euclidean_weight(0.5)
            .hyperbolic_weight(0.5)
            .build();

        let attn = DualSpaceAttention::new(config);

        let query = vec![0.2; 16];
        let keys: Vec<Vec<f32>> = vec![vec![0.2; 16]; 3];
        let keys_refs: Vec<&[f32]> = keys.iter().map(|k| k.as_slice()).collect();

        let (euc_scores, hyp_scores) = attn.get_space_contributions(&query, &keys_refs);

        assert_eq!(euc_scores.len(), 3);
        assert_eq!(hyp_scores.len(), 3);
    }

    #[test]
    fn test_temperature_scaling() {
        let config_low_temp = DualSpaceConfig::builder().dim(16).temperature(0.5).build();

        let config_high_temp = DualSpaceConfig::builder().dim(16).temperature(2.0).build();

        let attn_low = DualSpaceAttention::new(config_low_temp);
        let attn_high = DualSpaceAttention::new(config_high_temp);

        let query = vec![0.5; 16];
        let keys: Vec<Vec<f32>> = vec![vec![0.8; 16], vec![0.2; 16]];
        let values: Vec<Vec<f32>> = vec![vec![1.0; 16], vec![0.0; 16]];

        let keys_refs: Vec<&[f32]> = keys.iter().map(|k| k.as_slice()).collect();
        let values_refs: Vec<&[f32]> = values.iter().map(|v| v.as_slice()).collect();

        let result_low = attn_low.compute(&query, &keys_refs, &values_refs).unwrap();
        let result_high = attn_high.compute(&query, &keys_refs, &values_refs).unwrap();

        // Low temperature should be more peaked (closer to [1,0,0...])
        // High temperature should be more uniform
        // We just verify both compute successfully
        assert_eq!(result_low.len(), 16);
        assert_eq!(result_high.len(), 16);
    }
}