SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
sgpp::datadriven::DataMiningConfigParser Class Reference

#include <DataMiningConfigParser.hpp>

Public Member Functions

 DataMiningConfigParser (const std::string &filepath)
 
bool getDataSourceConfig (DataSourceConfig &config, const DataSourceConfig &defaults) const
 
bool getFitterAdaptivityConfig (base::AdaptivityConfiguration &config, const base::AdaptivityConfiguration &defaults) const
 
bool getFitterConfigType (FitterType &fitter, const FitterType &defaults) const
 
bool getFitterCrossvalidationConfig (CrossvalidationConfiguration &config, const CrossvalidationConfiguration &defaults) const
 
bool getFitterDatabaseConfig (datadriven::DatabaseConfiguration &config, const datadriven::DatabaseConfiguration &defaults) const
 Returns the database configuration of the fitter if it exists.
 
bool getFitterDensityEstimationConfig (DensityEstimationConfiguration &config, const DensityEstimationConfiguration &defaults) const
 
bool getFitterGridConfig (base::GeneralGridConfiguration &config, const base::GeneralGridConfiguration &defaults) const
 
bool getFitterLambda (double &lambda, double defaultValue) const
 
bool getFitterLearnerConfig (datadriven::LearnerConfiguration &config, const datadriven::LearnerConfiguration &defaults) const
 Initializes the learner configuration if it exists.
 
bool getFitterParallelConfig (datadriven::ParallelConfiguration &config, const datadriven::ParallelConfiguration &defaults) const
 Initializes the parallel configuration if it exists.
 
bool getFitterRegularizationConfig (RegularizationConfiguration &config, const RegularizationConfiguration &defaults) const
 
bool getFitterSolverFinalConfig (solver::SLESolverConfiguration &config, const solver::SLESolverConfiguration &defaults) const
 
bool getFitterSolverRefineConfig (solver::SLESolverConfiguration &config, const solver::SLESolverConfiguration &defaults) const
 
bool getGeometryConfig (datadriven::GeometryConfiguration &config, const datadriven::GeometryConfiguration &defaults) const
 Initializes the geometry configuration if it exists.
 
void getHPOConfig (HPOConfig &config)
 
std::string getHPOMethod (std::string defaultValue) const
 
void getHyperparameters (std::map< std::string, ContinuousParameter > &conpar, std::map< std::string, DiscreteParameter > &dispar, std::map< std::string, DiscreteParameter > &catpar, std::vector< base::GridType > &basisFunctions) const
 
bool getMultiDataSourceConfig (std::vector< DataSourceConfig > &config, const std::vector< DataSourceConfig > &defaults) const
 Expands on getDataSourceConfig by allowing multiple dataSource instances.
 
bool getScorerConfig (ScorerConfiguration &config, const ScorerConfiguration &defaults) const
 Reads the configuration for the scorer.
 
bool getVisualizationGeneralConfig (datadriven::VisualizationGeneralConfig &config, const datadriven::VisualizationGeneralConfig &defaults) const
 Initializes the visualization general configuration if it exists.
 
bool getVisualizationParameters (datadriven::VisualizationParameters &config, const datadriven::VisualizationParameters &defaults) const
 Initializes the visualization parameters configuration if it exists.
 
bool hasDataSourceConfig () const
 
bool hasDataTransformationConfig () const
 
bool hasFitterConfig () const
 
bool hasFitterConfigCrossValidation () const
 Checks whether the fitter configuration contains a cross validation configuration.
 
bool hasGeometryConfig () const
 
bool hasParallelConfig () const
 
bool hasScorerConfig () const
 
bool hasVisualizationConfig () const
 
bool hasVisualizationGeneralConfig () const
 
bool hasVisualizationParametersConfig () const
 
std::vector< int64_t > parseIntArray (json::JSON::DictNode &dict, const std::string &key, std::vector< int64_t > defaultValue, const std::string &parentNode) const
 
virtual ~DataMiningConfigParser ()
 

Constructor & Destructor Documentation

◆ DataMiningConfigParser()

sgpp::datadriven::DataMiningConfigParser::DataMiningConfigParser ( const std::string &  filepath)
explicit

◆ ~DataMiningConfigParser()

sgpp::datadriven::DataMiningConfigParser::~DataMiningConfigParser ( )
virtual

Member Function Documentation

◆ getDataSourceConfig()

