JSDoc: Class: Word2Vec

new Word2Vec(uidopt)

Word2Vec trains a model of `Map(String, Vector)`, i.e. transforms a word into a code for further natural language processing or machine learning process.

Parameters:

Name	Type	Attributes	Description
`uid`	string	<optional>

Source:

eclairjs/ml/feature/Word2Vec.js, line 33

Extends

module:eclairjs/ml.Estimator

Methods

(static) load(path) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`path`	string

Source:

eclairjs/ml/feature/Word2Vec.js, line 337

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

copy(extra) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

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

Overrides:

module:eclairjs/ml.Estimator#copy

Source:

eclairjs/ml/feature/Word2Vec.js, line 174

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

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/ml/feature.Word2VecModel}

Parameters:

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

Overrides:

module:eclairjs/ml.Estimator#fit

Source:

eclairjs/ml/feature/Word2Vec.js, line 154

Returns:

Type: module:eclairjs/ml/feature.Word2VecModel

getInputCol() → {string}

Source:

eclairjs/ml/feature/Word2Vec.js, line 265

Returns:

Type: string

getMaxIter() → {integer}

Source:

eclairjs/ml/feature/Word2Vec.js, line 296

Returns:

Type: integer

getMinCount() → {integer}

Source:

eclairjs/ml/feature/Word2Vec.js, line 239

Returns:

Type: integer

getNumPartitions() → {integer}

Source:

eclairjs/ml/feature/Word2Vec.js, line 223

Returns:

Type: integer

getOutputCol() → {string}

Source:

eclairjs/ml/feature/Word2Vec.js, line 280

Returns:

Type: string

getSeed() → {integer}

Source:

eclairjs/ml/feature/Word2Vec.js, line 328

Returns:

Type: integer

getStepSize() → {float}

Source:

eclairjs/ml/feature/Word2Vec.js, line 312

Returns:

Type: float

getVectorSize() → {integer}

Source:

eclairjs/ml/feature/Word2Vec.js, line 191

Returns:

Type: integer

getWindowSize() → {integer}

Source:

eclairjs/ml/feature/Word2Vec.js, line 207

Returns:

Type: integer

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

Source:

eclairjs/ml/feature/Word2Vec.js, line 257

Returns:

Type: module:eclairjs/ml/param.Param

maxIter() → {module:eclairjs/ml/param.IntParam}

Param for maximum number of iterations (>= 0).

Source:

eclairjs/ml/feature/Word2Vec.js, line 288

Returns:

Type: module:eclairjs/ml/param.IntParam

minCount() → {module:eclairjs/ml/param.IntParam}

The minimum number of times a token must appear to be included in the word2vec model's vocabulary. Default: 5

Source:

eclairjs/ml/feature/Word2Vec.js, line 231

Returns:

Type: module:eclairjs/ml/param.IntParam

numPartitions() → {module:eclairjs/ml/param.IntParam}

Number of partitions for sentences of words. Default: 1

Source:

eclairjs/ml/feature/Word2Vec.js, line 215

Returns:

Type: module:eclairjs/ml/param.IntParam

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

Source:

eclairjs/ml/feature/Word2Vec.js, line 272

Returns:

Type: module:eclairjs/ml/param.Param

seed() → {module:eclairjs/ml/param.LongParam}

Param for random seed.

Source:

eclairjs/ml/feature/Word2Vec.js, line 320

Returns:

Type: module:eclairjs/ml/param.LongParam

setInputCol(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/feature/Word2Vec.js, line 64

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setMaxIter(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/feature/Word2Vec.js, line 118

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setMaxSentenceLength(value) → {module:eclairjs/mllib/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	number

Source:

eclairjs/ml/feature/Word2Vec.js, line 144

Returns:

Type: module:eclairjs/mllib/feature.Word2Vec

setMinCount(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/feature/Word2Vec.js, line 136

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setNumPartitions(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/feature/Word2Vec.js, line 109

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setOutputCol(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	string

Source:

eclairjs/ml/feature/Word2Vec.js, line 73

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setSeed(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/feature/Word2Vec.js, line 127

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setStepSize(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	float

Source:

eclairjs/ml/feature/Word2Vec.js, line 100

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setVectorSize(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/feature/Word2Vec.js, line 82

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

setWindowSize(value) → {module:eclairjs/ml/feature.Word2Vec}

Parameters:

Name	Type	Description
`value`	integer

Source:

eclairjs/ml/feature/Word2Vec.js, line 91

Returns:

Type: module:eclairjs/ml/feature.Word2Vec

stepSize() → {module:eclairjs/ml/param.DoubleParam}

Param for Step size to be used for each iteration of optimization

Source:

eclairjs/ml/feature/Word2Vec.js, line 304

Returns:

Type: module:eclairjs/ml/param.DoubleParam

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/feature/Word2Vec.js, line 164

Returns:

Type: module:eclairjs/sql/types.StructType

uid() → {string}

An immutable unique ID for the object and its derivatives.

Source:

eclairjs/ml/feature/Word2Vec.js, line 56

Returns:

Type: string

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

Validates and transforms the input schema.

Parameters:

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

Source:

eclairjs/ml/feature/Word2Vec.js, line 248

Returns:

Type: module:eclairjs/sql/types.StructType

vectorSize() → {module:eclairjs/ml/param.IntParam}

The dimension of the code that you want to transform from words. Default: 100

Source:

eclairjs/ml/feature/Word2Vec.js, line 183

Returns:

Type: module:eclairjs/ml/param.IntParam

windowSize() → {module:eclairjs/ml/param.IntParam}

The window size (context words from [-window, window]) default 5.

Source:

eclairjs/ml/feature/Word2Vec.js, line 199

Returns:

Type: module:eclairjs/ml/param.IntParam