Class: KMeans

eclairjs/ml/clustering. KMeans

K-means clustering with support for k-means|| initialization proposed by Bahmani et al.

Constructor

new KMeans(uidopt)

Parameters:

Name	Type	Attributes	Description
`uid`	string	<optional>

Source:

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

See:

Bahmani et al., Scalable k-means++.

Extends

module:eclairjs/ml.Estimator

Methods

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

Parameters:

Name	Type	Description
`path`	string

Source:

eclairjs/ml/clustering/KMeans.js, line 183

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

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

Parameters:

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

Overrides:

module:eclairjs/ml.Estimator#copy

Source:

eclairjs/ml/clustering/KMeans.js, line 66

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

extractParamMap() → {module:eclairjs/ml/param.ParamMap}

Inherited From:

module:eclairjs/ml.Estimator#extractParamMap

Source:

eclairjs/ml/Estimator.js, line 80

Returns:

Type: module:eclairjs/ml/param.ParamMap

fit(dataset) → {module:eclairjs/mllib/clustering.KMeansModel}

Parameters:

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

Overrides:

module:eclairjs/ml.Estimator#fit

Source:

eclairjs/ml/clustering/KMeans.js, line 157

Returns:

Type: module:eclairjs/mllib/clustering.KMeansModel

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

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/clustering/KMeans.js, line 77

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

setInitMode(value) → {module:eclairjs/mllib/clustering.KMeans}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/clustering/KMeans.js, line 107

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

setInitSteps(value) → {module:eclairjs/mllib/clustering.KMeans}

Parameters:

Name	Type	Description
`value`	number

Source:

eclairjs/ml/clustering/KMeans.js, line 117

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

setK(value) → {module:eclairjs/mllib/clustering.KMeans}

Parameters:

Name	Type	Description
`value`	number

Source:

eclairjs/ml/clustering/KMeans.js, line 97

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

setMaxIter(value) → {module:eclairjs/mllib/clustering.KMeans}

Parameters:

Name	Type	Description
`value`	number

Source:

eclairjs/ml/clustering/KMeans.js, line 127

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

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

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/clustering/KMeans.js, line 87

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

setSeed(value) → {module:eclairjs/mllib/clustering.KMeans}

Parameters:

Name	Type	Description
`value`	number

Source:

eclairjs/ml/clustering/KMeans.js, line 147

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

setTol(value) → {module:eclairjs/mllib/clustering.KMeans}

Parameters:

Name	Type	Description
`value`	number

Source:

eclairjs/ml/clustering/KMeans.js, line 137

Returns:

Type: module:eclairjs/mllib/clustering.KMeans

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

Parameters:

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

Overrides:

module:eclairjs/ml.Estimator#transformSchema

Source:

eclairjs/ml/clustering/KMeans.js, line 168

Returns:

Type: module:eclairjs/sql/types.StructType

uid() → {string}

An immutable unique ID for the object and its derivatives.

Source:

eclairjs/ml/clustering/KMeans.js, line 58

Returns:

Type: string