hex.schemas

Class UpliftDRFV3.UpliftDRFParametersV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<P,S>

water.api.schemas3.ModelParametersSchemaV3<P,S>

hex.schemas.SharedTreeV3.SharedTreeParametersV3<UpliftDRFModel.UpliftDRFParameters,UpliftDRFV3.UpliftDRFParametersV3>

hex.schemas.UpliftDRFV3.UpliftDRFParametersV3

All Implemented Interfaces:

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

Enclosing class:

UpliftDRFV3

public static final class UpliftDRFV3.UpliftDRFParametersV3
extends SharedTreeV3.SharedTreeParametersV3<UpliftDRFModel.UpliftDRFParameters,UpliftDRFV3.UpliftDRFParametersV3>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

water.api.schemas3.SchemaV3.Meta

Nested classes/interfaces inherited from class water.api.Schema

water.api.Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
int	auuc_nbins
hex.AUUC.AUUCType	auuc_type
static java.lang.String[]	fields
int	mtries
double	sample_rate
java.lang.String	treatment_column
UpliftDRFModel.UpliftDRFParameters.UpliftMetricType	uplift_metric

Fields inherited from class hex.schemas.SharedTreeV3.SharedTreeParametersV3

balance_classes, build_tree_one_node, calibrate_model, calibration_frame, calibration_method, check_constant_response, class_sampling_factors, col_sample_rate_change_per_level, col_sample_rate_per_tree, histogram_type, in_training_checkpoints_dir, in_training_checkpoints_tree_interval, max_after_balance_size, max_confusion_matrix_size, max_depth, min_rows, min_split_improvement, nbins, nbins_cats, nbins_top_level, ntrees, r2_stopping, sample_rate_per_class, score_tree_interval, seed

Fields inherited from class water.api.schemas3.ModelParametersSchemaV3

auc_type, categorical_encoding, checkpoint, custom_distribution_func, custom_metric_func, distribution, export_checkpoints_dir, fold_assignment, fold_column, gainslift_bins, huber_alpha, ignore_const_cols, ignored_columns, keep_cross_validation_fold_assignment, keep_cross_validation_models, keep_cross_validation_predictions, max_categorical_levels, max_runtime_secs, model_id, nfolds, offset_column, parallelize_cross_validation, quantile_alpha, response_column, score_each_iteration, stopping_metric, stopping_rounds, stopping_tolerance, training_frame, tweedie_power, validation_frame, weights_column

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
UpliftDRFParametersV3()

Method Summary

Methods inherited from class water.api.schemas3.ModelParametersSchemaV3

append_field_arrays, extractDeclaredApiParameters, fields, fillFromImpl, fillImpl, getAdditionalParameters, writeParametersJSON

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

fields

public static java.lang.String[] fields

mtries

@API(help="Number of variables randomly sampled as candidates at each split. If set to -1, defaults to sqrt{p} for classification and p/3 for regression (where p is the # of predictors",
     gridable=true)
public int mtries

sample_rate

@API(help="Row sample rate per tree (from 0.0 to 1.0)",
     gridable=true)
public double sample_rate

treatment_column

@API(help="Define the column which will be used for computing uplift gain to select best split for a tree. The column has to divide the dataset into treatment (value 1) and control (value 0) groups.",
     gridable=false,
     level=secondary,
     required=true,
     is_member_of_frames={"training_frame","validation_frame"},
     is_mutually_exclusive_with={"ignored_columns","response_column","weights_column"})
public java.lang.String treatment_column

uplift_metric

@API(help="Divergence metric used to find best split when building an uplift tree.",
     level=secondary,
     values={"AUTO","KL","Euclidean","ChiSquared"},
     gridable=true)
public UpliftDRFModel.UpliftDRFParameters.UpliftMetricType uplift_metric

auuc_type

@API(help="Metric used to calculate Area Under Uplift Curve.",
     level=secondary,
     values={"AUTO","qini","lift","gain"})
public hex.AUUC.AUUCType auuc_type

auuc_nbins

@API(help="Number of bins to calculate Area Under Uplift Curve.",
     level=secondary)
public int auuc_nbins

Constructor Detail

UpliftDRFParametersV3

public UpliftDRFParametersV3()