Skip to main content

UmapSphereProjection

Struct UmapSphereProjection 

Source
pub struct UmapSphereProjection { /* private fields */ }
Expand description

UMAP-style projection that lives on S² and transforms new points by kNN-weighted averaging over the fitted positions.

Implementations§

Source§

impl UmapSphereProjection

Source

pub fn fit_default(embeddings: &[Embedding]) -> Result<Self, ProjectionError>

Fit with default config and no categories.

Source

pub fn fit_from_graph( graph: &UmapGraph, categories: Option<&[u32]>, radial: RadialStrategy, config: UmapConfig, ) -> Result<Self, ProjectionError>

Optimize from a prebuilt kNN graph. This is the cheap part of UMAP fit — O(N·k·epochs) for the Adam optimizer. The graph is not rebuilt.

Use this when the tuner has already built the graph via UmapGraph::build and is sweeping n_epochs / category_weight.

Source

pub fn fit( embeddings: &[Embedding], categories: Option<&[u32]>, radial: RadialStrategy, config: UmapConfig, ) -> Result<Self, ProjectionError>

Fit with custom config. categories is parallel to embeddings when supplied; pass None to disable the supervised term even if config.category_weight > 0.

Equivalent to UmapGraph::build followed by Self::fit_from_graph — the tuner calls those two halves directly so it can reuse graphs across configs that share n_neighbors; this entry point serves every other caller.

Source

pub fn explained_variance_ratio(&self) -> f64

Post-fit quality: trustworthiness-style kNN recall. For each point, its k nearest neighbors among the fitted 3D positions (k = the graph’s n_neighbors) are intersected with its original-space kNN set; the score is the mean overlap fraction. Bounded [0, 1], where 1.0 means every original neighborhood survives the projection.

Intentionally exposed under the EVR name so the auto-tuner’s MetaModel consumers can compare projection kinds on one scalar. Note the semantics changed: this used to be the fraction of kNN edges shorter than the median random pairwise distance, a bar that random spherical pairs (≈90° apart) made trivially clearable, so scores saturated high and barely discriminated. Recall is rank-meaningful across corpora and more honest when compared against other projection kinds.

Trait Implementations§

Source§

impl Clone for UmapSphereProjection

Source§

fn clone(&self) -> UmapSphereProjection

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 From<UmapSphereProjection> for ConfiguredProjection

Source§

fn from(p: UmapSphereProjection) -> Self

Converts to this type from the input type.
Source§

impl Projection for UmapSphereProjection

Source§

fn project(&self, embedding: &Embedding) -> SphericalPoint

Source§

fn project_rich(&self, embedding: &Embedding) -> ProjectedPoint

Project with rich metadata: certainty, intensity, projection magnitude.
Source§

fn dimensionality(&self) -> usize

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more