torsh-graph 0.1.3

Graph neural network components for ToRSh - powered by SciRS2
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
//! Functional operations and activations for graph neural networks

// Framework infrastructure - components designed for future use
#![allow(dead_code)]
use torsh_tensor::Tensor;

/// Leaky ReLU activation function
/// LeakyReLU(x) = max(0, x) + negative_slope * min(0, x)
pub fn leaky_relu(input: &Tensor, negative_slope: f64) -> Tensor {
    let zero_tensor = torsh_tensor::creation::zeros_like(input).expect("zeros_like should succeed");
    let positive_part = input.maximum(&zero_tensor).expect("maximum should succeed");
    let negative_part = input
        .minimum(&zero_tensor)
        .expect("minimum should succeed")
        .mul_scalar(negative_slope as f32)
        .expect("mul_scalar should succeed");
    positive_part
        .add(&negative_part)
        .expect("operation should succeed")
}

/// ELU (Exponential Linear Unit) activation function
/// ELU(x) = x if x > 0, alpha * (exp(x) - 1) if x <= 0
pub fn elu(input: &Tensor, alpha: f64) -> Tensor {
    let zero_tensor = torsh_tensor::creation::zeros_like(input).expect("zeros_like should succeed");
    let positive_part = input.maximum(&zero_tensor).expect("maximum should succeed");
    let negative_part = input.minimum(&zero_tensor).expect("minimum should succeed");
    let exp_part = negative_part
        .exp()
        .expect("exp should succeed")
        .sub_scalar(1.0)
        .expect("sub_scalar should succeed")
        .mul_scalar(alpha as f32)
        .expect("mul_scalar should succeed");
    positive_part
        .add(&exp_part)
        .expect("operation should succeed")
}

/// Swish activation function (also known as SiLU)
/// Swish(x) = x * sigmoid(x)
pub fn swish(input: &Tensor) -> Tensor {
    let one_tensor = torsh_tensor::creation::ones_like(input).expect("ones_like should succeed");
    let neg_input = input.neg().expect("neg should succeed");
    let exp_neg = neg_input.exp().expect("exp should succeed");
    let denominator = one_tensor.add(&exp_neg).expect("operation should succeed");
    let sigmoid = one_tensor
        .div(&denominator)
        .expect("operation should succeed");
    input.mul(&sigmoid).expect("operation should succeed")
}

/// GELU activation function (Gaussian Error Linear Unit)
/// GELU(x) = 0.5 * x * (1 + tanh(sqrt(2/π) * (x + 0.044715 * x^3)))
pub fn gelu(input: &Tensor) -> Tensor {
    let sqrt_2_over_pi = (2.0 / std::f64::consts::PI).sqrt() as f32;
    let coefficient = 0.044715_f32;

    let x_cubed = input.pow_scalar(3.0).expect("pow_scalar should succeed");
    let coeff_term = x_cubed
        .mul_scalar(coefficient)
        .expect("mul_scalar should succeed");
    let sum_term = input.add(&coeff_term).expect("operation should succeed");
    let inner = sum_term
        .mul_scalar(sqrt_2_over_pi)
        .expect("mul_scalar should succeed");
    let tanh_part = inner.tanh().expect("tanh should succeed");

    let one_tensor = torsh_tensor::creation::ones_like(input).expect("ones_like should succeed");
    let one_plus_tanh = one_tensor
        .add(&tanh_part)
        .expect("operation should succeed");
    let half_tensor = torsh_tensor::creation::ones_like(input)
        .expect("ones_like should succeed")
        .mul_scalar(0.5)
        .expect("mul_scalar should succeed");

    half_tensor
        .mul(input)
        .expect("operation should succeed")
        .mul(&one_plus_tanh)
        .expect("operation should succeed")
}

/// Mish activation function
/// Mish(x) = x * tanh(softplus(x)) = x * tanh(ln(1 + exp(x)))
pub fn mish(input: &Tensor) -> Tensor {
    let one_tensor = torsh_tensor::creation::ones_like(input).expect("ones_like should succeed");
    let exp_input = input.exp().expect("exp should succeed");
    let one_plus_exp = one_tensor
        .add(&exp_input)
        .expect("operation should succeed");
    let softplus = one_plus_exp.ln().expect("ln should succeed");
    let tanh_softplus = softplus.tanh().expect("tanh should succeed");
    input.mul(&tanh_softplus).expect("operation should succeed")
}

/// Graph-specific normalization functions
pub mod normalization {
    use super::*;

