hex.tree

Class SharedTreeModel.SharedTreeParameters

java.lang.Object

water.Iced<hex.Model.Parameters>

hex.Model.Parameters

hex.tree.SharedTreeModel.SharedTreeParameters

All Implemented Interfaces:

hex.Model.AdaptFrameParameters, hex.Model.GetNTrees, CalibrationHelper.ParamsWithCalibration, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<hex.Model.Parameters>

Direct Known Subclasses:

DRFModel.DRFParameters, GBMModel.GBMParameters, IsolationForestModel.IsolationForestParameters, UpliftDRFModel.UpliftDRFParameters

Enclosing class:

SharedTreeModel<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

public abstract static class SharedTreeModel.SharedTreeParameters
extends hex.Model.Parameters
implements hex.Model.GetNTrees, CalibrationHelper.ParamsWithCalibration

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SharedTreeModel.SharedTreeParameters.HistogramType

Nested classes/interfaces inherited from class hex.Model.Parameters

hex.Model.Parameters.CategoricalEncodingScheme, hex.Model.Parameters.FoldAssignmentScheme

Field Summary

Fields

Modifier and Type	Field and Description
boolean	_build_tree_one_node
boolean	_calibrate_model
water.Key<water.fvec.Frame>	_calibration_frame
CalibrationHelper.CalibrationMethod	_calibration_method
double	_col_sample_rate_change_per_level
double	_col_sample_rate_per_tree
SharedTreeModel.SharedTreeParameters.HistogramType	_histogram_type
java.lang.String	_in_training_checkpoints_dir
int	_in_training_checkpoints_tree_interval
int	_initial_score_interval
int	_max_depth
double	_min_rows
double	_min_split_improvement
int	_nbins
int	_nbins_cats
int	_nbins_top_level
int	_ntrees
boolean	_parallel_main_model_building
double	_r2_stopping
double	_sample_rate
double[]	_sample_rate_per_class
int	_score_interval
int	_score_tree_interval
boolean	_use_best_cv_iteration

Fields inherited from class hex.Model.Parameters

_auc_type, _auto_rebalance, _auuc_nbins, _auuc_type, _balance_classes, _categorical_encoding, _check_constant_response, _checkpoint, _class_sampling_factors, _custom_distribution_func, _custom_metric_func, _cv_fold, _distribution, _export_checkpoints_dir, _fold_assignment, _fold_column, _gainslift_bins, _huber_alpha, _ignore_const_cols, _ignored_columns, _is_cv_model, _keep_cross_validation_fold_assignment, _keep_cross_validation_models, _keep_cross_validation_predictions, _keep_cross_validation_predictions_precision, _main_model_time_budget_factor, _max_after_balance_size, _max_categorical_levels, _max_confusion_matrix_size, _max_runtime_secs, _nfolds, _offset_column, _parallelize_cross_validation, _preprocessors, _pretrained_autoencoder, _quantile_alpha, _response_column, _score_each_iteration, _seed, _stopping_metric, _stopping_rounds, _stopping_tolerance, _train, _treatment_column, _tweedie_power, _valid, _weights_column, MAX_SUPPORTED_LEVELS

Constructor Summary

Constructors

Constructor and Description
SharedTreeParameters()

Method Summary

Modifier and Type	Method and Description
boolean	calibrateModel()
boolean	forceStrictlyReproducibleHistograms() Do we need to enable strictly deterministic way of building histograms? Used eg.
water.fvec.Frame	getCalibrationFrame()
CalibrationHelper.CalibrationMethod	getCalibrationMethod()
int	getNTrees()
hex.Model.Parameters	getParams()
boolean	isStochastic()
long	progressUnits()
void	setCalibrationMethod(CalibrationHelper.CalibrationMethod calibrationMethod)
boolean	useColSampling()
boolean	useRowSampling()

Methods inherited from class hex.Model.Parameters

algoName, checksum, checksum, defaultDropConsCols, defaultStoppingTolerance, fullName, getCategoricalEncoding, getDependentKeys, getDistributionFamily, getFoldColumn, getMaxCategoricalLevels, getNonPredictors, getOffsetColumn, getOrMakeRealSeed, getResponseColumn, getTreatmentColumn, getUsedColumns, getWeightsColumn, hasCheckpoint, hasCustomMetricFunc, javaName, missingColumnsType, read_lock_frames, read_unlock_frames, setDistributionFamily, setTrain, train, valid

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

_ntrees

public int _ntrees

_max_depth

public int _max_depth

_min_rows

public double _min_rows

_nbins

public int _nbins

_nbins_cats

public int _nbins_cats

_min_split_improvement

public double _min_split_improvement

_histogram_type

public SharedTreeModel.SharedTreeParameters.HistogramType _histogram_type

_r2_stopping

public double _r2_stopping

_nbins_top_level

public int _nbins_top_level

_build_tree_one_node

public boolean _build_tree_one_node

_score_tree_interval

public int _score_tree_interval

_initial_score_interval

public int _initial_score_interval

_score_interval

public int _score_interval

_sample_rate

public double _sample_rate

_sample_rate_per_class

public double[] _sample_rate_per_class

_calibrate_model

public boolean _calibrate_model

_calibration_frame

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

_calibration_method

public CalibrationHelper.CalibrationMethod _calibration_method

_col_sample_rate_change_per_level

public double _col_sample_rate_change_per_level

_col_sample_rate_per_tree

public double _col_sample_rate_per_tree

_parallel_main_model_building

public boolean _parallel_main_model_building

_use_best_cv_iteration

public boolean _use_best_cv_iteration

_in_training_checkpoints_dir

public java.lang.String _in_training_checkpoints_dir

_in_training_checkpoints_tree_interval

public int _in_training_checkpoints_tree_interval

Constructor Detail

SharedTreeParameters

public SharedTreeParameters()

Method Detail

useRowSampling

public boolean useRowSampling()

progressUnits

public long progressUnits()

Specified by:

progressUnits in class hex.Model.Parameters

useColSampling

public boolean useColSampling()

isStochastic

public boolean isStochastic()

getNTrees

public int getNTrees()

Specified by:

getNTrees in interface hex.Model.GetNTrees

getCalibrationFrame

public water.fvec.Frame getCalibrationFrame()

Specified by:

getCalibrationFrame in interface CalibrationHelper.ParamsWithCalibration

calibrateModel

public boolean calibrateModel()

Specified by:

calibrateModel in interface CalibrationHelper.ParamsWithCalibration

getCalibrationMethod

public CalibrationHelper.CalibrationMethod getCalibrationMethod()

Specified by:

getCalibrationMethod in interface CalibrationHelper.ParamsWithCalibration

setCalibrationMethod

public void setCalibrationMethod(CalibrationHelper.CalibrationMethod calibrationMethod)

Specified by:

setCalibrationMethod in interface CalibrationHelper.ParamsWithCalibration

getParams

public hex.Model.Parameters getParams()

Specified by:

getParams in interface CalibrationHelper.ParamsWithCalibration

forceStrictlyReproducibleHistograms

public boolean forceStrictlyReproducibleHistograms()

Do we need to enable strictly deterministic way of building histograms? Used eg. when monotonicity constraints in GBM are enabled, by default disabled

Returns:

true if histograms should be built in deterministic way