Base class for covariance functions that are used in Gaussian Processes. More...

#include <CovarianceFunctionBase.h>

Inheritance diagram for CovarianceFunctionBase:

Public Types
using	HyperParameterMap = std::unordered_map< std::string, torch::Tensor >

typedef DataFileName	DataFileParameterType

Public Member Functions
	CovarianceFunctionBase (const InputParameters &parameters)

virtual void	computeCovarianceMatrix (torch::Tensor &K, const torch::Tensor &x, const torch::Tensor &xp, const bool is_self_covariance) const =0
	Generates the Covariance Matrix given two sets of points in the parameter space.

void	loadHyperParamMap (const HyperParameterMap &map)
	Load some hyperparameters into the local map contained in this object.

void	buildHyperParamMap (HyperParameterMap &map) const
	Populates the input maps with the owned hyperparameters.

virtual bool	getTuningData (const std::string &name, unsigned int &size, Real &min, Real &max) const
	Get the default minimum and maximum and size of a hyperparameter.

void	dependentCovarianceTypes (std::map< UserObjectName, std::string > &name_type_map) const
	Populate a map with the names and types of the dependent covariance functions.

const std::vector< UserObjectName > &	dependentCovarianceNames () const
	Get the names of the dependent covariances.

virtual bool	computedKdhyper (torch::Tensor &dKdhp, const torch::Tensor &x, const std::string &hyper_param_name, unsigned int ind) const
	Redirect dK/dhp for hyperparameter "hp".

virtual bool	isTunable (const std::string &name) const
	Check if a given parameter is tunable.

unsigned int	numOutputs () const
	Return the number of outputs assumed for this covariance function.

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static bool	isScalarHyperParameter (const torch::Tensor &tensor)
	Return true if a hyperparameter tensor stores one scalar value.

static bool	isVectorHyperParameter (const torch::Tensor &tensor)
	Return true if a hyperparameter tensor stores a vector of values.

static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
torch::Tensor &	addRealHyperParameter (const std::string &name, const Real value, const bool is_tunable)
	Register a scalar hyperparameter to this covariance function.

torch::Tensor &	addVectorRealHyperParameter (const std::string &name, const std::vector< Real > &value, const bool is_tunable)
	Register a vector hyperparameter to this covariance function.

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

CovarianceFunctionBase *	getCovarianceFunctionByName (const UserObjectName &name) const
	Lookup a CovarianceFunction object by name and return pointer.

Protected Attributes
HyperParameterMap	_hyperparameters
	Map of hyperparameters stored as rank-0 or rank-1 tensors.

std::unordered_set< std::string >	_tunable_hp
	list of tunable hyper-parameters

const unsigned int	_num_outputs
	The number of outputs this covariance function is used to describe.

const std::vector< UserObjectName >	_dependent_covariance_names
	The names of the dependent covariance functions.

std::vector< std::string >	_dependent_covariance_types
	The types of the dependent covariance functions.

std::vector< CovarianceFunctionBase * >	_covariance_functions
	Vector of pointers to the dependent covariance functions.

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

FEProblemBase &	_covar_feproblem
	Reference to FEProblemBase instance.

Detailed Description

Base class for covariance functions that are used in Gaussian Processes.

Definition at line 20 of file CovarianceFunctionBase.h.

Member Typedef Documentation

◆ HyperParameterMap

using CovarianceFunctionBase::HyperParameterMap = std::unordered_map<std::string, torch::Tensor>

Definition at line 23 of file CovarianceFunctionBase.h.

Constructor & Destructor Documentation

◆ CovarianceFunctionBase()

CovarianceFunctionBase::CovarianceFunctionBase ( const InputParameters & parameters )

Definition at line 69 of file CovarianceFunctionBase.C.

  : MooseObject(parameters),
    CovarianceInterface(parameters),
    _num_outputs(getParam<unsigned int>("num_outputs")),
    _dependent_covariance_names(getParam<std::vector<UserObjectName>>("covariance_functions"))
 
{
  // Fetch the dependent covariance functions
  for (const auto & name : _dependent_covariance_names)
  {
    _covariance_functions.push_back(getCovarianceFunctionByName(name));
    _dependent_covariance_types.push_back(_covariance_functions.back()->type());
  }
}

Member Function Documentation

◆ addRealHyperParameter()

torch::Tensor & CovarianceFunctionBase::addRealHyperParameter	(	const std::string &	name,
		const Real	value,
		const bool	is_tunable
	)

protected

Register a scalar hyperparameter to this covariance function.

Parameters

name	The name of the parameter
value	The initial value of the parameter
is_tunable	If the parameter is tunable during optimization

Definition at line 95 of file CovarianceFunctionBase.C.

