GClasses
GClasses::GSupervisedLearner Class Referenceabstract

Detailed Description

This is the base class of algorithms that learn with supervision and have an internal hypothesis model that allows them to generalize rows that were not available at training time.

#include <GLearner.h>

Inheritance diagram for GClasses::GSupervisedLearner:
GClasses::GTransducer GClasses::GBaselineLearner GClasses::GBucket GClasses::GDecisionTree GClasses::GEnsemble GClasses::GGaussianProcess GClasses::GIdentityFunction GClasses::GIncrementalLearner GClasses::GLinearDistribution GClasses::GLinearRegressor GClasses::GMeanMarginsTree GClasses::GPolynomial GClasses::GRandomForest GClasses::GSparseInstance GClasses::GWag

Public Member Functions

 GSupervisedLearner ()
 General-purpose constructor. More...
 
 GSupervisedLearner (const GDomNode *pNode)
 Deserialization constructor. More...
 
virtual ~GSupervisedLearner ()
 Destructor. More...
 
void basicTest (double minAccuracy1, double minAccuracy2, double deviation=1e-6, bool printAccuracy=false, double warnRange=0.035)
 This is a helper method used by the unit tests of several model learners. More...
 
virtual bool canGeneralize ()
 Returns true because fully supervised learners have an internal model that allows them to generalize previously unseen rows. More...
 
virtual void clear ()=0
 Discards all training for the purpose of freeing memory. If you call this method, you must train before making any predictions. No settings or options are discarded, so you should be able to train again without specifying any other parameters and still get a comparable model. More...
 
void confusion (GMatrix &features, GMatrix &labels, std::vector< GMatrix * > &stats)
 Generates a confusion matrix containing the total counts of the number of times each value was expected and predicted. (Rows represent target values, and columns represent predicted values.) stats should be an empty vector. This method will resize stats to the number of dimensions in the label vector. The caller is responsible to delete all of the matrices that it puts in this vector. For continuous labels, the value will be NULL. More...
 
virtual bool isFilter ()
 Returns false. More...
 
void precisionRecall (double *pOutPrecision, size_t nPrecisionSize, GMatrix &features, GMatrix &labels, size_t label, size_t nReps)
 label specifies which output to measure. (It should be 0 if there is only one label dimension.) The measurement will be performed "nReps" times and results averaged together nPrecisionSize specifies the number of points at which the function is sampled pOutPrecision should be an array big enough to hold nPrecisionSize elements for every possible label value. (If the attribute is continuous, it should just be big enough to hold nPrecisionSize elements.) If bLocal is true, it computes the local precision instead of the global precision. More...
 
virtual void predict (const GVec &in, GVec &out)=0
 Evaluate pIn to compute a prediction for pOut. The model must be trained (by calling train) before the first time that this method is called. pIn and pOut should point to arrays of doubles of the same size as the number of columns in the training matrices that were passed to the train method. More...
 
virtual void predictDistribution (const GVec &in, GPrediction *pOut)=0
 Evaluate pIn and compute a prediction for pOut. pOut is expected to point to an array of GPrediction objects which have already been allocated. There should be labelDims() elements in this array. The distributions will be more accurate if the model is calibrated before the first time that this method is called. More...
 
const GRelationrelFeatures ()
 Returns a reference to the feature relation (meta-data about the input attributes). More...
 
const GRelationrelLabels ()
 Returns a reference to the label relation (meta-data about the output attributes). More...
 
virtual GDomNodeserialize (GDom *pDoc) const =0
 Marshal this object into a DOM that can be converted to a variety of formats. (Implementations of this method should use baseDomNode.) More...
 
double sumSquaredError (const GMatrix &features, const GMatrix &labels, double *pOutSAE=NULL)
 Computes the sum-squared-error for predicting the labels from the features. For categorical labels, Hamming distance is used. More...
 
void train (const GMatrix &features, const GMatrix &labels)
 Call this method to train the model. More...
 
virtual double trainAndTest (const GMatrix &trainFeatures, const GMatrix &trainLabels, const GMatrix &testFeatures, const GMatrix &testLabels, double *pOutSAE=NULL)
 Trains and tests this learner. Returns sum-squared-error. More...
 
