manifolds-rs 0.3.3

Embedding methods implemented in Rust: (parametric) UMAP, tSNE, PHATE, Diffusion Map and PacMAP.
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

//! Errors that can occur in manifolds-rs

use thiserror::Error;

/// Errors that can be returned by manifolds-rs
#[derive(Debug, Error)]
pub enum ManifoldsError {
    // -- tSNE --
    /// Error when perplexity is set to high
    #[error("perplexity ({perplexity}) must be strictly less than the kNN size ({k})")]
    PerplexityTooLarge {
        /// Set perplexity parameter
        perplexity: f64,
        /// Found k-neighbours
        k: usize,
    },
    /// Dimensionality error for tSNE
    #[error("tSNE only supports n_dim = 2. Chosen dim = {n_dim}")]
    IncorrectDim {
        /// Set dimensions for tSNE
        n_dim: usize,
    },
    // -- sparse errors --
    /// Error if the sparse matrix is not of CSR
    #[error("The matrix is not of CSR type. Please double check the inputs")]
    SparseMatrixIsNotCsr,
    // -- sparse errors --
    /// Error for sparse multiplication dimension mismatches
    #[error("The dimensions of the matrix do not support sparse multiplication (matrix a n_col: {n_col_a}; matrix b n_row: {n_row_b})")]
    SparseMatrixMultiplication {
        /// Number of columns in matrix a
        n_col_a: usize,
        /// Number of rows in matrix b
        n_row_b: usize,
    },
    /// The matrix is not square, but should be.
    #[error("The sparse matrix must be square")]
    SpareMatrixMustBeSquare,
    /// Power value is not positive
    #[error("The chosen power must be positive, but is {power}.")]
    PowerMustBePositive {
        /// Chosen power by the user
        power: usize,
    },
    // -- ann-search-rs --
    /// Propagate errors from the ann-search-rs crate
    #[error("Error from the ann-search-rs crate: {0}")]
    AnnSearchRsError(#[from] ann_search_rs::errors::AnnSearchErrors),
    // -- math errors --
    /// Error for SVDs from faer
    #[error("The faer SVD failed - please verify the data")]
    FaerSvdError,
    /// Error for Eigen decomposition from faer
    #[error("The faer Eigen decomposition failed - please verify the data")]
    FaerEigenError,
    // -- input errors --
    /// Error if a square matrix is not square
    #[error("The matrix needs to be square")]
    NotSquareMatrix,

    /// Error if the data is empty
    #[error("Empty data was parsed through - upstream error?")]
    NoData,

    /// Error if the data is empty
    #[error("UMAP: no edges to optimise - upstream error?")]
    NoGraphEdges,
}