hex.glm

Class GLMModel

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<M>

hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

hex.glm.GLMModel

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<GLMModel>

public class GLMModel
extends hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

Created by tomasnykodym on 8/27/14.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GLMModel.GLMOutput
static class	GLMModel.GLMParameters
static class	GLMModel.Submodel

Nested classes/interfaces inherited from class hex.Model

hex.Model.DeepFeatures, hex.Model.Output, hex.Model.Parameters

Nested classes/interfaces inherited from class water.Keyed

water.Keyed.BinarySerializer<X extends water.Keyed>

Field Summary

Fields

Modifier and Type	Field and Description
double	_lambda_max
long	_nobs
double	_ymu
double	_ySigma

Fields inherited from class hex.Model

_output, _parms, _warnings

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key, EMPTY_KEY_LIST

Constructor Summary

Constructors

Constructor and Description
GLMModel(water.Key selfKey, GLMModel.GLMParameters parms, GLM job, double ymu, double ySigma, double lambda_max, long nobs, boolean hasWeights, boolean hasOffset)

Method Summary

Methods

Modifier and Type	Method and Description
double[]	beta()
long	checksum_impl()
java.util.HashMap<java.lang.String,java.lang.Double>	coefficients() get beta coefficients in a map indexed by name
double	deviance(double w, double y, double f)
DataInfo	dinfo()
water.util.TwoDimTable	generateSummary(water.Key train, int iter) Re-do the TwoDim table generation with updated model.
static GLMModel	makeGLMModel(GLMModel.GLMParameters.Family fam, double[] coefficients, java.lang.String[] predictors, java.lang.String response) Make GLM model with given coefficients (predictors can be numeric only at the moment) Example: @see GLMTest.testMakeModel().
hex.ModelMetrics.MetricBuilder	makeMetricBuilder(java.lang.String[] domain)
java.lang.String[]	names()
double[]	score0(water.fvec.Chunk[] chks, int row_in_chunk, double[] tmp, double[] preds)
protected double[]	score0(double[] data, double[] preds)
protected double[]	score0(double[] data, double[] preds, double w, double o)
void	setSubmodel(GLMModel.Submodel sm)
protected boolean	toJavaCheckTooBig()
protected water.util.SB	toJavaInit(water.util.SB sb, water.util.SB fileContext)
protected void	toJavaPredictBody(water.util.SB body, water.util.SB classCtx, water.util.SB file)

Methods inherited from class hex.Model

adaptTestForTrain, adaptTestForTrain, addMetrics, addWarning, cleanup_adapt, defaultThreshold, delete, getPublishedKeys, isSupervised, predictScoreImpl, remove_impl, score, score, score, score0, scoreMetrics, testJavaScoring, toJava, toJava, toJavaNCLASSES, toJavaPROB, toJavaSuper, toString

Methods inherited from class water.Lockable

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

Methods inherited from class water.Keyed

checksum, getBinarySerializer, remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_lambda_max

public final double _lambda_max

_ymu

public final double _ymu

_ySigma

public final double _ySigma

_nobs

public final long _nobs

Constructor Detail

GLMModel

public GLMModel(water.Key selfKey,
        GLMModel.GLMParameters parms,
        GLM job,
        double ymu,
        double ySigma,
        double lambda_max,
        long nobs,
        boolean hasWeights,
        boolean hasOffset)

Method Detail

toJavaCheckTooBig

protected boolean toJavaCheckTooBig()

Overrides:

toJavaCheckTooBig in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

dinfo

public DataInfo dinfo()

makeMetricBuilder

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

Specified by:

makeMetricBuilder in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

beta

public double[] beta()

names

public java.lang.String[] names()

deviance

public double deviance(double w,
              double y,
              double f)

Overrides:

deviance in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

coefficients

public java.util.HashMap<java.lang.String,java.lang.Double> coefficients()

get beta coefficients in a map indexed by name

Returns:

the estimated coefficients

setSubmodel

public void setSubmodel(GLMModel.Submodel sm)

generateSummary

public water.util.TwoDimTable generateSummary(water.Key train,
                                     int iter)

Re-do the TwoDim table generation with updated model.

makeGLMModel

public static GLMModel makeGLMModel(GLMModel.GLMParameters.Family fam,
                    double[] coefficients,
                    java.lang.String[] predictors,
                    java.lang.String response)

Make GLM model with given coefficients (predictors can be numeric only at the moment) Example: @see GLMTest.testMakeModel().

Parameters:

fam - - glm family, always uses canonical link

coefficients - - vector of coefficients, assumed the same order as predictor names, intercept in the end

predictors - - NAmes of predictor columns, does not include Intercept

Returns:

GLM model usable for scoring

checksum_impl

public long checksum_impl()

Overrides:

checksum_impl in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

score0

public double[] score0(water.fvec.Chunk[] chks,
              int row_in_chunk,
              double[] tmp,
              double[] preds)

Overrides:

score0 in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

score0

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

Specified by:

score0 in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

score0

protected double[] score0(double[] data,
              double[] preds,
              double w,
              double o)

Overrides:

score0 in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

toJavaPredictBody

protected void toJavaPredictBody(water.util.SB body,
                     water.util.SB classCtx,
                     water.util.SB file)

Overrides:

toJavaPredictBody in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>

toJavaInit

protected water.util.SB toJavaInit(water.util.SB sb,
                       water.util.SB fileContext)

Overrides:

toJavaInit in class hex.Model<GLMModel,GLMModel.GLMParameters,GLMModel.GLMOutput>