FunctionTransformer

Struct FunctionTransformer 

Source
pub struct FunctionTransformer<F, G, State = Untrained>
where F: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync, G: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync,
{ /* private fields */ }
Expand description

FunctionTransformer applies arbitrary functions to transform data

This transformer is useful for stateless transformations such as taking the log, square root, or any other function. Unlike most other transformers, FunctionTransformer does not require fitting.

Implementations§

Source§

impl<F, G> FunctionTransformer<F, G, Untrained>
where F: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync, G: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync,

Source

pub fn new(func: F) -> Self

Create a new FunctionTransformer with the given function

Source

pub fn inverse_func(self, inverse_func: G) -> Self

Set the inverse function

Source

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

Set whether to check inverse

Source

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

Set whether to validate input

Source§

impl<F, G> FunctionTransformer<F, G, Trained>
where F: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync, G: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync,

Source

pub fn n_features_in(&self) -> usize

Get the number of input features

Source

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

Apply the inverse transformation

Trait Implementations§

Source§

impl<F, G> Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for FunctionTransformer<F, G, Untrained>
where F: Fn(&Array2<Float>) -> Result<Array2<Float>> + Clone + Send + Sync, G: Fn(&Array2<Float>) -> Result<Array2<Float>> + Clone + Send + Sync,

Source§

type Fitted = FunctionTransformer<F, G, 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<F, G> Transform<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for FunctionTransformer<F, G, Trained>
where F: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync, G: Fn(&Array2<Float>) -> Result<Array2<Float>> + Send + Sync,

Source§

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

Transform the input data

Auto Trait Implementations§

§

impl<F, G, State> Freeze for FunctionTransformer<F, G, State>
where F: Freeze, G: Freeze,

§

impl<F, G, State> RefUnwindSafe for FunctionTransformer<F, G, State>

§

impl<F, G, State> Send for FunctionTransformer<F, G, State>
where State: Send,

§

impl<F, G, State> Sync for FunctionTransformer<F, G, State>
where State: Sync,

§

impl<F, G, State> Unpin for FunctionTransformer<F, G, State>
where F: Unpin, State: Unpin, G: Unpin,

§

impl<F, G, State> UnwindSafe for FunctionTransformer<F, G, State>
where F: UnwindSafe, State: UnwindSafe, G: 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> 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, 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