{
  const auto prefixed_name = _name + ":" + name;
  return insertHyperParameter(
      _hyperparameters, _tunable_hp, prefixed_name, makeScalarHyperParameter(value), is_tunable);
}

◆ addVectorRealHyperParameter()

torch::Tensor & CovarianceFunctionBase::addVectorRealHyperParameter	(	const std::string &	name,
		const std::vector< Real > &	value,
		const bool	is_tunable
	)

protected

Register a vector hyperparameter to this covariance function.

Parameters

name	The name of the parameter
value	The initial value of the parameter
is_tunable	If the parameter is tunable during optimization

Definition at line 105 of file CovarianceFunctionBase.C.

{
  const auto prefixed_name = _name + ":" + name;
  return insertHyperParameter(
      _hyperparameters, _tunable_hp, prefixed_name, makeVectorHyperParameter(value), is_tunable);
}

Referenced by LMC::LMC().

◆ buildHyperParamMap()

void CovarianceFunctionBase::buildHyperParamMap ( HyperParameterMap & map ) const

Populates the input maps with the owned hyperparameters.

Parameters

map	Map of hyperparameters that should be populated

Definition at line 153 of file CovarianceFunctionBase.C.

{
  // First, add the hyperparameters of the dependent covariance functions
  for (const auto dependent_covar : _covariance_functions)
    dependent_covar->buildHyperParamMap(map);
 
  // At the end we just append the hyperparameters this object owns
  for (const auto & iter : _hyperparameters)
    if (!isScalarHyperParameter(iter.second) && !isVectorHyperParameter(iter.second))
      mooseError("Unsupported hyperparameter rank ", iter.second.dim(), " for ", iter.first, ".");
    else
      map[iter.first] = iter.second.clone();
}

Referenced by StochasticTools::GaussianProcess::setupCovarianceMatrix().

◆ computeCovarianceMatrix()

virtual void CovarianceFunctionBase::computeCovarianceMatrix	(	torch::Tensor &	K,
		const torch::Tensor &	x,
		const torch::Tensor &	xp,
		const bool	is_self_covariance
	)		const

pure virtual

Generates the Covariance Matrix given two sets of points in the parameter space.

Parameters

K	Reference to a matrix which should be populated by the covariance entries
x	Reference to the first set of points
xp	Reference to the second set of points
is_self_covariance	Switch to enable adding the noise variance to the diagonal of the covariance matrix

Implemented in ExponentialCovariance, LMC, MaternHalfIntCovariance, and SquaredExponentialCovariance.

Referenced by GaussianProcessSurrogate::evaluate(), StochasticTools::GaussianProcess::getLoss(), and StochasticTools::GaussianProcess::setupCovarianceMatrix().

◆ computedKdhyper()

bool CovarianceFunctionBase::computedKdhyper	(	torch::Tensor &	dKdhp,
		const torch::Tensor &	x,
		const std::string &	hyper_param_name,
		unsigned int	ind
	)		const

virtual

Redirect dK/dhp for hyperparameter "hp".

Returns false is the parameter has not been found in this covariance object.

Parameters

dKdhp	The matrix which should be populated with the derivatives
x	The input vector for which the derivatives of the covariance matrix is computed
hyper_param_name	The name of the hyperparameter
ind	The index within the hyperparameter. 0 if it is a scalar parameter. If it is a vector parameter, it should be the index within the vector.

Reimplemented in ExponentialCovariance, LMC, MaternHalfIntCovariance, and SquaredExponentialCovariance.

Definition at line 85 of file CovarianceFunctionBase.C.

{
  mooseError("Hyperparameter tuning not set up for this covariance function. Please define "
             "computedKdhyper() to compute gradient.");
}

Referenced by StochasticTools::GaussianProcess::getGradient().

◆ dependentCovarianceNames()

const std::vector< UserObjectName > & CovarianceFunctionBase::dependentCovarianceNames ( ) const

inline

Get the names of the dependent covariances.

Definition at line 67 of file CovarianceFunctionBase.h.

  {
    return _dependent_covariance_names;
  }

Referenced by StochasticTools::GaussianProcess::linkCovarianceFunction().

◆ dependentCovarianceTypes()

void CovarianceFunctionBase::dependentCovarianceTypes ( std::map< UserObjectName, std::string > & name_type_map ) const

Populate a map with the names and types of the dependent covariance functions.

Parameters

name_type_map Reference to the map which should be populated

Definition at line 204 of file CovarianceFunctionBase.C.

{
  for (const auto dependent_covar : _covariance_functions)
  {
    dependent_covar->dependentCovarianceTypes(name_type_map);
    name_type_map.insert(std::make_pair(dependent_covar->name(), dependent_covar->type()));
  }
}

Referenced by StochasticTools::GaussianProcess::linkCovarianceFunction().

◆ getCovarianceFunctionByName()