    /// Layer normalization for graph features
    /// Normalizes features across the feature dimension for each node
    pub fn layer_norm(input: &Tensor, eps: f64) -> Tensor {
        let shape = input.shape();
        let dims = shape.dims();
        let last_dim = dims.len() - 1;
        let mean = input
            .mean(Some(&[last_dim]), false)
            .expect("mean should succeed");

        // Create broadcast-compatible mean tensor
        let input_shape = dims.to_vec();
        let mut mean_shape = input_shape.clone();
        mean_shape[last_dim] = 1;

        let mean_expanded = mean.unsqueeze(-1).expect("unsqueeze should succeed");
        let mean_broadcasted = mean_expanded
            .expand(&input_shape)
            .expect("expand should succeed");
        let diff = input
            .sub(&mean_broadcasted)
            .expect("operation should succeed");

        let variance = diff
            .pow_scalar(2.0)
            .expect("pow_scalar should succeed")
            .mean(Some(&[last_dim]), false)
            .expect("mean should succeed");

        let variance_expanded = variance.unsqueeze(-1).expect("unsqueeze should succeed");
        let variance_broadcasted = variance_expanded
            .expand(&input_shape)
            .expect("expand should succeed");
        let eps_tensor = torsh_tensor::creation::ones_like(&variance_broadcasted)
            .expect("ones_like should succeed")
            .mul_scalar(eps as f32)
            .expect("mul_scalar should succeed");
        let variance_plus_eps = variance_broadcasted
            .add(&eps_tensor)
            .expect("operation should succeed");
        let std = variance_plus_eps.sqrt().expect("sqrt should succeed");
        diff.div(&std).expect("operation should succeed")
    }

    /// Graph normalization
    /// Normalizes node features by the square root of node degree
    pub fn graph_norm(input: &Tensor, edge_index: &Tensor, num_nodes: usize) -> Tensor {
        // Convert f32 edge_index to i64 for processing
        let edge_index_i32 = edge_index
            .to_i32_simd()
            .expect("to_i32_simd should succeed");
        let edge_index_i64 = edge_index_i32
            .to_i64_simd()
            .expect("to_i64_simd should succeed");
        let edge_data = crate::utils::tensor_to_vec2::<i64>(&edge_index_i64)
            .expect("tensor_to_vec2 should succeed");
        let mut degrees = vec![0.0_f32; num_nodes];

        for j in 0..edge_data[0].len() {
            let src = edge_data[0][j] as usize;
            let dst = edge_data[1][j] as usize;
            if src < num_nodes {
                degrees[src] += 1.0;
            }
            if dst < num_nodes {
                degrees[dst] += 1.0;
            }
        }

        // Create degree tensor and normalize
        let degree_tensor = torsh_tensor::creation::from_vec(
            degrees
                .iter()
                .map(|&d| if d > 0.0 { 1.0 / d.sqrt() } else { 0.0 })
                .collect(),
            &[num_nodes],
            torsh_core::device::DeviceType::Cpu,
        )
        .expect("from_vec degree_tensor should succeed");

        // Apply normalization - expand degree tensor to match input shape
        let input_shape_binding = input.shape();
        let input_shape = input_shape_binding.dims();
        let degree_expanded = degree_tensor
            .unsqueeze(-1)
            .expect("unsqueeze should succeed")
            .expand(input_shape)
            .expect("expand should succeed");
        input
            .mul(&degree_expanded)
            .expect("operation should succeed")
    }

    /// Batch normalization for graphs
    /// Normalizes features across the batch dimension
    pub fn batch_norm(input: &Tensor, eps: f64) -> Tensor {
        let mean = input.mean(Some(&[0]), true).expect("mean should succeed");
        let input_shape_binding = input.shape();
        let input_shape = input_shape_binding.dims();
        let mean_expanded = mean.expand(input_shape).expect("expand should succeed");
        let diff = input.sub(&mean_expanded).expect("operation should succeed");
        let variance = diff
            .pow_scalar(2.0)
            .expect("pow_scalar should succeed")
            .mean(Some(&[0]), true)
            .expect("mean should succeed");
        let eps_tensor = torsh_tensor::creation::ones_like(&variance)
            .expect("ones_like should succeed")
            .mul_scalar(eps as f32)
            .expect("mul_scalar should succeed");
        let variance_plus_eps = variance.add(&eps_tensor).expect("operation should succeed");
        let std = variance_plus_eps.sqrt().expect("sqrt should succeed");
        let std_expanded = std.expand(input_shape).expect("expand should succeed");
        diff.div(&std_expanded).expect("operation should succeed")
    }
}

