hex.schemas

Class IsolationForestV3.IsolationForestParametersV3

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<IsolationForestModel.IsolationForestParameters,IsolationForestV3.IsolationForestParametersV3>

hex.schemas.IsolationForestV3.IsolationForestParametersV3

All Implemented Interfaces:

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

Enclosing class:

IsolationForestV3

public static final class IsolationForestV3.IsolationForestParametersV3
extends SharedTreeV3.SharedTreeParametersV3<IsolationForestModel.IsolationForestParameters,IsolationForestV3.IsolationForestParametersV3>

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
double	contamination
static java.lang.String[]	fields
int	mtries
double	sample_rate
long	sample_size
water.api.schemas3.FrameV3.ColSpecifierV3	validation_response_column

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
IsolationForestParametersV3()

Method Summary

Modifier and Type	Method and Description
IsolationForestV3.IsolationForestParametersV3	fillFromImpl(IsolationForestModel.IsolationForestParameters impl)
IsolationForestModel.IsolationForestParameters	fillImpl(IsolationForestModel.IsolationForestParameters impl)

Methods inherited from class water.api.schemas3.ModelParametersSchemaV3

append_field_arrays, extractDeclaredApiParameters, fields, 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

sample_size

@API(help="Number of randomly sampled observations used to train each Isolation Forest tree. Only one of parameters sample_size and sample_rate should be defined. If sample_rate is defined, sample_size will be ignored.",
     gridable=true)
public long sample_size

sample_rate

@API(help="Rate of randomly sampled observations used to train each Isolation Forest tree. Needs to be in range from 0.0 to 1.0. If set to -1, sample_rate is disabled and sample_size will be used instead.",
     gridable=true)
public double sample_rate

mtries

@API(help="Number of variables randomly sampled as candidates at each split. If set to -1, defaults (number of predictors)/3.",
     gridable=true)
public int mtries

contamination

@API(help="Contamination ratio - the proportion of anomalies in the input dataset. If undefined (-1) the predict function will not mark observations as anomalies and only anomaly score will be returned. Defaults to -1 (undefined).")
public double contamination

validation_response_column

@API(level=secondary,
     direction=INOUT,
     is_member_of_frames="validation_frame",
     is_mutually_exclusive_with="ignored_columns",
     help="(experimental) Name of the response column in the validation frame. Response column should be binary and indicate not anomaly/anomaly.")
public water.api.schemas3.FrameV3.ColSpecifierV3 validation_response_column

Constructor Detail

IsolationForestParametersV3

public IsolationForestParametersV3()

Method Detail

fillFromImpl

public IsolationForestV3.IsolationForestParametersV3 fillFromImpl(IsolationForestModel.IsolationForestParameters impl)

Overrides:

fillFromImpl in class water.api.schemas3.ModelParametersSchemaV3<IsolationForestModel.IsolationForestParameters,IsolationForestV3.IsolationForestParametersV3>

fillImpl

public IsolationForestModel.IsolationForestParameters fillImpl(IsolationForestModel.IsolationForestParameters impl)

Overrides:

fillImpl in class water.api.schemas3.ModelParametersSchemaV3<IsolationForestModel.IsolationForestParameters,IsolationForestV3.IsolationForestParametersV3>