Struct Configuration

pub struct Configuration {
    pub embedding_dimensions: usize,
    pub initialization: Initialization,
    pub mid_near_ratio: f32,
    pub far_pair_ratio: f32,
    pub override_neighbors: Option<usize>,
    pub seed: Option<u64>,
    pub pair_configuration: PairConfiguration,
    pub learning_rate: f32,
    pub num_iters: (usize, usize, usize),
    pub snapshots: Option<Vec<usize>>,
    pub approx_threshold: usize,
}

Configuration options for the PaCMAP embedding process.

Controls initialization, sampling ratios, optimization parameters, and snapshot capture.

Fields

embedding_dimensions: usize

Number of dimensions in the output embedding space, typically 2 or 3

initialization: Initialization

Method for initializing the embedding coordinates

mid_near_ratio: f32

Ratio of mid-near pairs to nearest neighbor pairs

far_pair_ratio: f32

Ratio of far pairs to nearest neighbor pairs

override_neighbors: Option<usize>

Optional fixed neighbor count override

seed: Option<u64>

Optional random seed for reproducibility

pair_configuration: PairConfiguration

Controls how point pairs are sampled or provided

learning_rate: f32

Learning rate for the Adam optimizer

num_iters: (usize, usize, usize)

Number of iterations for attraction, local structure, and global structure phases

snapshots: Option<Vec<usize>>

Optional iteration indices at which to save embedding states

approx_threshold: usize

Number of points above which approximate neighbor search is used

Implementations

impl Configuration

pub fn builder() -> ConfigurationBuilder

Create an instance of Configuration using the builder syntax

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Self

Returns the “default value” for a type.