SparsePolynomialFeatures

Struct SparsePolynomialFeatures 

Source
pub struct SparsePolynomialFeatures<State = Untrained> {
    pub degree: u32,
    pub interaction_only: bool,
    pub include_bias: bool,
    pub sparsity_strategy: SparsityStrategy,
    pub sparse_format: SparseFormat,
    pub sparsity_threshold: Float,
    /* private fields */
}
Expand description

Sparse Polynomial Features

Generates polynomial features using sparse matrix representations for memory-efficient computation, especially useful for high-dimensional polynomial feature spaces with many zero values.

§Parameters

  • degree - Maximum degree of polynomial features (default: 2)
  • interaction_only - Include only interaction features (default: false)
  • include_bias - Include bias column (default: true)
  • sparsity_strategy - Strategy for enforcing sparsity
  • sparse_format - Internal sparse matrix format
  • sparsity_threshold - Minimum absolute value to keep (for automatic sparsity)

§Examples

use sklears_kernel_approximation::sparse_polynomial::{SparsePolynomialFeatures, SparsityStrategy};
use sklears_core::traits::{Transform, Fit, Untrained}
use scirs2_core::ndarray::array;

let X = array![[1.0, 2.0], [3.0, 4.0]];

let sparse_poly = SparsePolynomialFeatures::new(2)
    .sparsity_strategy(SparsityStrategy::Absolute(0.1));
let fitted_sparse = sparse_poly.fit(&X, &()).unwrap();
let X_transformed = fitted_sparse.transform(&X).unwrap();

SparsePolynomialFeatures

Fields§

§degree: u32

Maximum degree of polynomial features

§interaction_only: bool

Include only interaction features

§include_bias: bool

Include bias column

§sparsity_strategy: SparsityStrategy

Sparsity enforcement strategy

§sparse_format: SparseFormat

Sparse matrix format

§sparsity_threshold: Float

Automatic sparsity threshold

Implementations§

Source§

impl SparsePolynomialFeatures<Untrained>

Source

pub fn new(degree: u32) -> Self

Create a new sparse polynomial features transformer

Source

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

Set interaction_only parameter

Source

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

Set include_bias parameter

Source

pub fn sparsity_strategy(self, strategy: SparsityStrategy) -> Self

Set sparsity strategy

Source

pub fn sparse_format(self, format: SparseFormat) -> Self

Set sparse matrix format

Source

pub fn sparsity_threshold(self, threshold: Float) -> Self

Set automatic sparsity threshold

Source§

impl SparsePolynomialFeatures<Trained>

Source

pub fn n_input_features(&self) -> usize

Get the number of input features

Source

pub fn n_output_features(&self) -> usize

Get the number of output features

Source

pub fn powers(&self) -> &[Vec<u32>]

Get the powers for each feature

Source

pub fn feature_indices(&self) -> &HashMap<Vec<u32>, usize>

Get the feature indices mapping

Source

pub fn transform_sparse(&self, x: &Array2<Float>) -> Result<SparseMatrix>

Transform and return as sparse matrix (more efficient for sparse data)

Source

pub fn memory_efficiency( &self, x: &Array2<Float>, ) -> Result<(usize, usize, Float)>

Estimate memory usage compared to dense representation

Trait Implementations§

Source§

impl<State: Clone> Clone for SparsePolynomialFeatures<State>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<State: Debug> Debug for SparsePolynomialFeatures<State>

Source§

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

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

impl Estimator for SparsePolynomialFeatures<Untrained>

Source§

type Config = ()

Configuration type for the estimator
Source§

type Error = SklearsError

Error type for the estimator
Source§

type Float = f64

The numeric type used by this estimator
Source§

fn config(&self) -> &Self::Config

Get estimator configuration
Source§

fn validate_config(&self) -> Result<(), SklearsError>

Validate estimator configuration with detailed error context
Source§

fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>

Check if estimator is compatible with given data dimensions
Source§

fn metadata(&self) -> EstimatorMetadata

Get estimator metadata
Source§

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

Source§

type Fitted = SparsePolynomialFeatures<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 SparsePolynomialFeatures<Trained>

Source§

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

Transform the input data

Auto Trait Implementations§

§

impl<State> Freeze for SparsePolynomialFeatures<State>

§

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

§

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

§

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

§

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

§

impl<State> UnwindSafe for SparsePolynomialFeatures<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<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> StableApi for T
where T: Estimator,

Source§

const STABLE_SINCE: &'static str = "0.1.0"

API version this type was stabilized in
Source§

const HAS_EXPERIMENTAL_FEATURES: bool = false

Whether this API has any experimental features
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