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

HyperparameterOptimizer uses fitters provided by a fitterFactory to test in a SparseGridMiner It offers access to different hyperparameter optimization procedures. More...

#include <HyperparameterOptimizer.hpp>

Inheritance diagram for sgpp::datadriven::HyperparameterOptimizer:
sgpp::datadriven::BoHyperparameterOptimizer sgpp::datadriven::HarmonicaHyperparameterOptimizer

Public Member Functions

 HyperparameterOptimizer (SparseGridMiner *miner, FitterFactory *fitterFactory, DataMiningConfigParser &parser)
 Constructor. More...
 
 HyperparameterOptimizer (const HyperparameterOptimizer &rhs)=delete
 Copy constructor deleted - not all members can be copied or cloned . More...
 
 HyperparameterOptimizer (HyperparameterOptimizer &&rhs)=default
 Default Move constructor . More...
 
HyperparameterOptimizeroperator= (HyperparameterOptimizer &&rhs)=default
 Default Move assign operator. More...
 
HyperparameterOptimizeroperator= (const HyperparameterOptimizer &rhs)=delete
 Default copy assign operator deleted because not all members can be copied. More...
 
virtual double run (bool writeToFile)=0
 Run hyperparameter optimization. More...
 
virtual ~HyperparameterOptimizer ()=default
 Default destructor. More...
 

Protected Attributes

HPOConfig config
 Configuration for all hpo details. More...
 
std::unique_ptr< FitterFactoryfitterFactory
 FitterFactory to provide fitters for running different hyperparameter configurations. More...
 
std::unique_ptr< SparseGridMinerminer
 Miner providing all testing facilities. More...
 

Detailed Description

HyperparameterOptimizer uses fitters provided by a fitterFactory to test in a SparseGridMiner It offers access to different hyperparameter optimization procedures.

Constructor & Destructor Documentation

sgpp::datadriven::HyperparameterOptimizer::HyperparameterOptimizer ( SparseGridMiner miner,
FitterFactory fitterFactory,
DataMiningConfigParser parser 
)

Constructor.

Parameters
minerconfigured instance of SGMiner object, that will provide the learning process. The HyperparameterOptimizer instance will take ownership of the passed object.
fitterFactoryconfigured instance of factory object that provides fitters with manipulated hyperparameters. The HyperparameterOptimizer instance will take ownership of the passed object.
parserreference to parser object to read configuration info

References config, sgpp::datadriven::DataMiningConfigParser::getHPOConfig(), and sgpp::datadriven::HPOConfig::setupDefaults().

sgpp::datadriven::HyperparameterOptimizer::HyperparameterOptimizer ( const HyperparameterOptimizer rhs)
delete

Copy constructor deleted - not all members can be copied or cloned .

Parameters
rhsthe object to copy from
sgpp::datadriven::HyperparameterOptimizer::HyperparameterOptimizer ( HyperparameterOptimizer &&  rhs)
default

Default Move constructor .

Parameters
rhsthe object to move from
virtual sgpp::datadriven::HyperparameterOptimizer::~HyperparameterOptimizer ( )
virtualdefault

Default destructor.

Member Function Documentation

HyperparameterOptimizer& sgpp::datadriven::HyperparameterOptimizer::operator= ( HyperparameterOptimizer &&  rhs)
default

Default Move assign operator.

Parameters
rhsthe object to move from
HyperparameterOptimizer& sgpp::datadriven::HyperparameterOptimizer::operator= ( const HyperparameterOptimizer rhs)
delete

Default copy assign operator deleted because not all members can be copied.

Parameters
rhsthe object to copy from
virtual double sgpp::datadriven::HyperparameterOptimizer::run ( bool  writeToFile)
pure virtual

Member Data Documentation

HPOConfig sgpp::datadriven::HyperparameterOptimizer::config
protected
std::unique_ptr<FitterFactory> sgpp::datadriven::HyperparameterOptimizer::fitterFactory
protected

FitterFactory to provide fitters for running different hyperparameter configurations.

Referenced by sgpp::datadriven::BoHyperparameterOptimizer::run(), and sgpp::datadriven::HarmonicaHyperparameterOptimizer::run().

std::unique_ptr<SparseGridMiner> sgpp::datadriven::HyperparameterOptimizer::miner
protected

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