sgpp::datadriven::SparseGridMiner Class Reference

SparseGridMiner models the entire mining process for data mining with sparse grids. More...

#include <SparseGridMiner.hpp>

Inheritance diagram for sgpp::datadriven::SparseGridMiner:

Public Member Functions
ModelFittingBase *	getModel ()
	Returns the trained model. More...
virtual double	learn (bool verbose)=0
	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...
SparseGridMiner &	operator= (SparseGridMiner &&rhs)=default
	Default Move assign operator. More...
SparseGridMiner &	operator= (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...

Protected Attributes
std::unique_ptr< ModelFittingBase >	fitter
	Fitter that trains a model based on data samples. More...
std::unique_ptr< Scorer >	scorer
	Scorer that quantifies the quality of a fit. More...

Detailed Description

SparseGridMiner models the entire mining process for data mining with sparse grids.

It aggregates and automates data input, fitting and validation modules and controlls the mining process.

Constructor & Destructor Documentation

SparseGridMiner() [1/3]

sgpp::datadriven::SparseGridMiner::SparseGridMiner	(	ModelFittingBase *	fitter,
		Scorer *	scorer
	)

Constructor.

Parameters

fitter	configured instance of fitter object that generalize the model. The miner instance will take ownership of the passed object.
scorer	configured 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.

SparseGridMiner() [2/3]

sgpp::datadriven::SparseGridMiner::SparseGridMiner ( const SparseGridMiner &  rhs )

delete

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

Parameters

rhs	the object to copy from

SparseGridMiner() [3/3]

sgpp::datadriven::SparseGridMiner::SparseGridMiner ( SparseGridMiner &&  rhs )

default

Default Move constructor .

Parameters

rhs	the object to move from

~SparseGridMiner()

virtual sgpp::datadriven::SparseGridMiner::~SparseGridMiner ( )

virtualdefault

Default destructor.

Member Function Documentation

getModel()

ModelFittingBase * sgpp::datadriven::SparseGridMiner::getModel

(

)

Returns the trained model.

Returns

the trained model

learn()

virtual double sgpp::datadriven::SparseGridMiner::learn ( bool  verbose )

pure virtual

Perform Learning cycle: Get samples from data source and based on the scoring procedure, generalize data by fitting and asses quality of the fit.

Implemented in sgpp::datadriven::SparseGridMinerCrossValidation, and sgpp::datadriven::SparseGridMinerSplitting.

operator=() [1/2]

SparseGridMiner& sgpp::datadriven::SparseGridMiner::operator= ( SparseGridMiner &&  rhs )

default

Default Move assign operator.

Parameters

rhs	the object to move from

operator=() [2/2]

SparseGridMiner& sgpp::datadriven::SparseGridMiner::operator= ( const SparseGridMiner &  rhs )

delete

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

Parameters

rhs	the object to copy from

setModel()

void sgpp::datadriven::SparseGridMiner::setModel

(

ModelFittingBase *

model

)

References fitter.

test()

double sgpp::datadriven::SparseGridMiner::test

(

Dataset &

testDataset

)

Evaluate the model on a certain test dataset.

Parameters

testDataset

dataset used quantify accuracy using sgpp::datadriven::Metric.

Returns

score of the fit.

References fitter, and scorer.

Member Data Documentation

fitter

std::unique_ptr<ModelFittingBase> sgpp::datadriven::SparseGridMiner::fitter

protected

Fitter that trains a model based on data samples.

Referenced by sgpp::datadriven::SparseGridMinerCrossValidation::learn(), sgpp::datadriven::SparseGridMinerSplitting::learn(), setModel(), and test().

scorer

std::unique_ptr<Scorer> sgpp::datadriven::SparseGridMiner::scorer

protected

Scorer that quantifies the quality of a fit.

(e.g. cross validation or training with testing)

Referenced by sgpp::datadriven::SparseGridMinerCrossValidation::learn(), sgpp::datadriven::SparseGridMinerSplitting::learn(), and test().

---

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

• datadriven/src/sgpp/datadriven/datamining/base/SparseGridMiner.hpp
• datadriven/src/sgpp/datadriven/datamining/base/SparseGridMiner.cpp