pub struct TensorPolynomialFeatures<State = Untrained> {
pub degree: u32,
pub n_dimensions: usize,
pub include_bias: bool,
pub interaction_only: bool,
pub tensor_ordering: TensorOrdering,
pub contraction_method: ContractionMethod,
/* private fields */
}Expand description
Tensor Product Polynomial Features
Generates tensor product polynomial features for multi-dimensional data. This captures higher-order interactions between features across multiple dimensions and feature groups.
§Parameters
degree- Maximum degree of polynomial features (default: 2)n_dimensions- Number of tensor dimensions (default: 2)include_bias- Include bias term (default: true)interaction_only- Include only interaction terms (default: false)tensor_ordering- Ordering scheme for tensor indicescontraction_method- Method for tensor contraction
§Examples
ⓘ
use sklears_kernel_approximation::tensor_polynomial::TensorPolynomialFeatures;
use sklears_core::traits::{Transform, Fit, Untrained}
use scirs2_core::ndarray::array;
let X = array![[1.0, 2.0], [3.0, 4.0]];
let tensor_poly = TensorPolynomialFeatures::new(2, 2);
let fitted_tensor = tensor_poly.fit(&X, &()).unwrap();
let X_transformed = fitted_tensor.transform(&X).unwrap();TensorPolynomialFeatures
Fields§
§degree: u32Maximum degree of polynomial features
n_dimensions: usizeNumber of tensor dimensions
include_bias: boolInclude bias term
interaction_only: boolInclude only interaction terms
tensor_ordering: TensorOrderingTensor index ordering
contraction_method: ContractionMethodTensor contraction method
Implementations§
Source§impl TensorPolynomialFeatures<Untrained>
impl TensorPolynomialFeatures<Untrained>
Sourcepub fn new(degree: u32, n_dimensions: usize) -> Self
pub fn new(degree: u32, n_dimensions: usize) -> Self
Create a new tensor polynomial features transformer
Sourcepub fn include_bias(self, include_bias: bool) -> Self
pub fn include_bias(self, include_bias: bool) -> Self
Set include_bias parameter
Sourcepub fn interaction_only(self, interaction_only: bool) -> Self
pub fn interaction_only(self, interaction_only: bool) -> Self
Set interaction_only parameter
Sourcepub fn tensor_ordering(self, ordering: TensorOrdering) -> Self
pub fn tensor_ordering(self, ordering: TensorOrdering) -> Self
Set tensor ordering
Sourcepub fn contraction_method(self, method: ContractionMethod) -> Self
pub fn contraction_method(self, method: ContractionMethod) -> Self
Set contraction method
Source§impl TensorPolynomialFeatures<Trained>
impl TensorPolynomialFeatures<Trained>
Sourcepub fn n_input_features(&self) -> usize
pub fn n_input_features(&self) -> usize
Get the number of input features
Sourcepub fn n_output_features(&self) -> usize
pub fn n_output_features(&self) -> usize
Get the number of output features
Sourcepub fn tensor_indices(&self) -> &[Vec<Vec<u32>>]
pub fn tensor_indices(&self) -> &[Vec<Vec<u32>>]
Get the tensor indices
Sourcepub fn contraction_map(&self) -> &[Vec<usize>]
pub fn contraction_map(&self) -> &[Vec<usize>]
Get the contraction map
Trait Implementations§
Source§impl<State: Clone> Clone for TensorPolynomialFeatures<State>
impl<State: Clone> Clone for TensorPolynomialFeatures<State>
Source§fn clone(&self) -> TensorPolynomialFeatures<State>
fn clone(&self) -> TensorPolynomialFeatures<State>
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<State: Debug> Debug for TensorPolynomialFeatures<State>
impl<State: Debug> Debug for TensorPolynomialFeatures<State>
Source§impl Estimator for TensorPolynomialFeatures<Untrained>
impl Estimator for TensorPolynomialFeatures<Untrained>
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
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>
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
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for TensorPolynomialFeatures<Untrained>
impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for TensorPolynomialFeatures<Untrained>
Source§type Fitted = TensorPolynomialFeatures<Trained>
type Fitted = TensorPolynomialFeatures<Trained>
The fitted model type
Source§fn fit(self, x: &Array2<Float>, _y: &()) -> Result<Self::Fitted>
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,
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
Auto Trait Implementations§
impl<State> Freeze for TensorPolynomialFeatures<State>
impl<State> RefUnwindSafe for TensorPolynomialFeatures<State>where
State: RefUnwindSafe,
impl<State> Send for TensorPolynomialFeatures<State>where
State: Send,
impl<State> Sync for TensorPolynomialFeatures<State>where
State: Sync,
impl<State> Unpin for TensorPolynomialFeatures<State>where
State: Unpin,
impl<State> UnwindSafe for TensorPolynomialFeatures<State>where
State: UnwindSafe,
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> 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<T> StableApi for Twhere
T: Estimator,
impl<T> StableApi for Twhere
T: Estimator,
Source§const STABLE_SINCE: &'static str = "0.1.0"
const STABLE_SINCE: &'static str = "0.1.0"
API version this type was stabilized in
Source§const HAS_EXPERIMENTAL_FEATURES: bool = false
const HAS_EXPERIMENTAL_FEATURES: bool = false
Whether this API has any experimental features