Skip to main content

KernelPCA

Struct KernelPCA 

Source
pub struct KernelPCA<State = Untrained> { /* private fields */ }
Expand description

Kernel Principal Component Analysis (Kernel PCA)

Non-linear dimensionality reduction through the use of kernels. It uses the kernel trick to perform PCA in a potentially infinite-dimensional feature space without explicitly computing the features.

§Examples

use sklears_decomposition::{KernelPCA, KernelFunction};
use sklears_core::traits::{Transform, Fit};
use scirs2_core::ndarray::array;

let x = array![
    [1.0, 2.0],
    [3.0, 4.0],
    [5.0, 6.0],
    [7.0, 8.0],
];

let kpca = KernelPCA::new()
    .n_components(2)
    .kernel(KernelFunction::Rbf { gamma: 0.1 })
    .fit(&x, &())?;

let x_transformed = kpca.transform(&x)?;

Implementations§

Source§

impl KernelPCA<Untrained>

Source

pub fn new() -> Self

Create a new Kernel PCA

Source

pub fn n_components(self, n_components: usize) -> Self

Set the number of components to keep

Source

pub fn kernel(self, kernel: KernelFunction) -> Self

Set the kernel function

Source

pub fn tol(self, tol: Float) -> Self

Set the tolerance for eigenvalue computation

Source

pub fn max_iter(self, max_iter: usize) -> Self

Set the maximum number of iterations

Source

pub fn center(self, center: bool) -> Self

Set whether to center the kernel matrix

Source

pub fn copy(self, copy: bool) -> Self

Set whether to copy the input data

Source

pub fn approximation(self, approximation: KernelApproximation) -> Self

Set the kernel matrix approximation method

Source

pub fn random_state(self, random_state: u64) -> Self

Set the random state for reproducible approximations

Source§

impl KernelPCA<Trained>

Source

pub fn eigenvalues(&self) -> &Array1<Float>

Get the eigenvalues

Source

pub fn eigenvectors(&self) -> &Array2<Float>

Get the eigenvectors (alphas)

Source

pub fn n_components(&self) -> usize

Get the number of components

Source

pub fn n_features_in(&self) -> usize

Get the number of features in the input

Source

pub fn n_samples(&self) -> usize

Get the number of samples in the training data

Source

pub fn x_fit(&self) -> &Array2<Float>

Get the training data

Source

pub fn inverse_transform( &self, x_transformed: &Array2<Float>, max_iter: usize, tol: Float, ) -> Result<Array2<Float>>

Pre-image reconstruction using fixed-point iteration

Reconstructs the original space representation from the transformed features. This is useful for understanding what the transformed features represent in the original input space.

§Arguments
  • x_transformed - The transformed data to reconstruct (n_samples, n_components)
  • max_iter - Maximum number of iterations for fixed-point iteration
  • tol - Tolerance for convergence
§Returns

Reconstructed data in original space (n_samples, n_features)

Source

pub fn mds_preimage( &self, x_transformed: &Array2<Float>, ) -> Result<Array2<Float>>

Multi-dimensional scaling (MDS) based pre-image approximation

An alternative pre-image reconstruction method using MDS to preserve distances in the original space.

Source§

impl KernelPCA<Untrained>

Kernel PCA with automatic kernel selection

Source

pub fn fit_with_kernel_selection( self, x: &Array2<Float>, kernel_candidates: Option<&[KernelFunction]>, cv_folds: usize, ) -> Result<KernelPCA<Trained>>

Fit Kernel PCA with automatic kernel selection

Trait Implementations§

Source§

impl<State: Clone> Clone for KernelPCA<State>

Source§

fn clone(&self) -> KernelPCA<State>

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<State: Debug> Debug for KernelPCA<State>

Source§

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

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

impl Default for KernelPCA<Untrained>

Source§

fn default() -> Self

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

impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for KernelPCA<Untrained>

Source§

type Fitted = KernelPCA<Trained>

The fitted model type
Source§

fn fit(self, x: &Array2<Float>, _y: &()) -> Result<Self::Fitted>

Fit the model to the provided data with validation
Source§

fn fit_with_validation( self, x: &X, y: &Y, _x_val: Option<&X>, _y_val: Option<&Y>, ) -> Result<(Self::Fitted, FitMetrics), SklearsError>
where Self: Sized,

Fit with custom validation and early stopping
Source§

impl Transform<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for KernelPCA<Trained>

Source§

fn transform(&self, x: &Array2<Float>) -> Result<Array2<Float>>

Transform the input data

Auto Trait Implementations§

§

impl<State> Freeze for KernelPCA<State>

§

impl<State> RefUnwindSafe for KernelPCA<State>
where State: RefUnwindSafe,

§

impl<State> Send for KernelPCA<State>
where State: Send,

§

impl<State> Sync for KernelPCA<State>
where State: Sync,

§

impl<State> Unpin for KernelPCA<State>
where State: Unpin,

§

impl<State> UnsafeUnpin for KernelPCA<State>

§

impl<State> UnwindSafe for KernelPCA<State>
where State: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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