hex.gam

Class GAMModel

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<M>

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

hex.gam.GAMModel

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.api.StreamWriter, water.Freezable<GAMModel>

public class GAMModel
extends hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GAMModel.GAMModelOutput
static class	GAMModel.GAMParameters

Nested classes/interfaces inherited from class hex.Model

hex.Model.AdaptFrameParameters, hex.Model.BigScore, hex.Model.BigScoreChunkPredict, hex.Model.BigScorePredict, hex.Model.Contributions, hex.Model.DeepFeatures, hex.Model.ExemplarMembers, hex.Model.FeatureFrequencies, hex.Model.GetMostImportantFeatures, hex.Model.GetNTrees, hex.Model.GLRMArchetypes, hex.Model.GridSortBy, hex.Model.H2OModelDescriptor, hex.Model.InteractionBuilder, hex.Model.InteractionPair, hex.Model.InteractionSpec, hex.Model.JavaModelStreamWriter, hex.Model.JavaScoringOptions, hex.Model.LeafNodeAssignment, hex.Model.Output, hex.Model.Parameters, hex.Model.PredictScoreResult, hex.Model.RowToTreeAssignment, hex.Model.StagedPredictions, hex.Model.UpdateAuxTreeWeights

Field Summary

Fields

Modifier and Type	Field and Description
int	_cubicSplineNum
double[]	_gamColMeans
java.lang.String[][]	_gamColNames
java.lang.String[][]	_gamColNamesNoCentering
water.Key<water.fvec.Frame>[]	_gamFrameKeysCenter
int[]	_gamPredSize
int	_iSplineNum
int[]	_m
int[]	_M
int	_mSplineNum
int	_nclass
long	_nobs
long	_nullDOF
int	_rank
int	_thinPlateSmoothersWithKnotsNum
water.util.IcedHashSet<water.Key<water.fvec.Frame>>	_validKeys
double[]	_ymu

Fields inherited from class hex.Model

_dist, _input_parms, _output, _parms, _toDelete, _warnings, _warningsP, EVAL_AUTO_PARAMS_ENABLED, evalAutoParamsEnabled, scoringInfo

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
GAMModel(water.Key<GAMModel> selfKey, GAMModel.GAMParameters parms, GAMModel.GAMModelOutput output)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	adaptTestForTrain(water.fvec.Frame test, boolean expensive, boolean computeMetrics) This method will massage the input training frame such that it can be used for scoring for a GAM model.
static water.fvec.Frame	adaptValidFrame(water.fvec.Frame adptedF, water.fvec.Frame valid, GAMModel.GAMParameters parms, java.lang.String[][] gamColNames, double[][][] binvD, double[][][] zTranspose, double[][][] knots, double[][][] zTransposeCS, int[][][] polyBasisList, double[][] gamColMeansRaw, double[][] oneOGamColStd, int[] singleGAMArrays)
static water.fvec.Frame	addSingleVariableGamColumns(water.fvec.Frame adptedF, GAMModel.GAMParameters parms, java.lang.String[][] gamColNames, double[][][] binvD, double[][][] zTranspose, double[][][] knots, int[] singleGAMColArrays)
static water.fvec.Frame	addTPGamColumns(water.fvec.Frame adaptedF, GAMModel.GAMParameters parms, double[][][] zTransposeCS, double[][][] zTranspose, int[][][] polyBasisList, double[][][] knots, double[][] gamColMeansRaw, double[][] oneOColStd)
water.fvec.Frame	cleanUpInputFrame(water.fvec.Frame test)
static water.fvec.Frame	cleanUpInputFrame(water.fvec.Frame adptedF, GAMModel.GAMParameters parms, java.lang.String[][] gamColNames, double[][][] binvD, double[][][] zTranspose, double[][][] knots, double[][][] zTransposeCS, int[][][] polyBasisList, double[][] gamColMeansRaw, double[][] oneOGamColStd, int[] singleSplineNum)
water.util.TwoDimTable	genCoefficientMagTable(java.lang.String[] colHeaders, double[] coefficients, java.lang.String[] coefficientNames, java.lang.String tableHeader)
water.util.TwoDimTable	genCoefficientMagTableMultinomial(java.lang.String[] colHeaders, double[][] coefficients, java.lang.String[] coefficientNames, java.lang.String tableHeader)
GAMMojoWriter	getMojo()
void	initActualParamValuesAfterGlmCreation()
hex.ModelMetrics.MetricBuilder	makeMetricBuilder(java.lang.String[] domain)
java.lang.String[]	makeScoringNames()
protected hex.Model.PredictScoreResult	predictScoreImpl(water.fvec.Frame fr, water.fvec.Frame adaptFrm, java.lang.String destination_key, water.Job j, boolean computeMetrics, water.udf.CFuncRef customMetricFunc)
protected water.Keyed	readAll_impl(water.AutoBuffer ab, water.Futures fs)
protected water.Futures	remove_impl(water.Futures fs, boolean cascade)
double[]	score0(double[] data, double[] preds)
protected hex.ModelMetrics.MetricBuilder	scoreMetrics(water.fvec.Frame adaptFrm) Score on an already adapted validation frame during cross validation.
protected java.lang.String[][]	scoringDomains()
protected water.AutoBuffer	writeAll_impl(water.AutoBuffer ab)

