Class: ClassificationModel

eclairjs/ml/classification.ClassificationModel

Model produced by a module:eclairjs/ml/classification.Classifier. Classes are indexed {0, 1, ..., numClasses - 1}.

Constructor

new ClassificationModel()

Source:

Extends

Methods

copy(extra) → {object}

Parameters:
Name Type Description
extra module:eclairjs/ml/param.ParamMap
Inherited From:
Source:
Returns:
Type
object

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() → {Promise.<string>}

Inherited From:
Source:
Returns:
Type
Promise.<string>

getPredictionCol() → {Promise.<string>}

Inherited From:
Source:
Returns:
Type
Promise.<string>

hasParent() → {Promise.<boolean>}

Indicates whether this Model has a corresponding parent.
Inherited From:
Source:
Returns:
Type
Promise.<boolean>

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

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

numClasses() → {Promise.<number>}

Number of classes (values which the label can take).
Source:
Returns:
Type
Promise.<number>

numFeatures() → {Promise.<number>}

Returns the number of features the model was trained on. If unknown, returns -1
Inherited From:
Source:
Returns:
Type
Promise.<number>

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

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

Parameters:
Name Type Description
value string
Source:
Returns:
Type
module:eclairjs/ml/classification.ClassificationModel

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

Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters: - predicted labels as [[predictionCol]] of type Double - raw predictions (confidences) as [[rawPredictionCol]] of type Vector.
Parameters:
Name Type Description
dataset module:eclairjs/sql.Dataset input dataset
Overrides:
Source:
Returns:
transformed dataset
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

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