StochasticTools::Standardizer Class Reference

Class for standardizing data (centering and scaling) More...

#include <Standardizer.h>

Public Member Functions
	Standardizer ()=default
void	set (const Real &n)
	Methods for setting mean and standard deviation directly Sets mean=0, std=1 for n variables. More...
void	set (const Real &mean, const Real &stdev)
	Sets mean and std for a single variable. More...
void	set (const Real &mean, const Real &stdev, const Real &n)
	Sets mean and std for a n variables variable. More...
void	set (const std::vector< Real > &mean, const std::vector< Real > &stdev)
	Sets mean and std directly using provided vectors. More...
const torch::Tensor &	getMean () const
	Get the mean vector. More...
const torch::Tensor &	getStdDev () const
	Get the standard deviation vector. More...
void	computeSet (const torch::Tensor &input)
	Methods for computing and setting mean and standard deviation. More...
void	storeHelper (std::ostream &stream, void *context) const
	Helper for dataStore. More...
void	getStandardized (torch::Tensor &input) const
	Returns the standardized (centered and scaled) of the provided input. More...
void	getDestandardized (torch::Tensor &input) const
	De-standardizes (de-centered and de-scaled) the assumed standardized input. More...
void	getDescaled (torch::Tensor &input) const
	De-scales the assumed scaled input. More...
void	getScaled (torch::Tensor &input) const
	Scales the assumed de-scaled input. More...

Protected Attributes
torch::Tensor	_mean
torch::Tensor	_stdev

Detailed Description

Class for standardizing data (centering and scaling)

Definition at line 24 of file Standardizer.h.

Constructor & Destructor Documentation

Standardizer()

StochasticTools::Standardizer::Standardizer ( )

default

Member Function Documentation

computeSet()

void StochasticTools::Standardizer::computeSet

(

const torch::Tensor &

input

)

Methods for computing and setting mean and standard deviation.

Definition at line 79 of file Standardizer.C.

Referenced by StochasticTools::GaussianProcess::standardizeData(), StochasticTools::GaussianProcess::standardizeParameters(), and TEST().

{
  if (input.dim() != 2)
    mooseError("Standardizer input must be a rank-2 tensor.");
  // Compute mean and standard deviation
  _mean = torch::mean(input, 0, false);
  _stdev = torch::std(input, 0, 0, false);
}

getDescaled()

void StochasticTools::Standardizer::getDescaled

(

torch::Tensor &

input

)

const

De-scales the assumed scaled input.

Definition at line 103 of file Standardizer.C.

Referenced by GaussianProcessSurrogate::evaluate().

{
  checkInputCompatibility(input, _stdev);
  input.mul_(asFeatureVector(_stdev, input));
}

getDestandardized()

void StochasticTools::Standardizer::getDestandardized

(

torch::Tensor &

input

)

const

De-standardizes (de-centered and de-scaled) the assumed standardized input.

Definition at line 96 of file Standardizer.C.

Referenced by GaussianProcessSurrogate::evaluate().

{
  checkInputCompatibility(input, _mean);
  input.mul_(asFeatureVector(_stdev, input)).add_(asFeatureVector(_mean, input));
}

getMean()

const torch::Tensor& StochasticTools::Standardizer::getMean ( ) const

inline

Get the mean vector.

Definition at line 40 of file Standardizer.h.

Referenced by LibtorchANNSurrogate::evaluate(), and TEST().

{ return _mean; }

getScaled()

void StochasticTools::Standardizer::getScaled

(

torch::Tensor &

input

)

const

Scales the assumed de-scaled input.

Definition at line 110 of file Standardizer.C.

{
  checkInputCompatibility(input, _stdev);
  input.div_(asFeatureVector(_stdev, input));
}

getStandardized()

void StochasticTools::Standardizer::getStandardized

(

torch::Tensor &

input

)

const

Returns the standardized (centered and scaled) of the provided input.

Definition at line 89 of file Standardizer.C.

