JSDoc: Class: KMeansModel

Class: KMeansModel

Constructor

new KMeansModel()

Source:

eclairjs/ml/clustering/KMeansModel.js, line 34

Extends

module:eclairjs/ml.Model

Methods

(static) load(path) → {module:eclairjs/mllib/clustering.KMeansModel}

Parameters:

Name	Type	Description
`path`	string

Source:

eclairjs/ml/clustering/KMeansModel.js, line 187

Returns:

Type: module:eclairjs/mllib/clustering.KMeansModel

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

Source:

eclairjs/ml/clustering/KMeansModel.js, line 172

Returns:

Type: module:eclairjs/ml/util.MLReader

clusterCenters() → {Array.<module:eclairjs/mllib/linalg.Vector>}

Source:

eclairjs/ml/clustering/KMeansModel.js, line 111

Returns:

Type: Array.<module:eclairjs/mllib/linalg.Vector>

computeCost(dataset) → {number}

Return the K-means cost (sum of squared distances of points to their nearest center) for this model on the given data.

Parameters:

Name	Type	Description
`dataset`	module:eclairjs/sql.Dataset

Source:

eclairjs/ml/clustering/KMeansModel.js, line 123

Returns:

Type: number

copy(extra) → {module:eclairjs/mllib/clustering.KMeansModel}

Parameters:

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

Overrides:

module:eclairjs/ml.Model#copy

Source:

eclairjs/ml/clustering/KMeansModel.js, line 57

Returns:

Type: module:eclairjs/mllib/clustering.KMeansModel

hasParent() → {boolean}

Inherited From:

module:eclairjs/ml.Model#hasParent

Source:

eclairjs/ml/Model.js, line 69

Returns:

Type: boolean

hasSummary() → {boolean}

Return true if there exists summary of model.

Source:

eclairjs/ml/clustering/KMeansModel.js, line 129

Returns:

Type: boolean

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

Inherited From:

module:eclairjs/ml.Model#parent

Source:

eclairjs/ml/Model.js, line 60

Returns:

Type: module:eclairjs/ml.Estimator

setFeaturesCol(value) → {module:eclairjs/mllib/clustering.KMeansModel}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/clustering/KMeansModel.js, line 64

Returns:

Type: module:eclairjs/mllib/clustering.KMeansModel

setParent(parent) → {object}

Sets the parent of this model.

Parameters:

Name	Type	Description
`parent`	module:eclairjs/ml.Estimator

Inherited From:

module:eclairjs/ml.Model#setParent

Source:

eclairjs/ml/Model.js, line 50

Returns:

Type: object

setPredictionCol(value) → {module:eclairjs/mllib/clustering.KMeansModel}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/clustering/KMeansModel.js, line 75

Returns:

Type: module:eclairjs/mllib/clustering.KMeansModel

summary() → {module:eclairjs/ml/clustering.KMeansSummary}

Gets summary of model on training set. An exception is thrown if `trainingSummary == None`.

Source:

eclairjs/ml/clustering/KMeansModel.js, line 139

Returns:

Type: module:eclairjs/ml/clustering.KMeansSummary

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

Parameters:

Name	Type	Description
`dataset`	module:eclairjs/sql.Dataset

Overrides:

module:eclairjs/ml.Model#transform

Source:

eclairjs/ml/clustering/KMeansModel.js, line 90

Returns:

Type: module:eclairjs/sql.Dataset

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

Parameters:

Name	Type	Description
`schema`	module:eclairjs/sql/types.StructType

Overrides:

module:eclairjs/ml.Model#transformSchema

Source:

eclairjs/ml/clustering/KMeansModel.js, line 101

Returns:

Type: module:eclairjs/sql/types.StructType

uid() → {string}

An immutable unique ID for the object and its derivatives.

Source:

eclairjs/ml/clustering/KMeansModel.js, line 49

Returns:

Type: string

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

Source:

eclairjs/ml/clustering/KMeansModel.js, line 154

Returns:

Type: module:eclairjs/ml/util.MLWriter