CovarianceFunctionBase * CovarianceInterface::getCovarianceFunctionByName ( const UserObjectName & name ) const

protectedinherited

Lookup a CovarianceFunction object by name and return pointer.

Definition at line 26 of file CovarianceInterface.C.

{
  std::vector<CovarianceFunctionBase *> models;
  _covar_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("CovarianceFunction")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a CovarianceFunction object with the name '" + name + "'");
  return models[0];
}

Referenced by ActiveLearningGaussianProcess::ActiveLearningGaussianProcess(), CovarianceFunctionBase(), GaussianProcessTrainer::GaussianProcessTrainer(), and GaussianProcessSurrogate::setupCovariance().

◆ getTuningData()

bool CovarianceFunctionBase::getTuningData	(	const std::string &	name,
		unsigned int &	size,
		Real &	min,
		Real &	max
	)		const

virtual

Get the default minimum and maximum and size of a hyperparameter.

Returns false is the parameter has not been found in this covariance object.

Parameters

name	The name of the hyperparameter
size	Reference to an unsigned int that will contain the size of the hyperparameter (will be populated with 1 if it is scalar)
min	Reference to a number which will be populated by the maximum allowed value of the hyperparameter
max	Reference to a number which will be populated by the minimum allowed value of the hyperparameter

Definition at line 168 of file CovarianceFunctionBase.C.

{
  // First, check the dependent covariances
  for (const auto dependent_covar : _covariance_functions)
    if (dependent_covar->getTuningData(name, size, min, max))
      return true;
 
  min = 1e-9;
  max = 1e9;
 
  const auto tensor_value = _hyperparameters.find(name);
  if (tensor_value == _hyperparameters.end())
  {
    size = 0;
    return false;
  }
 
  if (isScalarHyperParameter(tensor_value->second))
  {
    size = 1;
    return true;
  }
 
  if (isVectorHyperParameter(tensor_value->second))
  {
    size = tensor_value->second.numel();
    return true;
  }
 
  mooseError("Unsupported hyperparameter rank ", tensor_value->second.dim(), " for ", name, ".");
}

Referenced by StochasticTools::GaussianProcess::generateTuningMap().

◆ isScalarHyperParameter()

bool CovarianceFunctionBase::isScalarHyperParameter ( const torch::Tensor & tensor )

static

Return true if a hyperparameter tensor stores one scalar value.

Definition at line 44 of file CovarianceFunctionBase.C.

{
  return tensor.dim() == 0;
}

Referenced by buildHyperParamMap(), getTuningData(), GaussianProcessData::initialize(), and loadHyperParamMap().

◆ isTunable()

bool CovarianceFunctionBase::isTunable ( const std::string & name ) const

virtual

Check if a given parameter is tunable.

Parameters

The	name of the hyperparameter

Definition at line 115 of file CovarianceFunctionBase.C.

{
  // First, we check if the dependent covariances have the parameter
  for (const auto dependent_covar : _covariance_functions)
    if (dependent_covar->isTunable(name))
      return true;
 
  if (_tunable_hp.find(name) != _tunable_hp.end())
    return true;
  else if (_hyperparameters.find(name) != _hyperparameters.end())
    mooseError("We found hyperparameter ", name, " but it was not declared tunable!");
 
  return false;
}

Referenced by StochasticTools::GaussianProcess::generateTuningMap().

◆ isVectorHyperParameter()

bool CovarianceFunctionBase::isVectorHyperParameter ( const torch::Tensor & tensor )

static

Return true if a hyperparameter tensor stores a vector of values.

Definition at line 50 of file CovarianceFunctionBase.C.

{
  return tensor.dim() == 1;
}

Referenced by buildHyperParamMap(), getTuningData(), GaussianProcessData::initialize(), and loadHyperParamMap().

◆ loadHyperParamMap()

void CovarianceFunctionBase::loadHyperParamMap ( const HyperParameterMap & map )

Load some hyperparameters into the local map contained in this object.

Parameters

map	Input map of hyperparameters

Definition at line 131 of file CovarianceFunctionBase.C.

{
  // First, load the hyperparameters of the dependent covariance functions
  for (const auto dependent_covar : _covariance_functions)
    dependent_covar->loadHyperParamMap(map);
 
  // Then we load the hyperparameters of this object
  for (auto & iter : _hyperparameters)
  {
    const auto map_iter = map.find(iter.first);
    if (map_iter == map.end())
      continue;
 
    if (!isScalarHyperParameter(map_iter->second) && !isVectorHyperParameter(map_iter->second))
      mooseError(
          "Unsupported hyperparameter rank ", map_iter->second.dim(), " for ", iter.first, ".");
 
    iter.second = map_iter->second.clone();
  }
}

