hex.rulefit

Class RuleFitModel

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<M>

hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

hex.rulefit.RuleFitModel

All Implemented Interfaces:

hex.SignificantRulesCollector, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.api.StreamWriter, water.Freezable<RuleFitModel>

public class RuleFitModel
extends hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>
implements hex.SignificantRulesCollector

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuleFitModel.Algorithm
static class	RuleFitModel.ModelType
static class	RuleFitModel.RuleFitOutput
static class	RuleFitModel.RuleFitParameters

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 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
RuleFitModel(water.Key<RuleFitModel> selfKey, RuleFitModel.RuleFitParameters parms, RuleFitModel.RuleFitOutput output, GLMModel glmModel, RuleEnsemble ruleEnsemble)

Method Summary

Modifier and Type	Method and Description
RuleFitMojoWriter	getMojo()
water.util.TwoDimTable	getRuleImportanceTable()
hex.ToEigenVec	getToEigenVec()
boolean	haveMojo()
hex.ModelMetrics.MetricBuilder	makeMetricBuilder(java.lang.String[] domain)
water.fvec.Frame	predictRules(water.fvec.Frame frame, java.lang.String[] ruleIds)
protected water.Futures	remove_impl(water.Futures fs, boolean cascade)
water.fvec.Frame	score(water.fvec.Frame fr, java.lang.String destination_key, water.Job j, boolean computeMetrics, water.udf.CFuncRef customMetricFunc)
protected double[]	score0(double[] data, double[] preds)

Methods inherited from class hex.Model

adaptFrameForScore, adaptTestForJavaScoring, adaptTestForTrain, 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, 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, makeScoringNames, mean_per_class_error, modelDescriptor, mse, needsPostProcess, postProcessPredictions, predictScoreImpl, r2, readAll_impl, resetThreshold, result, rmsle, score, score, score, score, score, score, score, score0, score0, score0, score0PostProcessSupervised, scoreMetrics, scoring_history, scoringDomains, setInputParms, setupBigScorePredict, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, toJava, toJava, toJava, toJavaAlgo, toJavaCheckTooBig, toJavaInit, toJavaModelClassName, toJavaPredictBody, toJavaTransform, toJavaUUID, toMojo, toMojo, toString, transform, uploadBinaryModel, writeAll_impl, 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

Constructor Detail

RuleFitModel

public RuleFitModel(water.Key<RuleFitModel> selfKey,
                    RuleFitModel.RuleFitParameters parms,
                    RuleFitModel.RuleFitOutput output,
                    GLMModel glmModel,
                    RuleEnsemble ruleEnsemble)

Method Detail

getToEigenVec

public hex.ToEigenVec getToEigenVec()

Overrides:

getToEigenVec in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

makeMetricBuilder

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

Specified by:

makeMetricBuilder in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

score0

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

Specified by:

score0 in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

score

public water.fvec.Frame score(water.fvec.Frame fr,
                              java.lang.String destination_key,
                              water.Job j,
                              boolean computeMetrics,
                              water.udf.CFuncRef customMetricFunc)
                       throws java.lang.IllegalArgumentException

Overrides:

score in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

Throws:

java.lang.IllegalArgumentException

remove_impl

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

Overrides:

remove_impl in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

getMojo

public RuleFitMojoWriter getMojo()

Overrides:

getMojo in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

haveMojo

public boolean haveMojo()

Overrides:

haveMojo in class hex.Model<RuleFitModel,RuleFitModel.RuleFitParameters,RuleFitModel.RuleFitOutput>

predictRules

public water.fvec.Frame predictRules(water.fvec.Frame frame,
                                     java.lang.String[] ruleIds)

getRuleImportanceTable

public water.util.TwoDimTable getRuleImportanceTable()

Specified by:

getRuleImportanceTable in interface hex.SignificantRulesCollector