Class: PredictionModel

eclairjs/ml. PredictionModel

Abstraction for a model for prediction tasks (regression and classification). E.g., VectorUDT for vector features. parameter to specify the concrete type for the corresponding model.

Constructor

new PredictionModel()

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.
Source:
Returns:
Type
module:eclairjs/ml/param.Param

getFeaturesCol() → {string}

Source:
Returns:
Type
string

getLabelCol() → {string}

Source:
Returns:
Type
string

getPredictionCol() → {string}

Source:
Returns:
Type
string

hasParent() → {boolean}

Inherited From:
Source:
Returns:
Type
boolean

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

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

numFeatures() → {integer}

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.
Source:
Returns:
Type
module:eclairjs/ml/param.Param

setFeaturesCol(value) → {object}

Parameters:
Name Type Description
value string
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
Source:
Returns:
Type
object

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
Overrides:
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
Overrides:
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
Source:
Returns:
Type
module:eclairjs/sql/types.StructType