Class: RandomForestRegressor

eclairjs/ml/regression.RandomForestRegressor

Random Forest learning algorithm for regression. It supports both continuous and categorical features.

Constructor

new RandomForestRegressor(uidopt)

Parameters:

Name	Type	Attributes	Description
`uid`	string	<optional>

Source:

ml/regression/RandomForestRegressor.js, line 36

Extends

module:eclairjs/ml.Predictor

Methods

(static) load(path) → {RandomForestRegressor}

Parameters:

Name	Type	Description
`path`	string

Source:

ml/regression/RandomForestRegressor.js, line 370

Returns:

Type: RandomForestRegressor

(static) supportedFeatureSubsetStrategies() → {Promise.<Array.<string>>}

Accessor for supported featureSubsetStrategy settings: auto, all, onethird, sqrt, log2

Source:

ml/regression/RandomForestRegressor.js, line 406

Returns:

Type: Promise.<Array.<string>>

(static) supportedImpurities() → {Promise.<Array.<string>>}

Accessor for supported impurity settings: entropy, gini

Source:

ml/regression/RandomForestRegressor.js, line 389

Returns:

Type: Promise.<Array.<string>>

copy(extra) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`extra`	module:eclairjs/ml/param.ParamMap

Overrides:

module:eclairjs/ml.Predictor#copy

Source:

ml/regression/RandomForestRegressor.js, line 228

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

extractParamMap() → {module:eclairjs/ml/param.ParamMap}

Inherited From:

module:eclairjs/ml.Estimator#extractParamMap

Source:

ml/Estimator.js, line 70

Returns:

Type: module:eclairjs/ml/param.ParamMap

featuresCol() → {module:eclairjs/ml/param.Param}

Param for features column name.

Source:

ml/regression/RandomForestRegressor.js, line 291

Returns:

Type: module:eclairjs/ml/param.Param

fit(dataset) → {module:eclairjs/ml/regression.RandomForestRegressionModel}

Parameters:

Name	Type	Description
`dataset`	module:eclairjs/sql.DataFrame

Overrides:

module:eclairjs/ml.Predictor#fit

Source:

ml/regression/RandomForestRegressor.js, line 348

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressionModel

getFeaturesCol() → {Promise.<string>}

Source:

ml/regression/RandomForestRegressor.js, line 305

Returns:

Type: Promise.<string>

getLabelCol() → {Promise.<string>}

Source:

ml/regression/RandomForestRegressor.js, line 276

Returns:

Type: Promise.<string>

getPredictionCol() → {Promise.<string>}

Source:

ml/regression/RandomForestRegressor.js, line 333

Returns:

Type: Promise.<string>

labelCol() → {module:eclairjs/ml/param.Param}

Param for label column name.

Source:

ml/regression/RandomForestRegressor.js, line 262

Returns:

Type: module:eclairjs/ml/param.Param

predictionCol() → {module:eclairjs/ml/param.Param}

Param for prediction column name.

Source:

ml/regression/RandomForestRegressor.js, line 319

Returns:

Type: module:eclairjs/ml/param.Param

setCacheNodeIds(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	boolean

Source:

ml/regression/RandomForestRegressor.js, line 123

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setCheckpointInterval(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 138

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setFeaturesCol(value) → {module:eclairjs/ml.Predictor}

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml.Predictor#setFeaturesCol

Source:

ml/Predictor.js, line 61

Returns:

Type: module:eclairjs/ml.Predictor

setFeatureSubsetStrategy(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	string

Source:

ml/regression/RandomForestRegressor.js, line 213

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setImpurity(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	string

Source:

ml/regression/RandomForestRegressor.js, line 153

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setLabelCol(value) → {module:eclairjs/ml.Predictor}

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml.Predictor#setLabelCol

Source:

ml/Predictor.js, line 46

Returns:

Type: module:eclairjs/ml.Predictor

setMaxBins(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 63

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setMaxDepth(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 48

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setMaxMemoryInMB(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 108

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setMinInfoGain(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 93

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setMinInstancesPerNode(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 78

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setNumTrees(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 198

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setPredictionCol(value) → {module:eclairjs/ml.Predictor}

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml.Predictor#setPredictionCol

Source:

ml/Predictor.js, line 76

Returns:

Type: module:eclairjs/ml.Predictor

setSeed(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 183

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

setSubsamplingRate(value) → {module:eclairjs/ml/regression.RandomForestRegressor}

Parameters:

Name	Type	Description
`value`	number

Source:

ml/regression/RandomForestRegressor.js, line 168

Returns:

Type: module:eclairjs/ml/regression.RandomForestRegressor

transformSchema(schema) → {module:eclairjs/sql/types.StructType}

Parameters:

Name	Type	Description
`schema`	module:eclairjs/sql/types.StructType

Inherited From:

module:eclairjs/ml.Predictor#transformSchema

Source:

ml/Predictor.js, line 106

Returns:

Type: module:eclairjs/sql/types.StructType

validateAndTransformSchema(schema, fitting, featuresDataType) → {module:eclairjs/sql/types.StructType}

Validates and transforms the input schema with the provided param map.

Parameters:

Name	Type	Description
`schema`	module:eclairjs/sql/types.StructType
`fitting`	boolean	whether this is in fitting
`featuresDataType`	module:eclairjs/sql/types.DataType	SQL DataType for FeaturesType. E.g., module:eclairjs/sql/types.VectorUDTfor vector features

Source:

ml/regression/RandomForestRegressor.js, line 247

Returns:

Type: module:eclairjs/sql/types.StructType