- Public Member Functions inherited from GClasses::GTransducer
 GTransducer ()
 General-purpose constructor. More...
 
 GTransducer (const GTransducer &that)
 Copy-constructor. Throws an exception to prevent models from being copied by value. More...
 
virtual ~GTransducer ()
 
virtual bool canImplicitlyHandleContinuousFeatures ()
 Returns true iff this algorithm can implicitly handle continuous features. If it cannot, then the GDiscretize transform will be used to convert continuous features to nominal values before passing them to it. More...
 
virtual bool canImplicitlyHandleContinuousLabels ()
 Returns true iff this algorithm can implicitly handle continuous labels (a.k.a. regression). If it cannot, then the GDiscretize transform will be used during training to convert nominal labels to continuous values, and to convert nominal predictions back to continuous labels. More...
 
virtual bool canImplicitlyHandleMissingFeatures ()
 Returns true iff this algorithm supports missing feature values. If it cannot, then an imputation filter will be used to predict missing values before any feature-vectors are passed to the algorithm. More...
 
virtual bool canImplicitlyHandleNominalFeatures ()
 Returns true iff this algorithm can implicitly handle nominal features. If it cannot, then the GNominalToCat transform will be used to convert nominal features to continuous values before passing them to it. More...
 
virtual bool canImplicitlyHandleNominalLabels ()
 Returns true iff this algorithm can implicitly handle nominal labels (a.k.a. classification). If it cannot, then the GNominalToCat transform will be used during training to convert nominal labels to continuous values, and to convert categorical predictions back to nominal labels. More...
 
virtual bool canTrainIncrementally ()
 Returns false because semi-supervised learners cannot be trained incrementally. More...
 
double crossValidate (const GMatrix &features, const GMatrix &labels, size_t nFolds, double *pOutSAE=NULL, RepValidateCallback pCB=NULL, size_t nRep=0, void *pThis=NULL)
 Perform n-fold cross validation on pData. Returns sum-squared error. Uses trainAndTest for each fold. pCB is an optional callback method for reporting intermediate stats. It can be NULL if you don't want intermediate reporting. nRep is just the rep number that will be passed to the callback. pThis is just a pointer that will be passed to the callback for you to use however you want. It doesn't affect this method. if pOutSAE is not NULL, the sum absolute error will be placed there. More...
 
GTransduceroperator= (const GTransducer &other)
 Throws an exception to prevent models from being copied by value. More...
 
GRandrand ()
 Returns a reference to the random number generator associated with this object. For example, you could use it to change the random seed, to make this algorithm behave differently. This might be important, for example, in an ensemble of learners. More...
 
double repValidate (const GMatrix &features, const GMatrix &labels, size_t reps, size_t nFolds, double *pOutSAE=NULL, RepValidateCallback pCB=NULL, void *pThis=NULL)
 Perform cross validation "nReps" times and return the average score. pCB is an optional callback method for reporting intermediate stats It can be NULL if you don't want intermediate reporting. pThis is just a pointer that will be passed to the callback for you to use however you want. It doesn't affect this method. if pOutSAE is not NULL, the sum absolute error will be placed there. More...
 
virtual bool supportedFeatureRange (double *pOutMin, double *pOutMax)
 Returns true if this algorithm supports any feature value, or if it does not implicitly handle continuous features. If a limited range of continuous values is supported, returns false and sets pOutMin and pOutMax to specify the range. More...
 
virtual bool supportedLabelRange (double *pOutMin, double *pOutMax)
 Returns true if this algorithm supports any label value, or if it does not implicitly handle continuous labels. If a limited range of continuous values is supported, returns false and sets pOutMin and pOutMax to specify the range. More...
 
std::unique_ptr< GMatrixtransduce (const GMatrix &features1, const GMatrix &labels1, const GMatrix &features2)
 Predicts a set of labels to correspond with features2, such that these labels will be consistent with the patterns exhibited by features1 and labels1. More...
 
