hex.glm

Class GLMModel.GLMOutput

java.lang.Object

water.Iced

hex.Model.Output

hex.glm.GLMModel.GLMOutput

All Implemented Interfaces:

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

Enclosing class:

GLMModel

public static class GLMModel.GLMOutput
extends hex.Model.Output

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int[]	_activeColsPerClass
boolean	_all_constraints_satisfied
int	_best_lambda_idx
int	_best_submodel_idx
water.Key<water.fvec.Frame>	_betadiff_var
boolean	_binomial
java.lang.String[]	_coefficient_names
java.lang.String[]	_constraintCoefficientNames
ConstrainedGLMUtils.LinearConstraints[]	_equalityConstraintsBeta
ConstrainedGLMUtils.LinearConstraints[]	_equalityConstraintsLinear
double[][]	_initConstraintMatrix
double	_lambda_1se
double	_lambda_max
double	_lambda_min
ConstrainedGLMUtils.LinearConstraints[]	_lessThanEqualToConstraintsBeta
ConstrainedGLMUtils.LinearConstraints[]	_lessThanEqualToConstraintsLinear
java.lang.String[]	_linear_constraint_states
water.util.TwoDimTable	_linear_constraints_table
boolean	_multinomial
boolean	_ordinal
water.Key<water.fvec.Frame>	_regression_influence_diagnostics
int	_selected_alpha_idx
int	_selected_lambda_idx
int	_selected_submodel_idx
long	_training_time_ms
water.util.TwoDimTable	_variable_importances
hex.VarImp	_varimp

Fields inherited from class hex.Model.Output

_column_types, _cross_validation_fold_assignment_frame_id, _cross_validation_holdout_predictions_frame_id, _cross_validation_metrics, _cross_validation_metrics_summary, _cross_validation_models, _cross_validation_predictions, _cv_scoring_history, _defaultThreshold, _distribution, _domains, _end_time, _hasFold, _hasOffset, _hasTreatment, _hasWeights, _isSupervised, _job, _model_summary, _modelClassDist, _names, _orig_projection_array, _origDomains, _origNames, _priorClassDist, _reproducibility_information_table, _run_time, _scoring_history, _start_time, _total_run_time, _training_metrics, _validation_metrics

Constructor Summary

Constructors

Constructor and Description
GLMOutput()
GLMOutput(DataInfo dinfo, java.lang.String[] column_names, java.lang.String[] column_types, java.lang.String[][] domains, java.lang.String[] coefficient_names, double[] beta, boolean binomial, boolean multinomial, boolean ordinal)
GLMOutput(GLM glm)

Method Summary

Modifier and Type	Method and Description
double	alpha_best()
GLMModel.Submodel	bestSubmodel()
int	bestSubmodelIndex()
double[]	beta()
static double[]	calculatePValuesFromZValues(double[] zValues, boolean dispersionEstimated, long residualDegreesOfFreedom)
static double[]	calculateStdErrFromZValues(double[] zValues, double[] beta)
hex.VarImp	calculateVarimp()
protected long	checksum_impl()
java.lang.String[]	classNames()
java.lang.String[]	coefficientNames()
double	dispersion()
boolean	dispersionEstimated()
static water.fvec.Frame	expand(water.fvec.Frame fr, hex.Model.InteractionSpec interactions, boolean useAll, boolean standardize, boolean skipMissing)
double[][]	get_global_beta_multinomial()
DataInfo	getDinfo()
hex.ModelCategory	getModelCategory()
double[]	getNormBeta()
double[][]	getNormBetaMultinomial()
double[][]	getNormBetaMultinomial(int idx)
double[][]	getNormBetaMultinomial(int idx, boolean standardized)
GLMModel.Submodel	getSubmodel(double lambdaCVEstimate)
GLMModel.Submodel	getSubmodel(int submodel_index)
water.util.TwoDimTable	getVariableImportances()
double[]	getVariableInflationFactors()
java.util.Map<java.lang.String,java.lang.Double>	getVIFAndNames()
java.lang.String[]	getVIFPredictorNames()
double[]	getZValues()
boolean	hasPValues()
boolean	hasVIF()
hex.Model.InteractionBuilder	interactionBuilder()
boolean	isStandardized()
boolean	isSupervised()
double	lambda_1se()
double	lambda_best()
double	lambda_selected()
java.lang.String[]	multiClassCoeffNames()
int	nclasses()
GLMModel.Submodel	pickBestModel(GLMModel.GLMParameters parms)
double[]	pValues()
int	rank()
void	setLambdas(GLMModel.GLMParameters parms)
void	setSubmodelIdx(int l, GLMModel.GLMParameters parms)
double[]	stdErr()
double[]	variableInflationFactors()
double[][]	vcov() Variance Covariance matrix accessor.
double[]	ymu()
double[]	zValues()

Methods inherited from class hex.Model.Output

changeModelMetricsKey, clearModelMetrics, createInputFramesInformationTable, defaultThreshold, features, foldIdx, foldName, getInformationTableNumRows, getModelMetrics, hasFold, hasOffset, hasResponse, hasTreatment, hasWeights, isAutoencoder, isBinomialClassifier, isClassifier, isMultinomialClassifier, lastSpecialColumnIdx, nfeatures, offsetIdx, offsetName, printTwoDimTables, resetThreshold, responseIdx, responseName, setNames, setNames, startClock, stopClock, toString, treatmentIdx, treatmentName, weightsIdx, weightsName

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

_coefficient_names

public java.lang.String[] _coefficient_names

_training_time_ms

public long _training_time_ms

_variable_importances

public water.util.TwoDimTable _variable_importances

_varimp

public hex.VarImp _varimp

_lambda_1se

