JSDoc: Class: RandomForestClassifier

Name	Type	Attributes	Description
`dataset`	module:eclairjs/sql.Dataset
`paramMap`	module:eclairjs/ml/param.ParamMap	<optional>	Parameter map. These values override any specified in this Estimator's embedded ParamMap.

Inherited From:

module:eclairjs/ml.Estimator#fit

Source:

eclairjs/ml/Estimator.js, line 50

Returns:

fitted model

Type: module:eclairjs/ml.Estimator | module:eclairjs/ml/feature.Bucketizer

getFeaturesCol() → {string}

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 253

Returns:

Type: string

getLabelCol() → {string}

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 237

Returns:

Type: string

getPredictionCol() → {string}

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 269

Returns:

Type: string

getRawPredictionCol() → {string}

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 221

Returns:

Type: string

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

Param for label column name.

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 229

Returns:

Type: module:eclairjs/ml/param.Param

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

Param for prediction column name.

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 261

Returns:

Type: module:eclairjs/ml/param.Param

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

Inherited From:

module:eclairjs/ml/classification.ProbabilisticClassifier#probabilityCol

Source:

eclairjs/ml/classification/ProbabilisticClassifier.js, line 59

Returns:

Type: module:eclairjs/ml/param.Param

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

Param for raw prediction (a.k.a. confidence) column name.

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 213

Returns:

Type: module:eclairjs/ml/param.Param

setCacheNodeIds(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	boolean

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 118

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setCheckpointInterval(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 128

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

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

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml.Predictor#setFeaturesCol

Source:

eclairjs/ml/Predictor.js, line 63

Returns:

Type: module:eclairjs/ml.Predictor

setFeatureSubsetStrategy(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 178

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setImpurity(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 138

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

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

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml.Predictor#setLabelCol

Source:

eclairjs/ml/Predictor.js, line 53

Returns:

Type: module:eclairjs/ml.Predictor

setMaxBins(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 78

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setMaxDepth(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 68

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setMaxMemoryInMB(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 108

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setMinInfoGain(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	float

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 98

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setMinInstancesPerNode(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 88

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setNumTrees(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 168

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

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

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml.Predictor#setPredictionCol

Source:

eclairjs/ml/Predictor.js, line 73

Returns:

Type: module:eclairjs/ml.Predictor

setProbabilityCol(value) → {object}

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml/classification.ProbabilisticClassifier#setProbabilityCol

Source:

eclairjs/ml/classification/ProbabilisticClassifier.js, line 51

Returns:

Type: object

setRawPredictionCol(value) → {module:eclairjs/ml/classification.Classifier}

Parameters:

Name	Type	Description
`value`	string

Inherited From:

module:eclairjs/ml/classification.Classifier#setRawPredictionCol

Source:

eclairjs/ml/classification/Classifier.js, line 52

Returns:

Type: module:eclairjs/ml/classification.Classifier

setSeed(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 158

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setSubsamplingRate(value) → {module:eclairjs/ml/classification.RandomForestClassifier}

Parameters:

Name	Type	Description
`value`	float

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 148

Returns:

Type: module:eclairjs/ml/classification.RandomForestClassifier

setThresholds(value) → {object}

Parameters:

Name	Type	Description
`value`	Array.<float>

Inherited From:

module:eclairjs/ml/classification.ProbabilisticClassifier#setThresholds

Source:

eclairjs/ml/classification/ProbabilisticClassifier.js, line 67

Returns:

Type: object

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

Inherited From:

module:eclairjs/ml/classification.ProbabilisticClassifier#thresholds

Source:

eclairjs/ml/classification/ProbabilisticClassifier.js, line 75

Returns:

Type: module:eclairjs/ml/param.Param

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:

eclairjs/ml/Predictor.js, line 107

Returns:

Type: module:eclairjs/sql/types.StructType

uid() → {string}

An immutable unique ID for the object and its derivatives.

Source:

eclairjs/ml/classification/RandomForestClassifier.js, line 60

Returns:

Type: string

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:

eclairjs/ml/classification/RandomForestClassifier.js, line 202

Returns:

Type: module:eclairjs/sql/types.StructType