Methods inherited from class hex.Model

adaptFrameForScore, adaptTestForJavaScoring, adaptTestForTrain, adaptTestForTrain, addMetrics, addModelMetrics, addWarning, aic, auc, AUCPR, checksum_impl, classification_error, compareTo, computeDeviances, containsResponse, data, defaultThreshold, defaultThreshold, deleteCrossValidationFoldAssignment, deleteCrossValidationModels, deleteCrossValidationPreds, deviance, deviance, evaluateAutoModelParameters, exportBinaryModel, exportMojo, fetchAll, fillScoringInfo, getDefaultGridSortBy, getGenModelEncoding, getPojoInterfaces, getToEigenVec, haveMojo, havePojo, importBinaryModel, initActualParamValues, isDistributionHuber, isFeatureUsedInPredict, isFeatureUsedInPredict, isGeneric, isSupervised, last_scored, lift_top_group, likelihood, logloss, loss, mae, makeAdaptFrameParameters, makeBigScoreTask, makeInteraction, makeInteractions, makeInteractions, makePojoWriter, makeSchema, makeScoringDomains, makeScoringNames, mean_per_class_error, modelDescriptor, mse, needsPostProcess, postProcessPredictions, r2, resetThreshold, result, rmsle, score, score, score, score, score, score, score, score, score0, score0, score0, score0PostProcessSupervised, scoring_history, setInputParms, setupBigScorePredict, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, toJava, toJava, toJava, toJavaAlgo, toJavaCheckTooBig, toJavaInit, toJavaModelClassName, toJavaPredictBody, toJavaTransform, toJavaUUID, toMojo, toMojo, toString, transform, uploadBinaryModel, writeTo

Methods inherited from class water.Lockable

delete_and_lock, delete_and_lock, delete_and_lock, delete_and_lock, delete, delete, delete, delete, read_lock, read_lock, read_lock, unlock_all, unlock, unlock, unlock, unlock, update, update, update, write_lock_to_read_lock, write_lock, write_lock, write_lock

Methods inherited from class water.Keyed

checksum_impl, checksum, checksum, getKey, readAll, remove_impl, remove_self_key_impl, remove, remove, remove, remove, remove, remove, removeQuietly, writeAll

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, wait, wait, wait

Field Detail

_gamColNamesNoCentering

public java.lang.String[][] _gamColNamesNoCentering

_gamColNames

public java.lang.String[][] _gamColNames

_gamPredSize

public int[] _gamPredSize

_m

public int[] _m

_M

public int[] _M

_cubicSplineNum

public int _cubicSplineNum

_iSplineNum

public int _iSplineNum

_mSplineNum

public int _mSplineNum

_thinPlateSmoothersWithKnotsNum

public int _thinPlateSmoothersWithKnotsNum

_gamFrameKeysCenter

public water.Key<water.fvec.Frame>[] _gamFrameKeysCenter

_gamColMeans

public double[] _gamColMeans

_nclass

public int _nclass

_ymu

public double[] _ymu

_nobs

public long _nobs

_nullDOF

public long _nullDOF

_rank

public int _rank

_validKeys

public water.util.IcedHashSet<water.Key<water.fvec.Frame>> _validKeys

Constructor Detail

GAMModel

public GAMModel(water.Key<GAMModel> selfKey,
                GAMModel.GAMParameters parms,
                GAMModel.GAMModelOutput output)

Method Detail

makeScoringNames

public java.lang.String[] makeScoringNames()

Overrides:

makeScoringNames in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

makeMetricBuilder

public hex.ModelMetrics.MetricBuilder makeMetricBuilder(java.lang.String[] domain)

Specified by:

makeMetricBuilder in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

initActualParamValuesAfterGlmCreation

public void initActualParamValuesAfterGlmCreation()

genCoefficientMagTableMultinomial