Referenced by LoadCovarianceDataAction::load(), StochasticTools::GaussianProcess::setupCovarianceMatrix(), and StochasticTools::GaussianProcess::tuneHyperParamsAdam().

◆ numOutputs()

unsigned int CovarianceFunctionBase::numOutputs ( ) const

inline

Return the number of outputs assumed for this covariance function.

Definition at line 90 of file CovarianceFunctionBase.h.

90{ return _num_outputs; }

Referenced by GaussianProcessSurrogate::evaluate(), GaussianProcessTrainer::GaussianProcessTrainer(), and StochasticTools::GaussianProcess::linkCovarianceFunction().

◆ validParams()

InputParameters CovarianceFunctionBase::validParams ( )

static

Definition at line 56 of file CovarianceFunctionBase.C.

{
  InputParameters params = MooseObject::validParams();
  params.addParam<std::vector<UserObjectName>>(
      "covariance_functions", {}, "Covariance functions that this covariance function depends on.");
  params.addParam<unsigned int>(
      "num_outputs", 1, "The number of outputs expected for this covariance function.");
  params.addClassDescription("Base class for covariance functions");
  params.registerBase("CovarianceFunctionBase");
  params.registerSystemAttributeName("CovarianceFunction");
  return params;
}

Referenced by ExponentialCovariance::validParams(), LMC::validParams(), MaternHalfIntCovariance::validParams(), and SquaredExponentialCovariance::validParams().

Member Data Documentation

◆ _covar_feproblem

FEProblemBase& CovarianceInterface::_covar_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 31 of file CovarianceInterface.h.

Referenced by CovarianceInterface::getCovarianceFunctionByName().

◆ _covariance_functions

std::vector<CovarianceFunctionBase *> CovarianceFunctionBase::_covariance_functions

protected

Vector of pointers to the dependent covariance functions.

Definition at line 124 of file CovarianceFunctionBase.h.

Referenced by buildHyperParamMap(), LMC::computeCovarianceMatrix(), LMC::computedKdhyper(), CovarianceFunctionBase(), dependentCovarianceTypes(), getTuningData(), isTunable(), and loadHyperParamMap().

◆ _dependent_covariance_names

const std::vector<UserObjectName> CovarianceFunctionBase::_dependent_covariance_names

protected

The names of the dependent covariance functions.

Definition at line 118 of file CovarianceFunctionBase.h.

Referenced by CovarianceFunctionBase(), and dependentCovarianceNames().

◆ _dependent_covariance_types

std::vector<std::string> CovarianceFunctionBase::_dependent_covariance_types

protected

The types of the dependent covariance functions.

Definition at line 121 of file CovarianceFunctionBase.h.

Referenced by CovarianceFunctionBase().

◆ _hyperparameters

HyperParameterMap CovarianceFunctionBase::_hyperparameters

protected

Map of hyperparameters stored as rank-0 or rank-1 tensors.

Definition at line 109 of file CovarianceFunctionBase.h.

Referenced by addRealHyperParameter(), addVectorRealHyperParameter(), buildHyperParamMap(), getTuningData(), isTunable(), and loadHyperParamMap().

◆ _num_outputs

const unsigned int CovarianceFunctionBase::_num_outputs

protected

The number of outputs this covariance function is used to describe.

Definition at line 115 of file CovarianceFunctionBase.h.

Referenced by LMC::computeCovarianceMatrix(), LMC::computedKdhyper(), LMC::computeLambdaGradient(), LMC::LMC(), and numOutputs().

◆ _tunable_hp

std::unordered_set<std::string> CovarianceFunctionBase::_tunable_hp

protected

list of tunable hyper-parameters

Definition at line 112 of file CovarianceFunctionBase.h.

Referenced by addRealHyperParameter(), addVectorRealHyperParameter(), LMC::computedKdhyper(), and isTunable().

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

stochastic_tools/include/covariances/CovarianceFunctionBase.h
stochastic_tools/src/covariances/CovarianceFunctionBase.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HyperParameterMap

Constructor & Destructor Documentation

◆ CovarianceFunctionBase()

Member Function Documentation

◆ addRealHyperParameter()

◆ addVectorRealHyperParameter()

◆ buildHyperParamMap()

◆ computeCovarianceMatrix()

◆ computedKdhyper()

◆ dependentCovarianceNames()

◆ dependentCovarianceTypes()

◆ getCovarianceFunctionByName()

◆ getTuningData()

◆ isScalarHyperParameter()

◆ isTunable()

◆ isVectorHyperParameter()

◆ loadHyperParamMap()

◆ numOutputs()

◆ validParams()

Member Data Documentation

◆ _covar_feproblem

◆ _covariance_functions

◆ _dependent_covariance_names

◆ _dependent_covariance_types

◆ _hyperparameters

◆ _num_outputs

◆ _tunable_hp