Class: DecisionTreeClassifier

eclairjs/ml/classification. DecisionTreeClassifier

Decision tree learning algorithm for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.

Constructor

new DecisionTreeClassifier(uidopt)

Parameters:

Name	Type	Attributes	Description
`uid`	string	<optional>

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 36

Extends

module:eclairjs/ml.PipelineStage

Methods

(static) load(path) → {module:eclairjs/ml/classification.DecisionTreeClassifier}

Parameters:

Name	Type	Description
`path`	string

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 284

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

copy(extra) → {module:eclairjs/ml/classification.DecisionTreeClassifier}

Parameters:

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

Overrides:

module:eclairjs/ml.PipelineStage#copy

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 165

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Param for features column name.

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 230

Returns:

Type: module:eclairjs/ml/param.Param

getFeaturesCol() → {string}

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 238

Returns:

Type: string

getLabelCol() → {string}

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 214

Returns:

Type: string

getPredictionCol() → {string}

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 263

Returns:

Type: string

getRawPredictionCol() → {string}

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 198

Returns:

Type: string

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

Param for label column name.

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 206

Returns:

Type: module:eclairjs/ml/param.Param

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

Param for prediction column name.

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 255

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/DecisionTreeClassifier.js, line 190

Returns:

Type: module:eclairjs/ml/param.Param

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

Parameters:

Name	Type	Description
`value`	boolean

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 125

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 135

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 246

Returns:

value

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 145

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 222

Returns:

value

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 86

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 76

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 115

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	float

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 105

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 95

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 271

Returns:

value

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

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

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/classification/DecisionTreeClassifier.js, line 155

Returns:

Type: module:eclairjs/ml/classification.DecisionTreeClassifier

supportedImpurities() → {Array.<string>}

Accessor for supported impurities: entropy, gini

Source:

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

Returns:

Type: Array.<string>

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

Check transform validity and derive the output schema from the input schema. Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks. * @param {module:eclairjs/sql/types.StructType} schema

Inherited From:

module:eclairjs/ml.PipelineStage#transformSchema

Source:

eclairjs/ml/PipelineStage.js, line 61

Returns:

Type: module:eclairjs/sql/types.StructType

uid() → {string}

An immutable unique ID for the object and its derivatives.

Source:

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

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/DecisionTreeClassifier.js, line 179

Returns:

Type: module:eclairjs/sql/types.StructType