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
//! Advanced Embedding Visualization Demo
//!
//! This example demonstrates comprehensive visualization capabilities for knowledge graph
//! embeddings, including:
//! - Multiple dimensionality reduction techniques (PCA, t-SNE, Random Projection)
//! - 2D and 3D visualizations
//! - Cluster coloring and labeling
//! - Export to various formats (CSV, JSON)
//! - Interactive analysis of embedding space
//!
//! # Visualization Techniques
//!
//! ## PCA (Principal Component Analysis)
//! - Linear transformation preserving maximum variance
//! - Fast and deterministic
//! - Good for initial exploration
//!
//! ## t-SNE (t-Distributed Stochastic Neighbor Embedding)
//! - Non-linear technique preserving local structure
//! - Reveals clusters and patterns
//! - Slower but more insightful
//!
//! ## Random Projection
//! - Very fast approximate dimensionality reduction
//! - Good for large datasets
//! - Less accurate but sufficient for quick visualization
//!
//! # Run this example
//!
//! ```bash
//! cargo run --example advanced_visualization_demo --features basic-models
//! ```

use anyhow::Result;
use oxirs_embed::{
    clustering::{ClusteringAlgorithm, ClusteringConfig, EntityClustering},
    visualization::{EmbeddingVisualizer, ReductionMethod, VisualizationConfig},
    EmbeddingModel, ModelConfig, NamedNode, TransE, Triple,
};
use std::collections::HashMap;
use std::fs::File;
use std::io::Write;

