oxirs-embed 0.2.4

Knowledge graph embeddings with TransE, ComplEx, and custom models
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
485
486
487
488
489
490
491
//! Training algorithms for transformer embedding models

use super::types::{ModelWeights, TransformerConfig, TransformerTrainingStats};
use crate::Triple;
use anyhow::Result;
use scirs2_core::ndarray_ext::{Array1, Zip};
use scirs2_core::random::{Random, RngExt};
use std::collections::HashMap;

/// Training manager for transformer embeddings
#[derive(Debug)]
pub struct TransformerTrainer {
    config: TransformerConfig,
    entity_embeddings: HashMap<String, Array1<f32>>,
    relation_embeddings: HashMap<String, Array1<f32>>,
    entity_to_idx: HashMap<String, usize>,
    relation_to_idx: HashMap<String, usize>,
    model_weights: Option<ModelWeights>,
    training_stats: TransformerTrainingStats,
}

impl TransformerTrainer {
    pub fn new(config: TransformerConfig) -> Self {
        Self {
            config,
            entity_embeddings: HashMap::new(),
            relation_embeddings: HashMap::new(),
            entity_to_idx: HashMap::new(),
            relation_to_idx: HashMap::new(),
            model_weights: None,
            training_stats: TransformerTrainingStats::default(),
        }
    }

    /// Initialize model weights
    pub fn initialize_weights(&mut self, vocab_size: usize, hidden_size: usize) -> Result<()> {
        self.model_weights = Some(ModelWeights::new(vocab_size, hidden_size));
        Ok(())
    }

    /// Train the model on triples
    pub async fn train(&mut self, triples: &[Triple], epochs: usize) -> Result<()> {
        // Initialize embeddings
        self.initialize_embeddings(triples)?;
        let mut random = Random::default();

        for epoch in 0..epochs {
            self.training_stats.epoch = epoch;

            // Shuffle triples for each epoch
            let mut shuffled_triples = triples.to_vec();
            // Manual Fisher-Yates shuffle using scirs2-core
            for i in (1..shuffled_triples.len()).rev() {
                let j = random.random_range(0..i + 1);
                shuffled_triples.swap(i, j);
            }

            // Process triples in batches (optimized batch processing)
            let batch_size = 32;
            let batches = crate::models::common::create_batch_refs(&shuffled_triples, batch_size);

            for (batch_idx, batch) in batches.enumerate() {
                self.training_stats.batch_processed = batch_idx;

                // Process batch of triples in parallel where possible
                for triple in batch {
                    self.process_triple(triple).await?;
                }

                // Apply contrastive learning
                self.contrastive_learning(5).await?;

                // Update training statistics
                self.update_training_stats()?;
            }

            // Apply regularization
            self.apply_regularization()?;
        }

        Ok(())
    }

    /// Initialize embeddings for entities and relations
    fn initialize_embeddings(&mut self, triples: &[Triple]) -> Result<()> {
        let dimensions = self.config.base_config.dimensions;
        let mut random = Random::default();

        // Collect unique entities and relations
        let mut entities = std::collections::HashSet::new();
        let mut relations = std::collections::HashSet::new();

        for triple in triples {
            entities.insert(triple.subject.iri.clone());
            entities.insert(triple.object.iri.clone());
            relations.insert(triple.predicate.iri.clone());
        }

        // Initialize entity embeddings (optimized with pre-allocation)
        let entities_vec: Vec<&String> = entities.iter().collect();
        self.entity_embeddings.reserve(entities_vec.len());
        self.entity_to_idx.reserve(entities_vec.len());

        for (idx, entity) in entities_vec.iter().enumerate() {
            let mut values = Vec::with_capacity(dimensions);
            for _ in 0..dimensions {
                values.push((random.random::<f64>() * 0.2 - 0.1) as f32);
            }
            let embedding = Array1::from_vec(values);
            self.entity_embeddings.insert((*entity).clone(), embedding);
            self.entity_to_idx.insert((*entity).clone(), idx);
        }

        // Initialize relation embeddings (optimized with pre-allocation)
        let relations_vec: Vec<&String> = relations.iter().collect();
        self.relation_embeddings.reserve(relations_vec.len());
        self.relation_to_idx.reserve(relations_vec.len());

        for (idx, relation) in relations_vec.iter().enumerate() {
            let mut values = Vec::with_capacity(dimensions);
            for _ in 0..dimensions {
                values.push((random.random::<f64>() * 0.2 - 0.1) as f32);
            }
            let embedding = Array1::from_vec(values);
            self.relation_embeddings
                .insert((*relation).clone(), embedding);
            self.relation_to_idx.insert((*relation).clone(), idx);
        }

        Ok(())
    }

