SG++-Doxygen-Documentation
sgpp::datadriven::MinerFactory Class Referenceabstract

Abstract factory to build different kinds of Miners based on a configuration which is parsed from a file. More...

#include <MinerFactory.hpp>

Inheritance diagram for sgpp::datadriven::MinerFactory:
sgpp::datadriven::ClassificationMinerFactory sgpp::datadriven::DensityEstimationMinerFactory sgpp::datadriven::LeastSquaresRegressionMinerFactory sgpp::datadriven::UniversalMinerFactory

Public Member Functions

virtual sgpp::datadriven::HyperparameterOptimizerbuildHPO (const std::string &path) const
 
virtual SparseGridMinerbuildMiner (const std::string &path) const
 Factory method to build a miner object based on a configuration file. More...
 
 MinerFactory ()=default
 Default constructor. More...
 
virtual ~MinerFactory ()=default
 Virtual destructor. More...
 

Protected Member Functions

virtual DataSourceCrossValidationcreateDataSourceCrossValidation (const DataMiningConfigParser &parser) const
 Factory method to build a cross validation data source, i.e. More...
 
virtual DataSourceSplittingcreateDataSourceSplitting (const DataMiningConfigParser &parser) const
 Factory method to build a splitting based data source, i.e. More...
 
virtual ModelFittingBasecreateFitter (const DataMiningConfigParser &parser) const =0
 Build an instance of a sgpp::datadriven::ModelFittingBase object as specified in the configuration file. More...
 
virtual FitterFactorycreateFitterFactory (const DataMiningConfigParser &parser) const =0
 
virtual ScorercreateScorer (const DataMiningConfigParser &parser) const
 Factory method to build a scorer instance base d on a configuration file. More...
 

Detailed Description

Abstract factory to build different kinds of Miners based on a configuration which is parsed from a file.

A miner consists of a data source, a fitter and a scorer. A concrete Factory class has to implement the required interfaces.

Constructor & Destructor Documentation

sgpp::datadriven::MinerFactory::MinerFactory ( )
default

Default constructor.

virtual sgpp::datadriven::MinerFactory::~MinerFactory ( )
virtualdefault

Virtual destructor.

Member Function Documentation

sgpp::datadriven::HyperparameterOptimizer * sgpp::datadriven::MinerFactory::buildHPO ( const std::string &  path) const
virtual
SparseGridMiner * sgpp::datadriven::MinerFactory::buildMiner ( const std::string &  path) const
virtual

Factory method to build a miner object based on a configuration file.

Parameters
pathPath to a configuration file that defines the structure of the miner object.

References createDataSourceCrossValidation(), createDataSourceSplitting(), createFitter(), createScorer(), sgpp::datadriven::DataMiningConfigParser::hasFitterConfigCrossValidation(), and create_dataset::parser.

Referenced by sgpp::datadriven::DensityEstimationMinerFactory::buildHPO(), buildHPO(), and main().

DataSourceCrossValidation * sgpp::datadriven::MinerFactory::createDataSourceCrossValidation ( const DataMiningConfigParser parser) const
protectedvirtual

Factory method to build a cross validation data source, i.e.

a data source that can seperate one fold from the data as validation set and use the rest for training

Parameters
parserthe datamining configuration parser instance to create the data source from
Returns
the data source instance

References sgpp::datadriven::DataSourceBuilder::crossValidationFromConfig(), sgpp::datadriven::DataMiningConfigParser::getDataSourceConfig(), and sgpp::datadriven::DataMiningConfigParser::getFitterCrossvalidationConfig().

Referenced by buildMiner().

DataSourceSplitting * sgpp::datadriven::MinerFactory::createDataSourceSplitting ( const DataMiningConfigParser parser) const
protectedvirtual

Factory method to build a splitting based data source, i.e.

a data source that splits data into validation and training data.

Parameters
parserthe datamining configuration parser instance to create the data source from
Returns
the data source instance

References sgpp::datadriven::DataMiningConfigParser::getDataSourceConfig(), and sgpp::datadriven::DataSourceBuilder::splittingFromConfig().

Referenced by buildMiner().

virtual ModelFittingBase* sgpp::datadriven::MinerFactory::createFitter ( const DataMiningConfigParser parser) const
protectedpure virtual

Build an instance of a sgpp::datadriven::ModelFittingBase object as specified in the configuration file.

Parameters
parserparser object that provides methods to query the configuration file.
Returns
Fully configured fitter (instance of a sgpp::datadriven::ModelFittingBase object) as specified in the configuration file.

Referenced by buildMiner().

virtual FitterFactory* sgpp::datadriven::MinerFactory::createFitterFactory ( const DataMiningConfigParser parser) const
protectedpure virtual

Referenced by buildHPO().

Scorer * sgpp::datadriven::MinerFactory::createScorer ( const DataMiningConfigParser parser) const
protectedvirtual

Factory method to build a scorer instance base d on a configuration file.

Parameters
parserthe datamining configuration parser instance to create the scorer from
Returns
the scorer instance

Referenced by buildMiner().


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