SG++-Doxygen-Documentation
sgpp::datadriven::SparseGridMinerCrossValidation Class Reference

SparseGridMinerCrossValidation models a datamining process that involves cross validation to validate the accuracy of the model itself. More...

#include <SparseGridMinerCrossValidation.hpp>

Inheritance diagram for sgpp::datadriven::SparseGridMinerCrossValidation:
sgpp::datadriven::SparseGridMiner

Public Member Functions

double learn (bool verbose) override
 Perform Learning cycle: Get samples from data source and based on the scoring procedure, generalize data by fitting and asses quality of the fit. More...
 
SparseGridMinerCrossValidationoperator= (SparseGridMinerCrossValidation &&rhs)=default
 Default Move assign operator. More...
 
SparseGridMinerCrossValidationoperator= (const SparseGridMinerCrossValidation &rhs)=delete
 Default copy assign operator deleted because not all members can be copied. More...
 
 SparseGridMinerCrossValidation (DataSourceCrossValidation *dataSource, ModelFittingBase *fitter, Scorer *scorer)
 Constructor. More...
 
 SparseGridMinerCrossValidation (const SparseGridMinerCrossValidation &rhs)=delete
 Copy constructor deleted - not all members can be copied or cloned . More...
 
 SparseGridMinerCrossValidation (SparseGridMinerCrossValidation &&rhs)=default
 Default Move constructor . More...
 
 ~SparseGridMinerCrossValidation ()=default
 Default destructor. More...
 
- Public Member Functions inherited from sgpp::datadriven::SparseGridMiner
ModelFittingBasegetModel ()
 Returns the trained model. More...
 
SparseGridMineroperator= (SparseGridMiner &&rhs)=default
 Default Move assign operator. More...
 
SparseGridMineroperator= (const SparseGridMiner &rhs)=delete
 Default copy assign operator deleted because not all members can be copied. More...
 
void setModel (ModelFittingBase *model)
 
 SparseGridMiner (ModelFittingBase *fitter, Scorer *scorer)
 Constructor. More...
 
 SparseGridMiner (const SparseGridMiner &rhs)=delete
 Copy constructor deleted - not all members can be copied or cloned . More...
 
 SparseGridMiner (SparseGridMiner &&rhs)=default
 Default Move constructor . More...
 
double test (Dataset &testDataset)
 Evaluate the model on a certain test dataset. More...
 
virtual ~SparseGridMiner ()=default
 Default destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from sgpp::datadriven::SparseGridMiner
std::unique_ptr< ModelFittingBasefitter
 Fitter that trains a model based on data samples. More...
 
std::unique_ptr< Scorerscorer
 Scorer that quantifies the quality of a fit. More...
 

Detailed Description

SparseGridMinerCrossValidation models a datamining process that involves cross validation to validate the accuracy of the model itself.

This process it slow and memory consuming and only recommended for small datasets.

Constructor & Destructor Documentation

◆ SparseGridMinerCrossValidation() [1/3]

sgpp::datadriven::SparseGridMinerCrossValidation::SparseGridMinerCrossValidation ( DataSourceCrossValidation dataSource,
ModelFittingBase fitter,
Scorer scorer 
)

Constructor.

Parameters
dataSourceconfigured instance of data source object, that will provide samples to learn from. The miner instance will take ownership of the passed object.
fitterconfigured instance of fitter object that generalize the model. The miner instance will take ownership of the passed object.
scorerconfigured instance of scorer object that will assess the quality of the generalization provided by the fitter on testing data. The miner instance will take ownership of the passed object.

◆ SparseGridMinerCrossValidation() [2/3]

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

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

Parameters
rhsthe object to copy from

◆ SparseGridMinerCrossValidation() [3/3]

sgpp::datadriven::SparseGridMinerCrossValidation::SparseGridMinerCrossValidation ( SparseGridMinerCrossValidation &&  rhs)
default

Default Move constructor .

Parameters
rhsthe object to move from

◆ ~SparseGridMinerCrossValidation()

sgpp::datadriven::SparseGridMinerCrossValidation::~SparseGridMinerCrossValidation ( )
default

Default destructor.

Member Function Documentation

◆ learn()

double sgpp::datadriven::SparseGridMinerCrossValidation::learn ( bool  verbose)
overridevirtual

◆ operator=() [1/2]

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

Default Move assign operator.

Parameters
rhsthe object to move from

◆ operator=() [2/2]

SparseGridMinerCrossValidation& sgpp::datadriven::SparseGridMinerCrossValidation::operator= ( const SparseGridMinerCrossValidation rhs)
delete

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

Parameters
rhsthe object to copy from

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