Referenced by GaussianProcessSurrogate::evaluate(), StochasticTools::GaussianProcess::standardizeData(), and StochasticTools::GaussianProcess::standardizeParameters().

{
  checkInputCompatibility(input, _mean);
  input.sub_(asFeatureVector(_mean, input)).div_(asFeatureVector(_stdev, input));
}

getStdDev()

const torch::Tensor& StochasticTools::Standardizer::getStdDev ( ) const

inline

Get the standard deviation vector.

Definition at line 42 of file Standardizer.h.

Referenced by LibtorchANNSurrogate::evaluate(), and TEST().

{ return _stdev; }

set() [1/4]

void StochasticTools::Standardizer::set

(

const Real &

n

)

Methods for setting mean and standard deviation directly Sets mean=0, std=1 for n variables.

Definition at line 48 of file Standardizer.C.

Referenced by dataLoad(), GaussianProcessTrainer::postTrain(), LibtorchANNTrainer::postTrain(), and ActiveLearningGaussianProcess::reTrain().

{
  _mean = torch::zeros({long(n)}, at::kDouble);
  _stdev = torch::ones({long(n)}, at::kDouble);
}

set() [2/4]

void StochasticTools::Standardizer::set	(	const Real &	mean,
		const Real &	stdev
	)

Sets mean and std for a single variable.

Definition at line 55 of file Standardizer.C.

{
  _mean = torch::full({1}, mean, at::kDouble);
  _stdev = torch::full({1}, stdev, at::kDouble);
}

set() [3/4]

void StochasticTools::Standardizer::set	(	const Real &	mean,
		const Real &	stdev,
		const Real &	n
	)

Sets mean and std for a n variables variable.

Definition at line 62 of file Standardizer.C.

{
  auto options = torch::TensorOptions().dtype(at::kDouble);
  _mean = torch::full({long(n)}, mean, options);
  _stdev = torch::full({long(n)}, stdev, options);
}

set() [4/4]

void StochasticTools::Standardizer::set	(	const std::vector< Real > &	mean,
		const std::vector< Real > &	stdev
	)

Sets mean and std directly using provided vectors.

Definition at line 70 of file Standardizer.C.

{
  mooseAssert(mean.size() == stdev.size(),
              "Provided mean and standard deviation vectors are of differing size.");
  _mean = LibtorchUtils::vectorToTensorCopy(mean, {long(mean.size())});
  _stdev = LibtorchUtils::vectorToTensorCopy(stdev, {long(stdev.size())});
}

storeHelper()

void StochasticTools::Standardizer::storeHelper	(	std::ostream &	stream,
		void *	context
	)		const

Helper for dataStore.

Definition at line 118 of file Standardizer.C.

Referenced by dataStore().

{
  const auto mean = LibtorchUtils::toCPUContiguous(_mean);
  const auto stdev = LibtorchUtils::toCPUContiguous(_stdev);
  auto mean_accessor = mean.accessor<Real, 1>();
  auto stdev_accessor = stdev.accessor<Real, 1>();
  unsigned int n = mean.size(0);
  dataStore(stream, n, context);
  for (unsigned int ii = 0; ii < n; ++ii)
    dataStore(stream, mean_accessor[ii], context);
  for (unsigned int ii = 0; ii < n; ++ii)
    dataStore(stream, stdev_accessor[ii], context);
}

Member Data Documentation

_mean

torch::Tensor StochasticTools::Standardizer::_mean

protected

Definition at line 63 of file Standardizer.h.

Referenced by computeSet(), getDestandardized(), getMean(), getStandardized(), set(), and storeHelper().

_stdev

torch::Tensor StochasticTools::Standardizer::_stdev

protected

Definition at line 64 of file Standardizer.h.

Referenced by computeSet(), getDescaled(), getDestandardized(), getScaled(), getStandardized(), getStdDev(), set(), and storeHelper().

---

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

• stochastic_tools/include/utils/Standardizer.h
• stochastic_tools/src/utils/Standardizer.C