void transductiveConfusionMatrix (const GMatrix &trainFeatures, const GMatrix &trainLabels, const GMatrix &testFeatures, const GMatrix &testLabels, std::vector< GMatrix * > &stats)
 Makes a confusion matrix for a transduction algorithm. More...
 

Static Public Member Functions

static void test ()
 Runs some unit tests related to supervised learning. Throws an exception if any problems are found. More...
 

Protected Member Functions

GDomNodebaseDomNode (GDom *pDoc, const char *szClassName) const
 Child classes should use this in their implementation of serialize. More...
 
size_t precisionRecallContinuous (GPrediction *pOutput, double *pFunc, GMatrix &trainFeatures, GMatrix &trainLabels, GMatrix &testFeatures, GMatrix &testLabels, size_t label)
 This is a helper method used by precisionRecall. More...
 
size_t precisionRecallNominal (GPrediction *pOutput, double *pFunc, GMatrix &trainFeatures, GMatrix &trainLabels, GMatrix &testFeatures, GMatrix &testLabels, size_t label, int value)
 This is a helper method used by precisionRecall. More...
 
void setupFilters (const GMatrix &features, const GMatrix &labels)
 This method determines which data filters (normalize, discretize, and/or nominal-to-cat) are needed and trains them. More...
 
virtual void trainInner (const GMatrix &features, const GMatrix &labels)=0
 This is the implementation of the model's training algorithm. (This method is called by train). More...
 
virtual std::unique_ptr< GMatrixtransduceInner (const GMatrix &features1, const GMatrix &labels1, const GMatrix &features2)
 See GTransducer::transduce. More...
 

Static Protected Member Functions

static void addInterpolatedFunction (double *pOut, size_t nOutVals, double *pIn, size_t nInVals)
 Adds the function pIn to pOut after interpolating pIn to be the same size as pOut. (This is a helper-function used by precisionRecall.) More...
 

Protected Attributes

GRelationm_pRelFeatures
 
GRelationm_pRelLabels
 
- Protected Attributes inherited from GClasses::GTransducer
GRand m_rand
 

Constructor & Destructor Documentation

GClasses::GSupervisedLearner::GSupervisedLearner ( )

General-purpose constructor.

GClasses::GSupervisedLearner::GSupervisedLearner ( const GDomNode pNode)

Deserialization constructor.

virtual GClasses::GSupervisedLearner::~GSupervisedLearner ( )
virtual

Destructor.

Member Function Documentation

static void GClasses::GSupervisedLearner::addInterpolatedFunction ( double *  pOut,
size_t  nOutVals,
double *  pIn,
size_t  nInVals 
)
staticprotected

Adds the function pIn to pOut after interpolating pIn to be the same size as pOut. (This is a helper-function used by precisionRecall.)

GDomNode* GClasses::GSupervisedLearner::baseDomNode ( GDom pDoc,
const char *  szClassName 
) const
protected

Child classes should use this in their implementation of serialize.

void GClasses::GSupervisedLearner::basicTest ( double  minAccuracy1,
double  minAccuracy2,
double  deviation = 1e-6,
bool  printAccuracy = false,
double  warnRange = 0.035 
)

This is a helper method used by the unit tests of several model learners.

virtual bool GClasses::GSupervisedLearner::canGeneralize ( )
inlinevirtual

Returns true because fully supervised learners have an internal model that allows them to generalize previously unseen rows.

Reimplemented from GClasses::GTransducer.

virtual void GClasses::GSupervisedLearner::clear ( )
pure virtual

Discards all training for the purpose of freeing memory. If you call this method, you must train before making any predictions. No settings or options are discarded, so you should be able to train again without specifying any other parameters and still get a comparable model.

Implemented in GClasses::GIdentityFunction, GClasses::GBaselineLearner, GClasses::GReservoirNet, GClasses::GFilter, GClasses::GBucket, GClasses::GNeuralNetLearner, GClasses::GWag, GClasses::GResamplingAdaBoost, GClasses::GSparseInstance, GClasses::GInstanceTable, GClasses::GRandomForest, GClasses::GMeanMarginsTree, GClasses::GBag, GClasses::GLinearDistribution, GClasses::GKNN, GClasses::GDecisionTree, GClasses::GGaussianProcess, GClasses::GNeuralDecomposition, GClasses::GNaiveInstance, GClasses::GNaiveBayes, GClasses::GPolynomial, and GClasses::GLinearRegressor.

