Class: KMeansModel

eclairjs/ml/clustering.KMeansModel

Model fitted by KMeans.

Constructor

new KMeansModel()

Source:

Extends

Methods

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

Parameters:
Name Type Description
path string
Source:
Returns:
Type
module:eclairjs/mllib/clustering.KMeansModel

(static) read() → {MLReader}

Source:
Returns:
Type
MLReader

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

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

computeCost(dataset) → {Promise.<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:
Returns:
Type
Promise.<number>

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

Parameters:
Name Type Description
extra module:eclairjs/ml/param.ParamMap
Overrides:
Source:
Returns:
Type
module:eclairjs/mllib/clustering.KMeansModel

hasParent() → {Promise.<boolean>}

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

hasSummary() → {Promise.<boolean>}

Return true if there exists summary of model.
Source:
Returns:
Type
Promise.<boolean>

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

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

setFeaturesCol(value) → {type}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
type

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) → {type}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
type

summary() → {KMeansSummary}

Gets summary of model on training set. An exception is thrown if `trainingSummary == None`.
Source:
Returns:
Type
KMeansSummary

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

Parameters:
Name Type Description
dataset module:eclairjs/sql.Dataset
Overrides:
Source:
Returns:
Type
module:eclairjs/sql.Dataset

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

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

uid() → {Promise.<string>}

An immutable unique ID for the object and its derivatives.
Source:
Returns:
Type
Promise.<string>

write() → {MLWriter}

Source:
Returns:
Type
MLWriter