#[tokio::main]
async fn main() -> Result<()> {
    // Initialize logging
    tracing_subscriber::fmt::init();

    println!("╔════════════════════════════════════════════════════════╗");
    println!("║   Advanced Visualization Demo - Embedding Analysis     ║");
    println!("╚════════════════════════════════════════════════════════╝\n");

    // ====================
    // Step 1: Build Multi-Domain Knowledge Graph
    // ====================
    println!("📚 Step 1: Building Multi-Domain Knowledge Graph");
    println!("─────────────────────────────────────────────────────────");

    let config = ModelConfig {
        dimensions: 100,
        learning_rate: 0.01,
        max_epochs: 200,
        batch_size: 64,
        ..Default::default()
    };

    let mut model = TransE::new(config);

    // ANIMALS
    println!("  Adding animals domain...");
    add_triple(&mut model, "dog", "is_a", "mammal")?;
    add_triple(&mut model, "cat", "is_a", "mammal")?;
    add_triple(&mut model, "elephant", "is_a", "mammal")?;
    add_triple(&mut model, "whale", "is_a", "mammal")?;

    add_triple(&mut model, "eagle", "is_a", "bird")?;
    add_triple(&mut model, "sparrow", "is_a", "bird")?;
    add_triple(&mut model, "penguin", "is_a", "bird")?;

    add_triple(&mut model, "salmon", "is_a", "fish")?;
    add_triple(&mut model, "shark", "is_a", "fish")?;
    add_triple(&mut model, "tuna", "is_a", "fish")?;

    // COLORS
    println!("  Adding colors domain...");
    add_triple(&mut model, "red", "is_a", "color")?;
    add_triple(&mut model, "blue", "is_a", "color")?;
    add_triple(&mut model, "green", "is_a", "color")?;
    add_triple(&mut model, "yellow", "is_a", "color")?;

    add_triple(&mut model, "red", "similar_to", "orange")?;
    add_triple(&mut model, "blue", "similar_to", "cyan")?;
    add_triple(&mut model, "green", "similar_to", "lime")?;

    // FRUITS
    println!("  Adding fruits domain...");
    add_triple(&mut model, "apple", "is_a", "fruit")?;
    add_triple(&mut model, "banana", "is_a", "fruit")?;
    add_triple(&mut model, "orange", "is_a", "fruit")?;
    add_triple(&mut model, "strawberry", "is_a", "fruit")?;

    add_triple(&mut model, "apple", "has_color", "red")?;
    add_triple(&mut model, "banana", "has_color", "yellow")?;
    add_triple(&mut model, "orange", "has_color", "orange")?;

    // TECHNOLOGY
    println!("  Adding technology domain...");
    add_triple(&mut model, "python", "is_a", "language")?;
    add_triple(&mut model, "rust", "is_a", "language")?;
    add_triple(&mut model, "javascript", "is_a", "language")?;

    add_triple(&mut model, "linux", "is_a", "os")?;
    add_triple(&mut model, "windows", "is_a", "os")?;
    add_triple(&mut model, "macos", "is_a", "os")?;

    let stats = model.get_stats();
    println!("\n  Total entities: {}", stats.num_entities);
    println!("  Total relations: {}", stats.num_relations);
    println!("  Total triples: {}", stats.num_triples);
    println!();

    // ====================
    // Step 2: Train the Model
    // ====================
    println!("🎓 Step 2: Training Embedding Model");
    println!("─────────────────────────────────────────────────────────");

    let training_stats = model.train(Some(200)).await?;

    println!("  Epochs completed: {}", training_stats.epochs_completed);
    println!("  Final loss: {:.4}", training_stats.final_loss);
    println!(
        "  Training time: {:.2}s",
        training_stats.training_time_seconds
    );
    println!();

    // ====================
    // Step 3: Extract Embeddings
    // ====================
    println!("🔢 Step 3: Extracting Entity Embeddings");
    println!("─────────────────────────────────────────────────────────");

    let mut embeddings = HashMap::new();
    for entity in model.get_entities() {
        if let Ok(emb) = model.get_entity_embedding(&entity) {
            let array = scirs2_core::ndarray_ext::Array1::from_vec(emb.values);
            embeddings.insert(entity, array);
        }
    }

    println!("  Extracted {} embeddings", embeddings.len());
    println!("  Embedding dimensions: {}", stats.dimensions);
    println!();

    // ====================
    // Step 4: PCA Visualization
    // ====================
    println!("📊 Step 4: PCA Visualization (2D)");
    println!("─────────────────────────────────────────────────────────");

    let pca_config = VisualizationConfig {
        method: ReductionMethod::PCA,
        target_dims: 2,
        ..Default::default()
    };

    let mut pca_viz = EmbeddingVisualizer::new(pca_config);
    let pca_result = pca_viz.visualize(&embeddings)?;

    if let Some(ref variance) = pca_result.explained_variance {
        println!("  Explained variance:");
        for (i, var) in variance.iter().enumerate() {
            println!("    PC{}: {:.2}%", i + 1, var * 100.0);
        }
        let total: f32 = variance.iter().sum();
        println!("  Total explained: {:.2}%", total * 100.0);
    }

    // Save PCA results to CSV
    save_to_csv("pca_2d_embeddings.csv", &pca_result)?;
    println!("\n  ✓ Saved to pca_2d_embeddings.csv");
    println!();

    // ====================
    // Step 5: t-SNE Visualization
    // ====================
    println!("🎯 Step 5: t-SNE Visualization (2D)");
    println!("─────────────────────────────────────────────────────────");
    println!("  (This may take a minute for iterative optimization...)");

    let tsne_config = VisualizationConfig {
        method: ReductionMethod::TSNE,
        target_dims: 2,
        tsne_perplexity: 10.0,
        tsne_learning_rate: 200.0,
        max_iterations: 500,
        ..Default::default()
    };

    let mut tsne_viz = EmbeddingVisualizer::new(tsne_config);
    let tsne_result = tsne_viz.visualize(&embeddings)?;

    if let Some(loss) = tsne_result.final_loss {
        println!("\n  Final t-SNE loss: {:.4}", loss);
    }

    save_to_csv("tsne_2d_embeddings.csv", &tsne_result)?;
    println!("  ✓ Saved to tsne_2d_embeddings.csv");
    println!();

    // ====================
    // Step 6: Random Projection (Fast)
    // ====================
    println!("⚡ Step 6: Random Projection Visualization (2D)");
    println!("─────────────────────────────────────────────────────────");

    let rp_config = VisualizationConfig {
        method: ReductionMethod::RandomProjection,
        target_dims: 2,
        ..Default::default()
    };

    let mut rp_viz = EmbeddingVisualizer::new(rp_config);
    let rp_result = rp_viz.visualize(&embeddings)?;

    save_to_csv("random_projection_2d_embeddings.csv", &rp_result)?;
    println!("  ✓ Saved to random_projection_2d_embeddings.csv");
    println!();

    // ====================
    // Step 7: 3D PCA Visualization
    // ====================
    println!("🌐 Step 7: 3D PCA Visualization");
    println!("─────────────────────────────────────────────────────────");

    let pca_3d_config = VisualizationConfig {
        method: ReductionMethod::PCA,
        target_dims: 3,
        ..Default::default()
    };

    let mut pca_3d_viz = EmbeddingVisualizer::new(pca_3d_config);
    let pca_3d_result = pca_3d_viz.visualize(&embeddings)?;

    if let Some(ref variance) = pca_3d_result.explained_variance {
        println!("  Explained variance (3D):");
        for (i, var) in variance.iter().enumerate() {
            println!("    PC{}: {:.2}%", i + 1, var * 100.0);
        }
    }

    save_to_csv("pca_3d_embeddings.csv", &pca_3d_result)?;
    println!("  ✓ Saved to pca_3d_embeddings.csv");
    println!();

    // ====================
    // Step 8: Cluster Analysis with Visualization
    // ====================
    println!("🗂️  Step 8: Cluster Analysis");
    println!("─────────────────────────────────────────────────────────");

    let cluster_config = ClusteringConfig {
        algorithm: ClusteringAlgorithm::KMeans,
        num_clusters: 5,
        max_iterations: 100,
        ..Default::default()
    };

    let mut clustering = EntityClustering::new(cluster_config);
    let cluster_result = clustering.cluster(&embeddings)?;

    println!("  Number of clusters: {}", cluster_result.centroids.len());
    println!("  Silhouette score: {:.3}", cluster_result.silhouette_score);

    // Show cluster assignments by domain
    println!("\n  Cluster assignments:");
    let mut clusters_by_id: HashMap<usize, Vec<String>> = HashMap::new();
    for (entity, &cluster_id) in &cluster_result.assignments {
        clusters_by_id
            .entry(cluster_id)
            .or_default()
            .push(entity.clone());
    }

    for (cluster_id, entities) in clusters_by_id.iter() {
        println!("    Cluster {}: {:?}", cluster_id, entities);
    }

    // Save clustered PCA visualization
    save_clustered_to_csv(
        "pca_2d_with_clusters.csv",
        &pca_result,
        &cluster_result.assignments,
    )?;
    println!("\n  ✓ Saved clustered visualization to pca_2d_with_clusters.csv");
    println!();

    // ====================
    // Step 9: Embedding Space Analysis
    // ====================
    println!("🔍 Step 9: Embedding Space Analysis");
    println!("─────────────────────────────────────────────────────────");

    // Find nearest neighbors for sample entities
    let sample_entities = vec!["dog", "python", "apple"];

    for entity in sample_entities {
        if pca_result.coordinates.contains_key(entity) {
            println!("\n  Nearest neighbors to '{}' in PCA space:", entity);

            let entity_coords = &pca_result.coordinates[entity];
            let mut distances: Vec<(String, f32)> = pca_result
                .coordinates
                .iter()
                .filter(|(e, _)| *e != entity)
                .map(|(e, coords)| {
                    let dist = euclidean_distance(entity_coords, coords);
                    (e.clone(), dist)
                })
                .collect();

            distances.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap());

            for (neighbor, dist) in distances.iter().take(3) {
                println!("    {} (distance: {:.3})", neighbor, dist);
            }
        }
    }

    println!("\n╔════════════════════════════════════════════════════════╗");
    println!("║           Visualization Demo Completed!                ║");
    println!("╚════════════════════════════════════════════════════════╝\n");

    println!("📁 Generated Files:");
    println!("  • pca_2d_embeddings.csv - 2D PCA visualization");
    println!("  • tsne_2d_embeddings.csv - 2D t-SNE visualization");
    println!("  • random_projection_2d_embeddings.csv - Fast 2D projection");
    println!("  • pca_3d_embeddings.csv - 3D PCA visualization");
    println!("  • pca_2d_with_clusters.csv - Clustered 2D visualization");
    println!();

    println!("💡 Next Steps:");
    println!("  • Open CSV files in spreadsheet software");
    println!("  • Plot (x, y) coordinates to visualize embeddings");
    println!("  • Color by cluster_id to see semantic groupings");
    println!("  • Use 3D visualization tools for interactive exploration");
    println!();

    Ok(())
}

