A simple Standard Scaler class. More...

Public Member Functions
template<typename MatType >
void	Fit (const MatType &input)
	Function to fit features, to find out the min max and scale. More...

template<typename MatType >
void	InverseTransform (const MatType &input, MatType &output)
	Function to retrieve original dataset. More...

const arma::vec &	ItemMean () const
	Get the mean row vector. More...

const arma::vec &	ItemStdDev () const
	Get the standard deviation row vector. More...

template<typename Archive >
void	serialize (Archive &ar, const unsigned int)

template<typename MatType >
void	Transform (const MatType &input, MatType &output)
	Function to scale features. More...

Detailed Description

A simple Standard Scaler class.

Given an input dataset this class helps you to Standardize features by removing the mean and scaling to unit variance.

[z = (x - u) / s]

where u is the mean of the training samples and s is the standard deviation of the training samples.

arma::mat input;
Load("train.csv", input);
arma::mat output;
// Fit the features.
StandardScaler scale;
scale.Fit(input)
// Scale the features.
scale.Transform(input, output);
// Retransform the input.
scale.InverseTransform(output, input);

Definition at line 47 of file standard_scaler.hpp.

Member Function Documentation

void Fit ( const MatType & input )

inline

Function to fit features, to find out the min max and scale.

Parameters

input Dataset to fit.

Definition at line 56 of file standard_scaler.hpp.

void InverseTransform	(	const MatType &	input,
		MatType &	output
	)

inline

Function to retrieve original dataset.

Parameters

input	Scaled dataset.
output	Output matrix with original Dataset.

Definition at line 90 of file standard_scaler.hpp.

const arma::vec& ItemMean ( ) const

inline

Get the mean row vector.

Definition at line 97 of file standard_scaler.hpp.

const arma::vec& ItemStdDev ( ) const

inline

Get the standard deviation row vector.

Definition at line 99 of file standard_scaler.hpp.

void serialize	(	Archive &	ar,
		const unsigned	int
	)

inline

Definition at line 102 of file standard_scaler.hpp.

void Transform	(	const MatType &	input,
		MatType &	output
	)

inline

Function to scale features.

Parameters

input	Dataset to scale features.
output	Output matrix with scaled features.

Definition at line 72 of file standard_scaler.hpp.

The documentation for this class was generated from the following file:

src/mlpack/core/data/scaler_methods/standard_scaler.hpp

Public Member Functions

Detailed Description

Member Function Documentation