fast-umap 1.5.1

Configurable UMAP (Uniform Manifold Approximation and Projection) in Rust
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

use crate::backend::AutodiffBackend;
#[cfg(feature = "plotters")]
use crate::chart;
use crate::{serialize, train, utils, UMAP};

// Re-export common utilities for easier use
#[cfg(feature = "plotters")]
pub use chart::{chart_tensor, chart_vector};

use crossbeam_channel::unbounded;
use num::Float;

// Re-export the new umap-rs style API
pub use crate::{
    GraphParams, ManifoldParams, Metric, OptimizationParams, UmapConfig,
};
pub use crate::FittedUmap as FittedUmapExport;

// Re-export legacy types for backward compatibility
pub use train::{TrainingConfig, TrainingConfigBuilder};
pub use utils::generate_test_data;

/// Convenience function for running UMAP with the WGPU backend.
///
/// This creates a `Umap` with default configuration (2-D output) and fits it
/// to the data.
///
/// # Arguments
/// * `data` - A vector of vectors, where each inner vector represents a data sample.
///
/// # Returns
/// A trained `UMAP` model (legacy type). For the new API, use
/// `Umap::new(UmapConfig::default()).fit(data, None)`.
///
/// # Example
/// ```rust,ignore
/// let data = vec![vec![1.0, 2.0, 3.0], vec![4.0, 5.0, 6.0]];
/// let model = umap(data);
/// ```
pub fn umap<B: AutodiffBackend, F: Float>(data: Vec<Vec<F>>) -> UMAP<B>
where
    F: num::FromPrimitive + burn::tensor::Element,
{
    let (exit_tx, exit_rx) = unbounded();

    ctrlc::set_handler(move || exit_tx.send(()).expect("Could not send signal on channel."))
        .expect("Error setting Ctrl-C handler");

    let output_size = 2;
    let device = Default::default();
    let model = UMAP::<B>::fit(data, device, output_size, exit_rx);
    model
}

/// Convenience function for running UMAP with a custom output size.
///
/// # Arguments
/// * `data` - A vector of vectors, where each inner vector represents a data sample.
/// * `output_size` - Number of dimensions for the reduced output.
///
/// # Returns
/// A trained `UMAP` model (legacy type). For the new API, use
/// `Umap::new(UmapConfig { n_components: output_size, ..Default::default() }).fit(data, None)`.
pub fn umap_size<B: AutodiffBackend, F: Float>(data: Vec<Vec<F>>, output_size: usize) -> UMAP<B>
where
    F: num::FromPrimitive + burn::tensor::Element,
{
    let (exit_tx, exit_rx) = unbounded();

    ctrlc::set_handler(move || exit_tx.send(()).expect("Could not send signal on channel."))
        .expect("Error setting Ctrl-C handler");

    let device = Default::default();
    let model = UMAP::<B>::fit(data, device, output_size, exit_rx);
    model
}