public water.util.TwoDimTable genCoefficientMagTableMultinomial(java.lang.String[] colHeaders,
                                                                double[][] coefficients,
                                                                java.lang.String[] coefficientNames,
                                                                java.lang.String tableHeader)

genCoefficientMagTable

public water.util.TwoDimTable genCoefficientMagTable(java.lang.String[] colHeaders,
                                                     double[] coefficients,
                                                     java.lang.String[] coefficientNames,
                                                     java.lang.String tableHeader)

scoreMetrics

protected hex.ModelMetrics.MetricBuilder scoreMetrics(water.fvec.Frame adaptFrm)

Score on an already adapted validation frame during cross validation. This function is not expected to be called by other methods. Returns a MetricBuilder that can be used to make a model metrics.

Overrides:

scoreMetrics in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

Parameters:

adaptFrm - Already adapted frame with gamified columns

Returns:

MetricBuilder

scoringDomains

protected java.lang.String[][] scoringDomains()

Overrides:

scoringDomains in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

adaptTestForTrain

public java.lang.String[] adaptTestForTrain(water.fvec.Frame test,
                                            boolean expensive,
                                            boolean computeMetrics)

This method will massage the input training frame such that it can be used for scoring for a GAM model.

Overrides:

adaptTestForTrain in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

Parameters:

test - Testing Frame, updated in-place

expensive - Try hard to adapt; this might involve the creation of whole Vecs and thus get expensive. If false, then only adapt if no warnings and errors; otherwise just the messages are produced. Created Vecs have to be deleted by the caller (e.g. Scope.enter/exit).

computeMetrics -

Returns:

cleanUpInputFrame

public water.fvec.Frame cleanUpInputFrame(water.fvec.Frame test)

cleanUpInputFrame

public static water.fvec.Frame cleanUpInputFrame(water.fvec.Frame adptedF,
                                                 GAMModel.GAMParameters parms,
                                                 java.lang.String[][] gamColNames,
                                                 double[][][] binvD,
                                                 double[][][] zTranspose,
                                                 double[][][] knots,
                                                 double[][][] zTransposeCS,
                                                 int[][][] polyBasisList,
                                                 double[][] gamColMeansRaw,
                                                 double[][] oneOGamColStd,
                                                 int[] singleSplineNum)

adaptValidFrame

public static water.fvec.Frame adaptValidFrame(water.fvec.Frame adptedF,
                                               water.fvec.Frame valid,
                                               GAMModel.GAMParameters parms,
                                               java.lang.String[][] gamColNames,
                                               double[][][] binvD,
                                               double[][][] zTranspose,
                                               double[][][] knots,
                                               double[][][] zTransposeCS,
                                               int[][][] polyBasisList,
                                               double[][] gamColMeansRaw,
                                               double[][] oneOGamColStd,
                                               int[] singleGAMArrays)

addTPGamColumns

public static water.fvec.Frame addTPGamColumns(water.fvec.Frame adaptedF,
                                               GAMModel.GAMParameters parms,
                                               double[][][] zTransposeCS,
                                               double[][][] zTranspose,
                                               int[][][] polyBasisList,
                                               double[][][] knots,
                                               double[][] gamColMeansRaw,
                                               double[][] oneOColStd)

addSingleVariableGamColumns

public static water.fvec.Frame addSingleVariableGamColumns(water.fvec.Frame adptedF,
                                                           GAMModel.GAMParameters parms,
                                                           java.lang.String[][] gamColNames,
                                                           double[][][] binvD,
                                                           double[][][] zTranspose,
                                                           double[][][] knots,
                                                           int[] singleGAMColArrays)

predictScoreImpl

protected hex.Model.PredictScoreResult predictScoreImpl(water.fvec.Frame fr,
                                                        water.fvec.Frame adaptFrm,
                                                        java.lang.String destination_key,
                                                        water.Job j,
                                                        boolean computeMetrics,
                                                        water.udf.CFuncRef customMetricFunc)

Overrides:

predictScoreImpl in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

score0

public double[] score0(double[] data,
                       double[] preds)

Specified by:

score0 in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

getMojo

public GAMMojoWriter getMojo()

Overrides:

getMojo in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

remove_impl

protected water.Futures remove_impl(water.Futures fs,
                                    boolean cascade)

Overrides:

remove_impl in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

writeAll_impl

protected water.AutoBuffer writeAll_impl(water.AutoBuffer ab)

Overrides:

writeAll_impl in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>

readAll_impl

protected water.Keyed readAll_impl(water.AutoBuffer ab,
                                   water.Futures fs)

Overrides:

readAll_impl in class hex.Model<GAMModel,GAMModel.GAMParameters,GAMModel.GAMModelOutput>