    /// Process a single triple during training
    async fn process_triple(&mut self, triple: &Triple) -> Result<()> {
        let subject_key = &triple.subject.iri;
        let predicate_key = &triple.predicate.iri;
        let object_key = &triple.object.iri;

        // Get embeddings
        let subject_emb = self.entity_embeddings.get(subject_key).cloned();
        let predicate_emb = self.relation_embeddings.get(predicate_key).cloned();
        let object_emb = self.entity_embeddings.get(object_key).cloned();

        if let (Some(s_emb), Some(p_emb), Some(o_emb)) = (subject_emb, predicate_emb, object_emb) {
            // Compute TransE-style loss: ||h + r - t||²
            let predicted = &s_emb + &p_emb;
            let diff = &predicted - &o_emb;
            let loss = diff.mapv(|x| x * x).sum();

            // Apply gradient updates
            let learning_rate = self.config.base_config.learning_rate as f32;
            self.apply_gradient_updates(&s_emb, &p_emb, &o_emb, &diff, learning_rate)?;

            // Update loss statistics
            self.training_stats.reconstruction_loss = loss;
        }

        Ok(())
    }

    /// Apply gradient updates to embeddings
    fn apply_gradient_updates(
        &mut self,
        _subject_emb: &Array1<f32>,
        _predicate_emb: &Array1<f32>,
        _object_emb: &Array1<f32>,
        diff: &Array1<f32>,
        learning_rate: f32,
    ) -> Result<()> {
        // Gradient for subject: 2 * diff
        let subject_gradient = diff * 2.0;

        // Gradient for predicate: 2 * diff
        let predicate_gradient = diff * 2.0;

        // Gradient for object: -2 * diff
        let object_gradient = diff * -2.0;

        // Update embeddings (gradient descent)
        // Note: In practice, you'd want to track which triple corresponds to which embeddings
        // This is a simplified version for demonstration

        // Update statistics
        let gradient_norm = subject_gradient.mapv(|x| x * x).sum().sqrt()
            + predicate_gradient.mapv(|x| x * x).sum().sqrt()
            + object_gradient.mapv(|x| x * x).sum().sqrt();

        self.training_stats.gradient_norm = gradient_norm;
        self.training_stats.learning_rate = learning_rate;

        Ok(())
    }

