Struct Umap 

pub struct Umap { /* private fields */ }

UMAP configuration.

Holds hyperparameters for the UMAP algorithm. Calling Fit::fit computes the embedding and returns a FittedUmap.

Implementations

impl Umap

pub fn new() -> Self

Create a new Umap with default parameters.

Defaults: n_components=2, n_neighbors=15, min_dist=0.1, spread=1.0, learning_rate=1.0, n_epochs=200, metric=Euclidean, negative_sample_rate=5.

pub fn with_n_components(self, n: usize) -> Self

Set the number of embedding dimensions.

pub fn with_n_neighbors(self, k: usize) -> Self

Set the number of nearest neighbors.

pub fn with_min_dist(self, d: f64) -> Self

Set the minimum distance in the embedding.

pub fn with_spread(self, s: f64) -> Self

Set the spread.

pub fn with_learning_rate(self, lr: f64) -> Self

Set the learning rate.

pub fn with_n_epochs(self, n: usize) -> Self

Set the number of SGD epochs.

pub fn with_metric(self, m: UmapMetric) -> Self

Set the distance metric.

pub fn with_negative_sample_rate(self, rate: usize) -> Self

Set the negative sample rate.

pub fn with_random_state(self, seed: u64) -> Self

Set the random seed.

pub fn n_components(&self) -> usize

Return the configured number of components.

pub fn n_neighbors(&self) -> usize

Return the configured number of neighbors.

pub fn min_dist(&self) -> f64

Return the configured minimum distance.

pub fn spread(&self) -> f64

Return the configured spread.

pub fn learning_rate(&self) -> f64

Return the configured learning rate.

pub fn n_epochs(&self) -> usize

Return the configured number of epochs.

pub fn metric(&self) -> UmapMetric

Return the configured metric.

pub fn negative_sample_rate(&self) -> usize

Return the configured negative sample rate.

pub fn random_state(&self) -> Option<u64>

Return the configured random state, if any.

Trait Implementations

impl Clone for Umap

fn clone(&self) -> Umap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Umap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Umap

fn default() -> Self

Returns the “default value” for a type.

impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for Umap

fn fit(&self, x: &Array2<f64>, _y: &()) -> Result<FittedUmap, FerroError>

Fit UMAP by computing the fuzzy simplicial set and optimising the low-dimensional embedding via SGD.

Errors

• FerroError::InvalidParameter if n_components is zero, n_neighbors is zero or too large, min_dist is negative, spread is non-positive, or learning_rate is non-positive.
• FerroError::InsufficientSamples if there are fewer samples than n_neighbors + 1.

type Fitted = FittedUmap

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.