Class: GBTClassificationModel

eclairjs/ml/classification. GBTClassificationModel

Gradient-Boosted Trees (GBTs) model for classification. It supports binary labels, as well as both continuous and categorical features. Note: Multiclass labels are not currently supported.

Constructor

new GBTClassificationModel(uid, trees, treeWeights)

Parameters:
Name Type Description
uid string
trees Array.<DecisionTreeRegressionModel> Decision trees in the ensemble.
treeWeights Array.<float> Weights for the decision trees in the ensemble.
Source:

Extends

Methods

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

Parameters:
Name Type Description
path string
Source:
Returns:
Type
module:eclairjs/ml/classification.GBTClassificationModel

(static) read() → {module:eclairjs/ml/util.MLReader}

Source:
Returns:
Type
module:eclairjs/ml/util.MLReader

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

Parameters:
Name Type Description
extra module:eclairjs/ml/param.ParamMap
Overrides:
Source:
Returns:
Type
module:eclairjs/ml/classification.GBTClassificationModel

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

Param for features column name.
Inherited From:
Source:
Returns:
Type
module:eclairjs/ml/param.Param

getFeaturesCol() → {string}

Inherited From:
Source:
Returns:
Type
string

getLabelCol() → {string}

Inherited From:
Source:
Returns:
Type
string

getPredictionCol() → {string}

Inherited From:
Source:
Returns:
Type
string

hasParent() → {boolean}

Inherited From:
Source:
Returns:
Type
boolean

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

Param for label column name.
Inherited From:
Source:
Returns:
Type
module:eclairjs/ml/param.Param

numFeatures() → {integer}

Inherited From:
Source:
Returns:
Type
integer

parent() → {module:eclairjs/ml.Estimator}

Inherited From:
Source:
Returns:
Type
module:eclairjs/ml.Estimator

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

Param for prediction column name.
Inherited From:
Source:
Returns:
Type
module:eclairjs/ml/param.Param

setFeaturesCol(value) → {object}

Parameters:
Name Type Description
value string
Inherited From:
Source:
Returns:
Type
object

setParent(parent) → {object}

Sets the parent of this model.
Parameters:
Name Type Description
parent module:eclairjs/ml.Estimator
Inherited From:
Source:
Returns:
Type
object

setPredictionCol(value) → {object}

Parameters:
Name Type Description
value string
Inherited From:
Source:
Returns:
Type
object

toDebugString() → {string}

Source:
Returns:
Type
string

toString() → {string}

Source:
Returns:
Type
string

transform(dataset) → {module:eclairjs/sql.Dataset}

Transforms dataset by reading from featuresCol, calling [[predict()]], and storing the predictions as a new column predictionCol.
Parameters:
Name Type Description
dataset module:eclairjs/sql.Dataset input dataset
Inherited From:
Source:
Returns:
transformed dataset with [[predictionCol]] of type [[Double]]
Type
module:eclairjs/sql.Dataset

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

Parameters:
Name Type Description
schema module:eclairjs/sql/types.StructType
Inherited From:
Source:
Returns:
Type
module:eclairjs/sql/types.StructType

trees() → {Array.<DecisionTreeRegressionModel>}

Source:
Returns:
Type
Array.<DecisionTreeRegressionModel>

treeWeights() → {Array.<float>}

Source:
Returns:
Type
Array.<float>

uid() → {string}

An immutable unique ID for the object and its derivatives.
Source:
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
Inherited From:
Source:
Returns:
Type
module:eclairjs/sql/types.StructType

write() → {module:eclairjs/ml/util.MLWriter}

Source:
Returns:
Type
module:eclairjs/ml/util.MLWriter