Struct UmapConfig 

pub struct UmapConfig {
    pub n_neighbors: usize,
    pub n_epochs: usize,
    pub learning_rate: f64,
    pub negative_sample_rate: usize,
    pub category_weight: f64,
    pub min_dist: f64,
    pub warm_start_anchor: f64,
    pub seed: u64,
}

Knobs for UmapSphereProjection::fit. All defaults match the canonical UMAP paper unless noted.

Fields

n_neighbors: usize

Neighbors per point in the kNN graph that supplies the attractive term. Higher = preserve global structure, lower = preserve local clusters. UMAP default 15.

n_epochs: usize

Optimizer iterations. ~200 is enough for n<=2000; scale up roughly logarithmically.

learning_rate: f64

Adam base learning rate. Tangent-space gradients are bounded so 0.05 is safe even for tiny corpora.

negative_sample_rate: usize

Negative samples drawn per attractive edge per epoch.

category_weight: f64

Weight on the supervised category term (0.0 = disabled). When active, every epoch samples for each point one same-category partner (cohesion, attractive) and one different-category partner (separation, repulsive) — stratified so the cohesion half fires regardless of how many categories the corpus has. Only meaningful when categories is supplied to fit.

min_dist: f64

How tightly neighbors may pack in the layout — the canonical UMAP knob. At fit time the kernel parameters (a, b) of Phi(d) = 1/(1 + a·d^(2b)) are least-squares fitted from it (spread fixed at 1.0). On S², whose total area is fixed, this directly sets how much territory a cluster occupies; 0.0 reproduces near-maximal clumping (close to the historical hardcoded a = b = 1). UMAP default 0.1.

warm_start_anchor: f64

Weight on an attractive pull toward each point’s PCA warm-start position (0.0 = disabled). Use small values (~0.01–0.1) on sparse corpora whose kNN graphs fragment into disconnected components: the warm start places the components sensibly relative to each other, but with zero attraction between them, uniform negative sampling drifts them into an arbitrary arrangement over many epochs. The anchor keeps that global arrangement from drifting under unopposed repulsion.

seed: u64

PRNG seed for kNN tie-breaking, negative sampling, and fallback random init when PCA warm-start is degenerate.

Trait Implementations

impl Clone for UmapConfig

fn clone(&self) -> UmapConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UmapConfig

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

Formats the value using the given formatter.

impl Default for UmapConfig

fn default() -> Self

Returns the “default value” for a type.