void GClasses::GSupervisedLearner::confusion ( GMatrix features,
GMatrix labels,
std::vector< GMatrix * > &  stats 
)

Generates a confusion matrix containing the total counts of the number of times each value was expected and predicted. (Rows represent target values, and columns represent predicted values.) stats should be an empty vector. This method will resize stats to the number of dimensions in the label vector. The caller is responsible to delete all of the matrices that it puts in this vector. For continuous labels, the value will be NULL.

virtual bool GClasses::GSupervisedLearner::isFilter ( )
inlinevirtual

Returns false.

Reimplemented in GClasses::GFilter, and GClasses::GIncrementalLearner.

void GClasses::GSupervisedLearner::precisionRecall ( double *  pOutPrecision,
size_t  nPrecisionSize,
GMatrix features,
GMatrix labels,
size_t  label,
size_t  nReps 
)

label specifies which output to measure. (It should be 0 if there is only one label dimension.) The measurement will be performed "nReps" times and results averaged together nPrecisionSize specifies the number of points at which the function is sampled pOutPrecision should be an array big enough to hold nPrecisionSize elements for every possible label value. (If the attribute is continuous, it should just be big enough to hold nPrecisionSize elements.) If bLocal is true, it computes the local precision instead of the global precision.

size_t GClasses::GSupervisedLearner::precisionRecallContinuous ( GPrediction pOutput,
double *  pFunc,
GMatrix trainFeatures,
GMatrix trainLabels,
GMatrix testFeatures,
GMatrix testLabels,
size_t  label 
)
protected

This is a helper method used by precisionRecall.

size_t GClasses::GSupervisedLearner::precisionRecallNominal ( GPrediction pOutput,
double *  pFunc,
GMatrix trainFeatures,
GMatrix trainLabels,
GMatrix testFeatures,
GMatrix testLabels,
size_t  label,
int  value 
)
protected

This is a helper method used by precisionRecall.

virtual void GClasses::GSupervisedLearner::predict ( const GVec in,
GVec out 
)
pure virtual
virtual void GClasses::GSupervisedLearner::predictDistribution ( const GVec in,
GPrediction pOut 
)
pure virtual
const GRelation& GClasses::GSupervisedLearner::relFeatures ( )

Returns a reference to the feature relation (meta-data about the input attributes).

const GRelation& GClasses::GSupervisedLearner::relLabels ( )

Returns a reference to the label relation (meta-data about the output attributes).

void GClasses::GSupervisedLearner::setupFilters ( const GMatrix features,
const GMatrix labels 
)
protected

This method determines which data filters (normalize, discretize, and/or nominal-to-cat) are needed and trains them.

double GClasses::GSupervisedLearner::sumSquaredError ( const GMatrix features,
const GMatrix labels,
double *  pOutSAE = NULL 
)

Computes the sum-squared-error for predicting the labels from the features. For categorical labels, Hamming distance is used.

static void GClasses::GSupervisedLearner::test ( )
static

Runs some unit tests related to supervised learning. Throws an exception if any problems are found.

void GClasses::GSupervisedLearner::train ( const GMatrix features,
const GMatrix labels 
)

Call this method to train the model.

virtual double GClasses::GSupervisedLearner::trainAndTest ( const GMatrix trainFeatures,
const GMatrix trainLabels,
const GMatrix testFeatures,
const GMatrix testLabels,
double *  pOutSAE = NULL 
)
virtual

Trains and tests this learner. Returns sum-squared-error.

Reimplemented from GClasses::GTransducer.

virtual std::unique_ptr<GMatrix> GClasses::GSupervisedLearner::transduceInner ( const GMatrix features1,
const GMatrix labels1,
const GMatrix features2 
)
protectedvirtual

Member Data Documentation

GRelation* GClasses::GSupervisedLearner::m_pRelFeatures
protected
GRelation* GClasses::GSupervisedLearner::m_pRelLabels
protected