bool sgpp::datadriven::DataMiningConfigParser::getDataSourceConfig ( DataSourceConfig config,
const DataSourceConfig defaults 
) const

◆ getFitterAdaptivityConfig()

bool sgpp::datadriven::DataMiningConfigParser::getFitterAdaptivityConfig ( base::AdaptivityConfiguration config,
const base::AdaptivityConfiguration defaults 
) const

◆ getFitterConfigType()

bool sgpp::datadriven::DataMiningConfigParser::getFitterConfigType ( FitterType fitter,
const FitterType defaults 
) const

◆ getFitterCrossvalidationConfig()

◆ getFitterDatabaseConfig()

bool sgpp::datadriven::DataMiningConfigParser::getFitterDatabaseConfig ( datadriven::DatabaseConfiguration config,
const datadriven::DatabaseConfiguration defaults 
) const

Returns the database configuration of the fitter if it exists.

Parameters
configthe configuration object that will be initialized
defaultsdefault values if the fitter does not contain a database configuration
Returns
whether the fitter contains a database configuration

References sgpp::datadriven::DatabaseConfiguration::filePath_, and hasFitterConfig().

◆ getFitterDensityEstimationConfig()

◆ getFitterGridConfig()

◆ getFitterLambda()

bool sgpp::datadriven::DataMiningConfigParser::getFitterLambda ( double &  lambda,
double  defaultValue 
) const

◆ getFitterLearnerConfig()

bool sgpp::datadriven::DataMiningConfigParser::getFitterLearnerConfig ( datadriven::LearnerConfiguration config,
const datadriven::LearnerConfiguration defaults 
) const

Initializes the learner configuration if it exists.

Parameters
configthe configuration instance that will be initialized
defaultsdefault values if the fitter config does not contain a matching entry
Returns
whether the configuration contains a learner configuration

References hasFitterConfig(), sgpp::datadriven::LearnerConfiguration::learningRate_, and sgpp::datadriven::LearnerConfiguration::usePrior_.

◆ getFitterParallelConfig()

bool sgpp::datadriven::DataMiningConfigParser::getFitterParallelConfig ( datadriven::ParallelConfiguration config,
const datadriven::ParallelConfiguration defaults 
) const

Initializes the parallel configuration if it exists.

Parameters
configthe configuration instance that will be initialized
defaultsdefault values if the parallel config does not contain a matching entry
Returns
whether the configuration contains a parallel configuration

References sgpp::datadriven::ParallelConfiguration::columnBlockSize_, hasFitterConfig(), hasParallelConfig(), sgpp::datadriven::ParallelConfiguration::processCols_, sgpp::datadriven::ParallelConfiguration::processRows_, sgpp::datadriven::ParallelConfiguration::rowBlockSize_, and sgpp::datadriven::ParallelConfiguration::scalapackEnabled_.

◆ getFitterRegularizationConfig()

◆ getFitterSolverFinalConfig()

bool sgpp::datadriven::DataMiningConfigParser::getFitterSolverFinalConfig ( solver::SLESolverConfiguration config,
const solver::SLESolverConfiguration defaults 
) const

References hasFitterConfig().

◆ getFitterSolverRefineConfig()

bool sgpp::datadriven::DataMiningConfigParser::getFitterSolverRefineConfig ( solver::SLESolverConfiguration config,
const solver::SLESolverConfiguration defaults 
) const

References hasFitterConfig().

◆ getGeometryConfig()

bool sgpp::datadriven::DataMiningConfigParser::getGeometryConfig ( datadriven::GeometryConfiguration config,
const datadriven::GeometryConfiguration defaults 
) const

Initializes the geometry configuration if it exists.

Parameters
configthe configuration instance that will be initialized
defaultsdefault values if the fitter config does not contain a matching entry
Returns
whether the configuration contains a learner configuration

References sgpp::datadriven::StencilConfiguration::applyOnLayers_, sgpp::datadriven::Block, sgpp::datadriven::StencilConfiguration::blockLenght_, sgpp::datadriven::StencilConfiguration::colorIndex_, sgpp::datadriven::GeometryConfiguration::dim_, hasFitterConfig(), hasGeometryConfig(), sgpp::datadriven::GeometryConfigurationParser::parseStencil(), sgpp::datadriven::GeometryConfiguration::stencils_, and sgpp::datadriven::StencilConfiguration::stencilType_.