/// Dropout function for regularization
pub fn dropout(input: &Tensor, p: f64, training: bool) -> Tensor {
    if !training || p == 0.0 {
        return input.clone();
    }

    if p == 1.0 {
        return torsh_tensor::creation::zeros_like(input).expect("zeros_like should succeed");
    }

    // Create dropout mask using simple thresholding
    let keep_prob = 1.0 - p;
    let random_tensor = torsh_tensor::creation::rand_like(input).expect("rand_like should succeed");
    let keep_prob_tensor = torsh_tensor::creation::ones_like(input)
        .expect("ones_like should succeed")
        .mul_scalar(keep_prob as f32)
        .expect("mul_scalar should succeed");

    // Create a mask by subtracting threshold and applying relu (values > 0 become positive, <= 0 become 0)
    let diff_tensor = random_tensor
        .sub(&keep_prob_tensor)
        .expect("operation should succeed");
    let mask_raw = diff_tensor.relu().expect("relu should succeed");

    // Normalize mask to 0 or 1 by checking if > 0, then convert to binary mask
    let zero_tensor = torsh_tensor::creation::zeros_like(input).expect("zeros_like should succeed");
    let _mask_binary = mask_raw.gt(&zero_tensor).expect("gt should succeed");

    // For now, let's use a simplified approach - just threshold the random tensor directly
    // This creates a binary effect where values above threshold are kept
    let inverted_prob = random_tensor
        .gt(&keep_prob_tensor)
        .expect("gt should succeed");
    let _ones_f32 = torsh_tensor::creation::ones_like(input).expect("ones_like should succeed");
    let _zeros_f32 = torsh_tensor::creation::zeros_like(input).expect("zeros_like should succeed");

    // Manual conversion from boolean to f32: if inverted_prob is true, use 0.0 (drop), else use 1.0 (keep)
    let inverted_data = inverted_prob.to_vec().expect("conversion should succeed");
    let keep_data: Vec<f32> = inverted_data
        .iter()
        .map(|&drop| if drop { 0.0 } else { 1.0 })
        .collect();
    let keep_mask =
        torsh_tensor::creation::from_vec(keep_data, input.shape().dims(), input.device())
            .expect("from_vec keep_mask should succeed");

    // Apply dropout with proper scaling
    let masked = input.mul(&keep_mask).expect("operation should succeed");
    masked
        .div_scalar(keep_prob as f32)
        .expect("div_scalar should succeed")
}

/// Attention mechanism functions
pub mod attention {
    use super::*;

    /// Scaled dot-product attention
    pub fn scaled_dot_product_attention(
        query: &Tensor,
        key: &Tensor,
        value: &Tensor,
        mask: Option<&Tensor>,
    ) -> Tensor {
        // Compute attention scores: Q @ K^T / sqrt(d_k)
        let binding = key.shape();
        let d_k = binding
            .dims()
            .last()
            .expect("collection should not be empty");
        let scale = 1.0 / (*d_k as f64).sqrt();
        let key_transposed = key.transpose(-2, -1).expect("transpose should succeed");
        let scores = query
            .matmul(&key_transposed)
            .expect("operation should succeed")
            .mul_scalar(scale as f32)
            .expect("mul_scalar should succeed");

        // Apply mask if provided
        let masked_scores = if let Some(mask) = mask {
            let large_neg = torsh_tensor::creation::ones_like(&scores)
                .expect("ones_like should succeed")
                .mul_scalar(-1e9_f32)
                .expect("mul_scalar should succeed");
            let mask_effect = mask.mul(&large_neg).expect("operation should succeed");
            scores.add(&mask_effect).expect("operation should succeed")
        } else {
            scores
        };

        // Apply softmax and compute attention output
        let attention_weights = masked_scores.softmax(-1).expect("softmax should succeed");
        attention_weights
            .matmul(value)
            .expect("operation should succeed")
    }