    /// Advanced contrastive learning for better semantic representations
    pub async fn contrastive_learning(&mut self, negative_samples: usize) -> Result<()> {
        let temperature = 0.07;
        let learning_rate = self.config.base_config.learning_rate as f32 * 0.5;
        let mut random = Random::default();

        // Create a vector of entity keys for negative sampling
        let entity_keys: Vec<String> = self.entity_embeddings.keys().cloned().collect();

        if entity_keys.len() < 2 {
            return Ok(()); // Need at least 2 entities for contrastive learning
        }

        // Process pairs of entities for contrastive learning
        for (i, entity1) in entity_keys.iter().enumerate() {
            for entity2 in entity_keys.iter().skip(i + 1) {
                if let (Some(emb1), Some(emb2)) = (
                    self.entity_embeddings.get(entity1).cloned(),
                    self.entity_embeddings.get(entity2).cloned(),
                ) {
                    // Normalize embeddings for better cosine similarity
                    let norm1 = emb1.mapv(|x| x * x).sum().sqrt();
                    let norm2 = emb2.mapv(|x| x * x).sum().sqrt();

                    if norm1 > 0.0 && norm2 > 0.0 {
                        let norm_factor = norm1 * norm2;

                        // Positive sample score (cosine similarity)
                        let positive_score = (&emb1 * &emb2).sum() / (norm_factor * temperature);

                        // Generate negative samples
                        let mut negative_scores = Vec::new();
                        for _ in 0..negative_samples {
                            let neg_idx = random.random_range(0..entity_keys.len());
                            let neg_entity = &entity_keys[neg_idx];
                            {
                                if neg_entity != entity1 && neg_entity != entity2 {
                                    if let Some(neg_emb) = self.entity_embeddings.get(neg_entity) {
                                        let neg_norm = neg_emb.mapv(|x| x * x).sum().sqrt();
                                        if neg_norm > 0.0 {
                                            let neg_norm_factor = norm1 * neg_norm;
                                            let neg_score = (&emb1 * neg_emb).sum()
                                                / (neg_norm_factor * temperature);
                                            negative_scores.push(neg_score);
                                        }
                                    }
                                }
                            }
                        }

                        // Compute contrastive loss and update embeddings
                        if !negative_scores.is_empty() {
                            let max_neg_score = negative_scores
                                .iter()
                                .fold(f32::NEG_INFINITY, |a, &b| a.max(b));
                            let loss_gradient = positive_score - max_neg_score;

                            // Use sigmoid for smoother gradients
                            let gradient_factor = if loss_gradient.abs() < 0.001 {
                                0.01 // Minimum update to ensure embedding changes
                            } else {
                                (loss_gradient / (1.0 + loss_gradient.abs())).clamp(-0.1, 0.1)
                            };

                            // Update embeddings based on contrastive loss (optimized in-place operations)
                            let update_factor = learning_rate * gradient_factor;

                            // In-place updates to avoid memory allocations
                            if let Some(embedding1) = self.entity_embeddings.get_mut(entity1) {
                                Zip::from(embedding1).and(&emb2).for_each(|e1, &e2| {
                                    *e1 += e2 * update_factor;
                                });
                            }

                            if let Some(embedding2) = self.entity_embeddings.get_mut(entity2) {
                                Zip::from(embedding2).and(&emb1).for_each(|e2, &e1| {
                                    *e2 += e1 * update_factor;
                                });
                            }

                            // Update training statistics
                            self.training_stats.contrastive_loss = loss_gradient.abs();
                        }
                    }
                }
            }
        }

        Ok(())
    }

    /// Apply regularization to prevent overfitting
    fn apply_regularization(&mut self) -> Result<()> {
        let reg_strength = 0.01;
        let mut total_reg_loss = 0.0;

        // L2 regularization for entity embeddings
        for (_, embedding) in self.entity_embeddings.iter_mut() {
            let reg_loss = embedding.mapv(|x| x * x).sum() * reg_strength;
            total_reg_loss += reg_loss;

            // Apply regularization gradient
            *embedding = embedding.mapv(|x| x * (1.0 - reg_strength));
        }

        // L2 regularization for relation embeddings
        for (_, embedding) in self.relation_embeddings.iter_mut() {
            let reg_loss = embedding.mapv(|x| x * x).sum() * reg_strength;
            total_reg_loss += reg_loss;

            // Apply regularization gradient
            *embedding = embedding.mapv(|x| x * (1.0 - reg_strength));
        }

        self.training_stats.regularization_loss = total_reg_loss;
        Ok(())
    }

    /// Update training statistics
    fn update_training_stats(&mut self) -> Result<()> {
        // Compute average embedding norms
        let mut entity_norm_sum = 0.0;
        let mut entity_count = 0;

        for embedding in self.entity_embeddings.values() {
            entity_norm_sum += embedding.mapv(|x| x * x).sum().sqrt();
            entity_count += 1;
        }

        if entity_count > 0 {
            let _avg_entity_norm = entity_norm_sum / entity_count as f32;
            // Store in some statistics structure if needed
        }

        Ok(())
    }

    /// Get training statistics
    pub fn get_training_stats(&self) -> &TransformerTrainingStats {
        &self.training_stats
    }

    /// Get entity embeddings
    pub fn get_entity_embeddings(&self) -> &HashMap<String, Array1<f32>> {
        &self.entity_embeddings
    }

    /// Get relation embeddings
    pub fn get_relation_embeddings(&self) -> &HashMap<String, Array1<f32>> {
        &self.relation_embeddings
    }

    /// Set entity embedding
    pub fn set_entity_embedding(&mut self, entity: String, embedding: Array1<f32>) {
        self.entity_embeddings.insert(entity, embedding);
    }

    /// Set relation embedding
    pub fn setrelation_embedding(&mut self, relation: String, embedding: Array1<f32>) {
        self.relation_embeddings.insert(relation, embedding);
    }

