pub struct UmapConfig {
pub n_components: usize,
pub manifold: ManifoldParams,
pub graph: GraphParams,
pub optimization: OptimizationParams,
}Expand description
Complete UMAP configuration.
Groups all parameters for dimensionality reduction into a coherent structure. All parameter groups have sensible defaults and can be customized individually.
§Example
ⓘ
use umap::config::{UmapConfig, GraphParams};
// Use all defaults
let config = UmapConfig::default();
// Customize specific groups
let config = UmapConfig {
n_components: 3,
graph: GraphParams {
n_neighbors: 30,
..Default::default()
},
..Default::default()
};Fields§
§n_components: usizeNumber of dimensions in the output embedding.
Typically 2 for visualization or 3-50 for downstream ML tasks.
Must be >= 1.
Default: 2
manifold: ManifoldParamsManifold shape configuration.
graph: GraphParamsGraph construction configuration.
optimization: OptimizationParamsOptimization configuration.
Trait Implementations§
Source§impl Clone for UmapConfig
impl Clone for UmapConfig
Source§fn clone(&self) -> UmapConfig
fn clone(&self) -> UmapConfig
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for UmapConfig
impl Debug for UmapConfig
Source§impl Default for UmapConfig
impl Default for UmapConfig
Source§impl<'de> Deserialize<'de> for UmapConfig
impl<'de> Deserialize<'de> for UmapConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for UmapConfig
impl RefUnwindSafe for UmapConfig
impl Send for UmapConfig
impl Sync for UmapConfig
impl Unpin for UmapConfig
impl UnwindSafe for UmapConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.