public double _lambda_1se

_lambda_min

public double _lambda_min

_lambda_max

public double _lambda_max

_selected_lambda_idx

public int _selected_lambda_idx

_selected_alpha_idx

public int _selected_alpha_idx

_selected_submodel_idx

public int _selected_submodel_idx

_best_submodel_idx

public int _best_submodel_idx

_best_lambda_idx

public int _best_lambda_idx

_linear_constraint_states

public java.lang.String[] _linear_constraint_states

_all_constraints_satisfied

public boolean _all_constraints_satisfied

_linear_constraints_table

public water.util.TwoDimTable _linear_constraints_table

_regression_influence_diagnostics

public water.Key<water.fvec.Frame> _regression_influence_diagnostics

_betadiff_var

public water.Key<water.fvec.Frame> _betadiff_var

_activeColsPerClass

public int[] _activeColsPerClass

_equalityConstraintsLinear

public ConstrainedGLMUtils.LinearConstraints[] _equalityConstraintsLinear

_lessThanEqualToConstraintsLinear

public ConstrainedGLMUtils.LinearConstraints[] _lessThanEqualToConstraintsLinear

_equalityConstraintsBeta

public ConstrainedGLMUtils.LinearConstraints[] _equalityConstraintsBeta

_lessThanEqualToConstraintsBeta

public ConstrainedGLMUtils.LinearConstraints[] _lessThanEqualToConstraintsBeta

_constraintCoefficientNames

public java.lang.String[] _constraintCoefficientNames

_initConstraintMatrix

public double[][] _initConstraintMatrix

_binomial

public boolean _binomial

_multinomial

public boolean _multinomial

_ordinal

public boolean _ordinal

Constructor Detail

GLMOutput

public GLMOutput(DataInfo dinfo,
                 java.lang.String[] column_names,
                 java.lang.String[] column_types,
                 java.lang.String[][] domains,
                 java.lang.String[] coefficient_names,
                 double[] beta,
                 boolean binomial,
                 boolean multinomial,
                 boolean ordinal)

GLMOutput

public GLMOutput()

GLMOutput

public GLMOutput(GLM glm)

Method Detail

lambda_best

public double lambda_best()

dispersion

public double dispersion()

dispersionEstimated

public boolean dispersionEstimated()

alpha_best

public double alpha_best()

lambda_1se

public double lambda_1se()

getDinfo

public DataInfo getDinfo()

bestSubmodelIndex

public int bestSubmodelIndex()

lambda_selected

public double lambda_selected()

hasPValues

public boolean hasPValues()

hasVIF

public boolean hasVIF()

stdErr

public double[] stdErr()

calculateStdErrFromZValues

public static double[] calculateStdErrFromZValues(double[] zValues,
                                                  double[] beta)

getZValues

public double[] getZValues()

getVariableInflationFactors

public double[] getVariableInflationFactors()

getVIFPredictorNames

public java.lang.String[] getVIFPredictorNames()

getVIFAndNames

public java.util.Map<java.lang.String,java.lang.Double> getVIFAndNames()

getVariableImportances

public water.util.TwoDimTable getVariableImportances()

Overrides:

getVariableImportances in class hex.Model.Output

getModelCategory

public hex.ModelCategory getModelCategory()

Overrides:

getModelCategory in class hex.Model.Output

checksum_impl

protected long checksum_impl()

Overrides:

checksum_impl in class hex.Model.Output

zValues

public double[] zValues()

calculatePValuesFromZValues

public static double[] calculatePValuesFromZValues(double[] zValues,
                                                   boolean dispersionEstimated,
                                                   long residualDegreesOfFreedom)

pValues

public double[] pValues()

variableInflationFactors

public double[] variableInflationFactors()

setLambdas

public void setLambdas(GLMModel.GLMParameters parms)

rank

public int rank()

ymu

public double[] ymu()

isStandardized

public boolean isStandardized()

coefficientNames

public java.lang.String[] coefficientNames()

multiClassCoeffNames

public java.lang.String[] multiClassCoeffNames()

isSupervised

public boolean isSupervised()

Overrides:

isSupervised in class hex.Model.Output

interactionBuilder

public hex.Model.InteractionBuilder interactionBuilder()

Overrides:

interactionBuilder in class hex.Model.Output

expand

public static water.fvec.Frame expand(water.fvec.Frame fr,
                                      hex.Model.InteractionSpec interactions,
                                      boolean useAll,
                                      boolean standardize,
                                      boolean skipMissing)

vcov

public double[][] vcov()

Variance Covariance matrix accessor. Available only if odel has been built with p-values.

Returns:

nclasses

public int nclasses()

Overrides:

nclasses in class hex.Model.Output

classNames

public java.lang.String[] classNames()

Overrides:

classNames in class hex.Model.Output

pickBestModel

public GLMModel.Submodel pickBestModel(GLMModel.GLMParameters parms)

getNormBeta

public double[] getNormBeta()

getNormBetaMultinomial

public double[][] getNormBetaMultinomial()

getNormBetaMultinomial

public double[][] getNormBetaMultinomial(int idx)

getNormBetaMultinomial

public double[][] getNormBetaMultinomial(int idx,
                                         boolean standardized)

get_global_beta_multinomial

public double[][] get_global_beta_multinomial()

setSubmodelIdx

public void setSubmodelIdx(int l,
                           GLMModel.GLMParameters parms)

beta

public double[] beta()

bestSubmodel

public GLMModel.Submodel bestSubmodel()

getSubmodel

public GLMModel.Submodel getSubmodel(double lambdaCVEstimate)

getSubmodel

public GLMModel.Submodel getSubmodel(int submodel_index)

calculateVarimp

public hex.VarImp calculateVarimp()