Struct linfa_preprocessing::linear_scaling::LinearScalerParams

pub struct LinearScalerParams<F: Float> { /* private fields */ }

Linear Scaler: learns scaling parameters, according to the specified method, from a dataset, producing a fitted linear scaler that can be used to scale different datasets using the same parameters.

Example

use linfa::traits::{Fit, Transformer};
use linfa_preprocessing::linear_scaling::LinearScaler;

// Load dataset
let dataset = linfa_datasets::diabetes();
// Learn scaling parameters
let scaler = LinearScaler::standard().fit(&dataset).unwrap();
// scale dataset according to parameters
let dataset = scaler.transform(dataset);

Implementations

impl<F: Float> LinearScalerParams<F>

pub fn new(method: ScalingMethod<F>) -> Self

Initializes the scaler with the specified method.

pub fn method(self, method: ScalingMethod<F>) -> Self

Setter for the scaler method

Trait Implementations

impl<F: Clone + Float> Clone for LinearScalerParams<F>

fn clone(&self) -> LinearScalerParams<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float> Debug for LinearScalerParams<F>

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

Formats the value using the given formatter.

impl<F: Float, D: Data<Elem = F>, T: AsTargets> Fit<ArrayBase<D, Dim<[usize; 2]>>, T, PreprocessingError> for LinearScalerParams<F>

fn fit(&self, x: &DatasetBase<ArrayBase<D, Ix2>, T>) -> Result<Self::Object>

Fits the input dataset accordng to the scaler method. Will return an error if the dataset does not contain any samples or (in the case of MinMax scaling) if the specified range is not valid.

type Object = LinearScaler<F>

impl<F: PartialEq + Float> PartialEq for LinearScalerParams<F>

fn eq(&self, other: &LinearScalerParams<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Eq + Float> Eq for LinearScalerParams<F>

impl<F: Float> StructuralEq for LinearScalerParams<F>

impl<F: Float> StructuralPartialEq for LinearScalerParams<F>