Skip to main content

PaCMAPConfig

Struct PaCMAPConfig 

Source
pub struct PaCMAPConfig {
    pub n_neighbors: usize,
    pub mn_ratio: f32,
    pub fp_ratio: f32,
    pub phase_iters: [usize; 3],
    pub learning_rate: f32,
    pub init: Init,
    pub seed: Option<u64>,
    pub knn_method: KnnMethod,
    pub distance_metric: DistanceMetric,
    pub optimize_backend: OptimizeBackend,
}
Expand description

Full configuration for a fit_transform call.

Fields§

§n_neighbors: usize

Number of near-neighbour pairs per point. Default 10.

§mn_ratio: f32

Ratio nMN / n_neighbors. Default 0.5.

§fp_ratio: f32

Ratio nFP / n_neighbors. Default 2.0.

§phase_iters: [usize; 3]

Iteration counts for phases [1, 2, 3]. Sum = total iterations. Default [100, 100, 250].

§learning_rate: f32

Adam learning rate. Default 1.0.

§init: Init

Embedding initialisation. Default Init::Pca.

§seed: Option<u64>

Random seed for reproducible runs.

§knn_method: KnnMethod

KNN method. Default HNSW when the hnsw feature is enabled.

§distance_metric: DistanceMetric

Distance metric. Default Euclidean.

§optimize_backend: OptimizeBackend

Optimize backend. Default OptimizeBackend::Cpu.

Implementations§

Source§

impl PaCMAPConfig

Source

pub fn n_mn(&self) -> usize

Derived: number of mid-near pairs per point = floor(n_neighbors * mn_ratio).

Source

pub fn n_fp(&self) -> usize

Derived: number of further pairs per point = floor(n_neighbors * fp_ratio).

Source

pub fn total_iters(&self) -> usize

Total optimization iterations across all phases.

Trait Implementations§

Source§

impl Clone for PaCMAPConfig

Source§

fn clone(&self) -> PaCMAPConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PaCMAPConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PaCMAPConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V