    /// Multi-head attention mechanism
    pub fn multi_head_attention(
        query: &Tensor,
        key: &Tensor,
        value: &Tensor,
        num_heads: usize,
        mask: Option<&Tensor>,
    ) -> Tensor {
        let batch_size = query.shape().dims()[0];
        let seq_len = query.shape().dims()[1];
        let d_model = query.shape().dims()[2];
        let d_k = d_model / num_heads;

        // Reshape for multi-head attention
        let q = query
            .view(&[
                batch_size as i32,
                seq_len as i32,
                num_heads as i32,
                d_k as i32,
            ])
            .expect("view should succeed")
            .transpose(1, 2)
            .expect("transpose should succeed");
        let k = key
            .view(&[
                batch_size as i32,
                seq_len as i32,
                num_heads as i32,
                d_k as i32,
            ])
            .expect("view should succeed")
            .transpose(1, 2)
            .expect("transpose should succeed");
        let v = value
            .view(&[
                batch_size as i32,
                seq_len as i32,
                num_heads as i32,
                d_k as i32,
            ])
            .expect("view should succeed")
            .transpose(1, 2)
            .expect("transpose should succeed");

        // Apply scaled dot-product attention
        let attention_output = scaled_dot_product_attention(&q, &k, &v, mask);

        // Reshape back to original dimensions
        attention_output
            .transpose(1, 2)
            .expect("transpose should succeed")
            .contiguous()
            .expect("contiguous should succeed")
            .view(&[batch_size as i32, seq_len as i32, d_model as i32])
            .expect("view should succeed")
    }
}

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

    #[test]
    fn test_leaky_relu() {
        let input = torsh_tensor::creation::from_vec(
            vec![-2.0, -1.0, 0.0, 1.0, 2.0],
            &[5],
            torsh_core::device::DeviceType::Cpu,
        )
        .unwrap();

        let output = leaky_relu(&input, 0.01);
        let expected = vec![-0.02, -0.01, 0.0, 1.0, 2.0];

        let output_vec = output.to_vec().expect("conversion should succeed");
        for (actual, expected) in output_vec.iter().zip(expected.iter()) {
            assert_relative_eq!(actual, expected, epsilon = 1e-6);
        }
    }

    #[test]
    fn test_elu() {
        let input = torsh_tensor::creation::from_vec(
            vec![-1.0, 0.0, 1.0],
            &[3],
            torsh_core::device::DeviceType::Cpu,
        )
        .unwrap();

        let output = elu(&input, 1.0);
        let output_vec = output.to_vec().expect("conversion should succeed");

        // For x > 0, ELU(x) = x
        assert_relative_eq!(output_vec[2], 1.0, epsilon = 1e-6);

        // For x = 0, ELU(x) = 0
        assert_relative_eq!(output_vec[1], 0.0, epsilon = 1e-6);

        // For x < 0, ELU(x) = alpha * (exp(x) - 1)
        let expected_negative = 1.0 * ((-1.0_f32).exp() - 1.0);
        assert_relative_eq!(output_vec[0], expected_negative, epsilon = 1e-6);
    }

    #[test]
    fn test_swish() {
        let input = torsh_tensor::creation::from_vec(
            vec![0.0, 1.0, -1.0],
            &[3],
            torsh_core::device::DeviceType::Cpu,
        )
        .unwrap();

        let output = swish(&input);
        let output_vec = output.to_vec().expect("conversion should succeed");

        // Swish(0) = 0 * sigmoid(0) = 0 * 0.5 = 0
        assert_relative_eq!(output_vec[0], 0.0, epsilon = 1e-6);

        // Swish(1) = 1 * sigmoid(1) ≈ 1 * 0.731 ≈ 0.731
        let sigmoid_1 = 1.0 / (1.0 + (-1.0_f32).exp());
        assert_relative_eq!(output_vec[1], sigmoid_1, epsilon = 1e-6);
    }

    #[test]
    fn test_layer_norm() {
        let input = torsh_tensor::creation::from_vec(
            vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0],
            &[2, 3],
            torsh_core::device::DeviceType::Cpu,
        )
        .unwrap();

        let output = normalization::layer_norm(&input, 1e-8);

        // Check that each row is normalized (mean ≈ 0, std ≈ 1)
        let output_2d = crate::utils::tensor_to_vec2::<f32>(&output).unwrap();

        for row in output_2d {
            let mean: f32 = row.iter().sum::<f32>() / row.len() as f32;
            let var: f32 = row.iter().map(|&x| (x - mean).powi(2)).sum::<f32>() / row.len() as f32;

            assert_relative_eq!(mean, 0.0, epsilon = 1e-6);
            assert_relative_eq!(var.sqrt(), 1.0, epsilon = 1e-6);
        }
    }

    #[test]
    fn test_dropout() {
        let input = torsh_tensor::creation::ones(&[100]).unwrap();

        // Test training mode with 0.5 dropout
        let output_training = dropout(&input, 0.5, true);
        let output_vec = output_training.to_vec().expect("conversion should succeed");

        // Should have approximately 50% zeros and 50% values scaled by 2.0
        let num_zeros = output_vec.iter().filter(|&&x| x == 0.0).count();
        let num_nonzeros = output_vec.iter().filter(|&&x| x != 0.0).count();

        assert!(num_zeros > 30 && num_zeros < 70); // Roughly 50% with some variance
        assert!(num_nonzeros > 30 && num_nonzeros < 70);

        // Test eval mode (no dropout)
        let output_eval = dropout(&input, 0.5, false);
        let output_eval_vec = output_eval.to_vec().expect("conversion should succeed");
        assert!(output_eval_vec.iter().all(|&x| x == 1.0));
    }
}