fn add_triple(model: &mut TransE, s: &str, p: &str, o: &str) -> Result<()> {
    model.add_triple(Triple::new(
        NamedNode::new(s)?,
        NamedNode::new(p)?,
        NamedNode::new(o)?,
    ))
}

fn save_to_csv(
    filename: &str,
    result: &oxirs_embed::visualization::VisualizationResult,
) -> Result<()> {
    let mut file = File::create(filename)?;

    // Write header
    if result.dimensions == 2 {
        writeln!(file, "entity,x,y")?;
    } else {
        writeln!(file, "entity,x,y,z")?;
    }

    // Write data
    for (entity, coords) in &result.coordinates {
        if coords.len() == 2 {
            writeln!(file, "{},{},{}", entity, coords[0], coords[1])?;
        } else if coords.len() == 3 {
            writeln!(file, "{},{},{},{}", entity, coords[0], coords[1], coords[2])?;
        }
    }

    Ok(())
}

fn save_clustered_to_csv(
    filename: &str,
    result: &oxirs_embed::visualization::VisualizationResult,
    clusters: &HashMap<String, usize>,
) -> Result<()> {
    let mut file = File::create(filename)?;

    // Write header
    writeln!(file, "entity,x,y,cluster_id")?;

    // Write data
    for (entity, coords) in &result.coordinates {
        let cluster_id = clusters.get(entity).unwrap_or(&0);
        writeln!(
            file,
            "{},{},{},{}",
            entity, coords[0], coords[1], cluster_id
        )?;
    }

    Ok(())
}

fn euclidean_distance(a: &[f32], b: &[f32]) -> f32 {
    a.iter()
        .zip(b.iter())
        .map(|(x, y)| (x - y).powi(2))
        .sum::<f32>()
        .sqrt()
}