hex.gam

Class GAM

java.lang.Object

water.Iced

hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

hex.gam.GAM

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

public class GAM
extends hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hex.ModelBuilder

hex.ModelBuilder.BuilderVisibility, hex.ModelBuilder.Driver, hex.ModelBuilder.FilterCols, hex.ModelBuilder.ModelTrainingCoordinator, hex.ModelBuilder.ValidationMessage

Field Summary

Fields

Modifier and Type	Field and Description
int	_glmNFolds
double[][]	_oneOGamColStd
double[]	_penaltyScale

Fields inherited from class hex.ModelBuilder

_coordinator, _desc, _eventPublisher, _fold, _input_parms, _job, _messages, _nclass, _offset, _orig_projection_array, _origDomains, _origNames, _origTrain, _parms, _priorClassDist, _removedCols, _response, _result, _startUpOnceModelBuilder, _train, _treatment, _valid, _vresponse, _weights

Constructor Summary

Constructors

Constructor and Description
GAM(boolean startup_once)
GAM(GAMModel.GAMParameters parms)
GAM(GAMModel.GAMParameters parms, water.Key<GAMModel> key)

Method Summary

Modifier and Type	Method and Description
void	assertValidGAMColumnsCountSplineTypes() Check and make sure correct BS type is assigned to the various gam_columns specified.
hex.ModelBuilder.BuilderVisibility	builderVisibility()
hex.ModelCategory[]	can_build()
void	checkGAMParamsLengths() Check and make sure if related parameters are defined, they must be of correct length.
void	checkNFamilyNLinkAssignment() check if _parms._family = AUTO, the correct link functions are assigned according to the response type.
void	checkOrChooseNumKnots() set default num_knots to 10 for gam_columns where there is no knot_id specified for CS smoothers for TP smoothers, default is set to be max of 10 or _M+2.
void	checkThinPlateParams() verify and check thin plate regression smoothers specific parameters
void	checkTrainRowNumKnots() Check and make sure the there are enough number of rows in the training dataset to accomodate the num_knot settings.
protected boolean	computePriorClassDistribution()
void	failVerifyKnots(double[] knots, int gam_column_index)
double[][][]	generateKnotsFromKeys() This method will look at the keys of knots stored in _parms._knot_ids and copy them over to double[][][] array.
boolean	haveMojo()
boolean	havePojo()
void	init(boolean expensive)
boolean	isSupervised()
protected int	nModelsInParallel(int folds)
protected hex.gam.GAM.GAMDriver	trainModelImpl()

Methods inherited from class hex.ModelBuilder

algoName, algos, canLearnFromNAs, checkCustomMetricForEarlyStopping, checkDistributions, checkEarlyStoppingReproducibility, checkMemoryFootPrint_impl, checkMemoryFootPrint, checkResponseVariable, clearInitState, clearValidationErrors, computeCrossValidation, cv_buildModels, cv_canBuildMainModelInParallel, cv_computeAndSetOptimalParameters, cv_initStoppingParameters, cv_mainModelScores, cv_makeAggregateModelMetrics, cv_scoreCVModels, cv_updateOptimalParameters, defaultKey, desiredChunks, dest, error_count, error, get, getMessagesByFieldAndSeverity, getName, getSysProperty, getToEigenVec, hasFoldCol, hasOffsetCol, hasTreatmentCol, hasWeightCol, hide, ignoreBadColumns, ignoreConstColumns, ignoreInvalidColumns, ignoreStringColumns, ignoreUuidColumns, info, init_adaptFrameToTrain, init_getNClass, initWorkspace, isClassifier, isResponseOptional, isStopped, javaName, logMe, make, make, make, makeCVMetrics, makeCVModelBuilder, makeParameters, makePojoWriter, message, nclasses, nFoldCV, nFoldWork, nModelsInParallel, nModelsInParallel, numSpecialCols, paramName, raiseReproducibilityWarning, rebalance, remainingTimeSecs, response, schemaDirectory, separateFeatureVecs, setMaxRuntimeSecsForMainModel, setTrain, setValid, shouldReorder, smallDataSize, stop_requested, timeout, train, trainModel, trainModel, trainModelNested, trainModelNested, trainModelOnH2ONode, valid, validateBinaryResponse, validateStoppingMetric, validationErrors, validationWarnings, vresponse, warn

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_oneOGamColStd

public double[][] _oneOGamColStd

_penaltyScale

public double[] _penaltyScale

_glmNFolds

public int _glmNFolds

Constructor Detail

GAM

public GAM(boolean startup_once)

GAM

public GAM(GAMModel.GAMParameters parms)

GAM

public GAM(GAMModel.GAMParameters parms,
           water.Key<GAMModel> key)

Method Detail

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

isSupervised

public boolean isSupervised()

Specified by:

isSupervised in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

builderVisibility

public hex.ModelBuilder.BuilderVisibility builderVisibility()

Overrides:

builderVisibility in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

havePojo

public boolean havePojo()

Overrides:

havePojo in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

haveMojo

public boolean haveMojo()

Overrides:

haveMojo in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

generateKnotsFromKeys

public double[][][] generateKnotsFromKeys()

This method will look at the keys of knots stored in _parms._knot_ids and copy them over to double[][][] array. Note that we have smoothers that take different number of columns. We will keep the gam columns of single predictor smoothers to the front and multiple predictor smoothers to the back of the array. For smoothers that take more than one predictor column, knot location is determined by first sorting the first gam_column and then extract the quantiles of that sorted gam_columns. Here, instead of taking the value for one gam column, we take the whole row with all the predictors for that smoother.

Returns:

double[][][] array containing the knots specified by users

failVerifyKnots

public void failVerifyKnots(double[] knots,
                            int gam_column_index)

init

public void init(boolean expensive)

Overrides:

init in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

checkTrainRowNumKnots

public void checkTrainRowNumKnots()

Check and make sure the there are enough number of rows in the training dataset to accomodate the num_knot settings.

checkGAMParamsLengths

public void checkGAMParamsLengths()

Check and make sure if related parameters are defined, they must be of correct length. Their length must equal to the number of gam columns specified which is the length of _parms._gam_columns.length.

checkNFamilyNLinkAssignment

public void checkNFamilyNLinkAssignment()

check if _parms._family = AUTO, the correct link functions are assigned according to the response type. If no family type is assigned, they will be assigned automatically according to the response type.

checkThinPlateParams

public void checkThinPlateParams()

verify and check thin plate regression smoothers specific parameters

checkOrChooseNumKnots

public void checkOrChooseNumKnots()

set default num_knots to 10 for gam_columns where there is no knot_id specified for CS smoothers for TP smoothers, default is set to be max of 10 or _M+2. for I-splines, default set to 2 which is minimum. for M-splines, default set to 2 which is minimum.

assertValidGAMColumnsCountSplineTypes

public void assertValidGAMColumnsCountSplineTypes()

Check and make sure correct BS type is assigned to the various gam_columns specified. Make sure the gam columns specified are actually found in the training dataset. In addition, the number of CS and TP smoothers are counted here as well.

computePriorClassDistribution

protected boolean computePriorClassDistribution()

Overrides:

computePriorClassDistribution in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

trainModelImpl

protected hex.gam.GAM.GAMDriver trainModelImpl()

Specified by:

trainModelImpl in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

nModelsInParallel

protected int nModelsInParallel(int folds)

Overrides:

nModelsInParallel in class hex.ModelBuilder<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>