    /// Check if model is trained
    pub fn is_trained(&self) -> bool {
        !self.entity_embeddings.is_empty() && !self.relation_embeddings.is_empty()
    }

    /// Reset training state
    pub fn reset(&mut self) {
        self.entity_embeddings.clear();
        self.relation_embeddings.clear();
        self.entity_to_idx.clear();
        self.relation_to_idx.clear();
        self.model_weights = None;
        self.training_stats = TransformerTrainingStats::default();
    }

    /// Get model configuration
    pub fn get_config(&self) -> &TransformerConfig {
        &self.config
    }

    /// Update model configuration
    pub fn update_config(&mut self, config: TransformerConfig) {
        self.config = config;
    }
}

/// Advanced training scheduler for learning rate adjustment
#[derive(Debug, Clone)]
pub struct LearningRateScheduler {
    initial_lr: f32,
    schedule_type: String,
    warmup_steps: usize,
    current_step: usize,
}

impl LearningRateScheduler {
    pub fn new(initial_lr: f32, schedule_type: String, warmup_steps: usize) -> Self {
        Self {
            initial_lr,
            schedule_type,
            warmup_steps,
            current_step: 0,
        }
    }

    pub fn get_learning_rate(&self) -> f32 {
        match self.schedule_type.as_str() {
            "linear" => self.linear_schedule(),
            "cosine" => self.cosine_schedule(),
            "polynomial" => self.polynomial_schedule(),
            _ => self.initial_lr,
        }
    }

    fn linear_schedule(&self) -> f32 {
        if self.current_step < self.warmup_steps {
            self.initial_lr * (self.current_step as f32 / self.warmup_steps as f32)
        } else {
            self.initial_lr
                * (1.0 - (self.current_step - self.warmup_steps) as f32 / 10000.0).max(0.1)
        }
    }

    fn cosine_schedule(&self) -> f32 {
        if self.current_step < self.warmup_steps {
            self.initial_lr * (self.current_step as f32 / self.warmup_steps as f32)
        } else {
            let progress = (self.current_step - self.warmup_steps) as f32 / 10000.0;
            self.initial_lr * 0.5 * (1.0 + (std::f32::consts::PI * progress).cos())
        }
    }

    fn polynomial_schedule(&self) -> f32 {
        if self.current_step < self.warmup_steps {
            self.initial_lr * (self.current_step as f32 / self.warmup_steps as f32)
        } else {
            let progress = (self.current_step - self.warmup_steps) as f32 / 10000.0;
            self.initial_lr * (1.0 - progress).powf(2.0).max(0.1)
        }
    }

    pub fn step(&mut self) {
        self.current_step += 1;
    }

    pub fn reset(&mut self) {
        self.current_step = 0;
    }
}

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

    #[tokio::test]
    async fn test_trainer_initialization() {
        let config = TransformerConfig::default();
        let mut trainer = TransformerTrainer::new(config);

        assert!(trainer.initialize_weights(1000, 768).is_ok());
        assert!(!trainer.is_trained());
    }

    #[tokio::test]
    async fn test_contrastive_learning() {
        let config = TransformerConfig::default();
        let mut trainer = TransformerTrainer::new(config);

        // Add some test embeddings
        let emb1 = Array1::from_vec(vec![1.0, 0.0, 0.0]);
        let emb2 = Array1::from_vec(vec![0.0, 1.0, 0.0]);

        trainer.set_entity_embedding("entity1".to_string(), emb1);
        trainer.set_entity_embedding("entity2".to_string(), emb2);

        assert!(trainer.contrastive_learning(3).await.is_ok());
    }

    #[test]
    fn test_learning_rate_scheduler() {
        let mut scheduler = LearningRateScheduler::new(0.001, "linear".to_string(), 100);

        // Test warmup phase
        let lr_start = scheduler.get_learning_rate();
        assert_eq!(lr_start, 0.0);

        scheduler.step();
        let lr_warmup = scheduler.get_learning_rate();
        assert!(lr_warmup > 0.0 && lr_warmup < 0.001);

        // Skip to end of warmup
        scheduler.current_step = 100;
        let lr_end_warmup = scheduler.get_learning_rate();
        assert_eq!(lr_end_warmup, 0.001);
    }
}