◆ getHPOConfig()

◆ getHPOMethod()

std::string sgpp::datadriven::DataMiningConfigParser::getHPOMethod ( std::string  defaultValue) const

◆ getHyperparameters()

void sgpp::datadriven::DataMiningConfigParser::getHyperparameters ( std::map< std::string, ContinuousParameter > &  conpar,
std::map< std::string, DiscreteParameter > &  dispar,
std::map< std::string, DiscreteParameter > &  catpar,
std::vector< base::GridType > &  basisFunctions 
) const

◆ getMultiDataSourceConfig()

bool sgpp::datadriven::DataMiningConfigParser::getMultiDataSourceConfig ( std::vector< DataSourceConfig > &  config,
const std::vector< DataSourceConfig > &  defaults 
) const

Expands on getDataSourceConfig by allowing multiple dataSource instances.

The first instance is used as a template for filling in the parameters for all dataSource instances.

References json::Node::get(), hasDataSourceConfig(), hasDataTransformationConfig(), sgpp::datadriven::DataSourceFileTypeParser::parse(), sgpp::datadriven::DataSourceShufflingTypeParser::parse(), json::ListNode::size(), sgpp::datadriven::DataSourceFileTypeParser::toString(), and sgpp::datadriven::DataSourceShufflingTypeParser::toString().

◆ getScorerConfig()

bool sgpp::datadriven::DataMiningConfigParser::getScorerConfig ( ScorerConfiguration config,
const ScorerConfiguration defaults 
) const

Reads the configuration for the scorer.

Parameters
configthe configuration instance to initialize
defaultsa set of configurations initialized with default values
Returns
if the configuration file contained a scorer configuration

References hasScorerConfig(), sgpp::datadriven::ScorerConfiguration::metric_, sgpp::datadriven::ScorerMetricTypeParser::parse(), and sgpp::datadriven::ScorerMetricTypeParser::toString().

◆ getVisualizationGeneralConfig()

bool sgpp::datadriven::DataMiningConfigParser::getVisualizationGeneralConfig ( datadriven::VisualizationGeneralConfig config,
const datadriven::VisualizationGeneralConfig defaults 
) const

◆ getVisualizationParameters()

bool sgpp::datadriven::DataMiningConfigParser::getVisualizationParameters ( datadriven::VisualizationParameters config,
const datadriven::VisualizationParameters defaults 
) const

Initializes the visualization parameters configuration if it exists.

Parameters
configthe configuration instance that will be initiazlized
defaultsdefault values if the fitter config does not contain a matching entry
Returns
wether the configuration contains a visualization configuration

References hasVisualizationParametersConfig(), sgpp::datadriven::VisualizationParameters::maxNumberIterations_, sgpp::datadriven::VisualizationParameters::numberCores_, sgpp::datadriven::VisualizationParameters::perplexity_, sgpp::datadriven::VisualizationParameters::seed_, sgpp::datadriven::VisualizationParameters::targetDimension_, and sgpp::datadriven::VisualizationParameters::theta_.

◆ hasDataSourceConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasDataSourceConfig ( ) const

◆ hasDataTransformationConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasDataTransformationConfig ( ) const

◆ hasFitterConfig()

◆ hasFitterConfigCrossValidation()

bool sgpp::datadriven::DataMiningConfigParser::hasFitterConfigCrossValidation ( ) const

Checks whether the fitter configuration contains a cross validation configuration.

Returns
if the fitter configuration contains a cross validation configuration

References hasFitterConfig().

◆ hasGeometryConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasGeometryConfig ( ) const

Referenced by getGeometryConfig().

◆ hasParallelConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasParallelConfig ( ) const

◆ hasScorerConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasScorerConfig ( ) const

Referenced by getScorerConfig().

◆ hasVisualizationConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasVisualizationConfig ( ) const

◆ hasVisualizationGeneralConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasVisualizationGeneralConfig ( ) const

◆ hasVisualizationParametersConfig()

bool sgpp::datadriven::DataMiningConfigParser::hasVisualizationParametersConfig ( ) const

◆ parseIntArray()

std::vector< int64_t > sgpp::datadriven::DataMiningConfigParser::parseIntArray ( json::JSON::DictNode dict,
const std::string &  key,
std::vector< int64_t >  defaultValue,
const std::string &  parentNode 
) const

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