Word2VecModel

Companion object Word2VecModel

class Word2VecModel extends Model[Word2VecModel] with Word2VecBase with MLWritable

Model fitted by Word2Vec.

Annotations: @Since("1.4.0")
Source: Word2Vec.scala

Linear Supertypes

MLWritable, Word2VecBase, HasSeed, HasStepSize, HasMaxIter, HasOutputCol, HasInputCol, Model[Word2VecModel], Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

Word2VecModel
MLWritable
Word2VecBase
HasSeed
HasStepSize
HasMaxIter
HasOutputCol
HasInputCol
Model
Transformer
PipelineStage
Logging
Params
Serializable
Identifiable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

implicit class LogStringContext extends AnyRef
Definition Classes
Logging

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T
An alias for getOrDefault().
An alias for getOrDefault().
Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def clear(param: Param[_]): Word2VecModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Definition Classes
Params
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
def copy(extra: ParamMap): Word2VecModel
Creates a copy of this instance with the same UID and some extra params.
Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().
Definition Classes
Word2VecModel → Model → Transformer → PipelineStage → Params
Annotations
@Since("1.4.1")
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied
Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
Attributes
protected
Definition Classes
Params
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Definition Classes
Params
def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See explainParam().
Definition Classes
Params
final def extractParamMap(): ParamMap
extractParamMap with no extra values.
extractParamMap with no extra values.
Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Definition Classes
Params
def findSynonyms(vec: Vector, num: Int): DataFrame
Find "num" number of words whose vector representation is most similar to the supplied vector.
Find "num" number of words whose vector representation is most similar to the supplied vector. If the supplied vector is the vector representation of a word in the model's vocabulary, that word will be in the results.
returns
a dataframe with columns "word" and "similarity" of the word and the cosine similarities between the synonyms and the given word vector.
Annotations
@Since("2.0.0")
def findSynonyms(word: String, num: Int): DataFrame
Find "num" number of words closest in similarity to the given word, not including the word itself.
Find "num" number of words closest in similarity to the given word, not including the word itself.
returns
a dataframe with columns "word" and "similarity" of the word and the cosine similarities between the synonyms and the given word.
Annotations
@Since("1.5.0")
def findSynonymsArray(word: String, num: Int): Array[(String, Double)]
Find "num" number of words closest in similarity to the given word, not including the word itself.
Find "num" number of words closest in similarity to the given word, not including the word itself.
returns
an array of the words and the cosine similarities between the synonyms given word vector.
Annotations
@Since("2.2.0")
def findSynonymsArray(vec: Vector, num: Int): Array[(String, Double)]
Find "num" number of words whose vector representation is most similar to the supplied vector.
Find "num" number of words whose vector representation is most similar to the supplied vector. If the supplied vector is the vector representation of a word in the model's vocabulary, that word will be in the results.
returns
an array of the words and the cosine similarities between the synonyms given word vector.
Annotations
@Since("2.2.0")
final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Definition Classes
Params
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
Definition Classes
Params
final def getInputCol: String
Definition Classes
HasInputCol
final def getMaxIter: Int
Definition Classes
HasMaxIter
def getMaxSentenceLength: Int
Definition Classes
Word2VecBase
def getMinCount: Int
Definition Classes
Word2VecBase
def getNumPartitions: Int
Definition Classes
Word2VecBase
final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
Definition Classes
Params
final def getOutputCol: String
Definition Classes
HasOutputCol
def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
Definition Classes
Params
final def getSeed: Long
Definition Classes
HasSeed
final def getStepSize: Double
Definition Classes
HasStepSize
def getVectorSize: Int
Definition Classes
Word2VecBase
lazy val getVectors: DataFrame
Returns a dataframe with two fields, "word" and "vector", with "word" being a String and and the vector the DenseVector that it is mapped to.
Returns a dataframe with two fields, "word" and "vector", with "word" being a String and and the vector the DenseVector that it is mapped to.
Annotations
@Since("1.5.0") @transient()
def getWindowSize: Int
Definition Classes
Word2VecBase
final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Definition Classes
Params
def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Definition Classes
Params
def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
Indicates whether this Model has a corresponding parent.
Definition Classes
Model
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit
Attributes
protected
Definition Classes
Logging
final val inputCol: Param[String]
Param for input column name.
Param for input column name.
Definition Classes
HasInputCol
final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Definition Classes
Params
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Definition Classes
Params
def isTraceEnabled(): Boolean
Attributes
protected
Definition Classes
Logging
def log: Logger
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logName: String
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
final val maxIter: IntParam
Param for maximum number of iterations (>= 0).
Param for maximum number of iterations (>= 0).
Definition Classes
HasMaxIter
final val maxSentenceLength: IntParam
Sets the maximum length (in words) of each sentence in the input data.
Sets the maximum length (in words) of each sentence in the input data. Any sentence longer than this threshold will be divided into chunks of up to maxSentenceLength size. Default: 1000
Definition Classes
Word2VecBase
final val minCount: IntParam
The minimum number of times a token must appear to be included in the word2vec model's vocabulary.
The minimum number of times a token must appear to be included in the word2vec model's vocabulary. Default: 5
Definition Classes
Word2VecBase
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final val numPartitions: IntParam
Number of partitions for sentences of words.
Number of partitions for sentences of words. Default: 1
Definition Classes
Word2VecBase
final val outputCol: Param[String]
Param for output column name.
Param for output column name.
Definition Classes
HasOutputCol
lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
var parent: Estimator[Word2VecModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
Definition Classes
Model
Note
For ensembles' component Models, this value can be null.
def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of write.save(path).
Saves this ML instance to the input path, a shortcut of write.save(path).
Definition Classes
MLWritable
Annotations
@Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")
final val seed: LongParam
Param for random seed.
Param for random seed.
Definition Classes
HasSeed
final def set(paramPair: ParamPair[_]): Word2VecModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): Word2VecModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): Word2VecModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): Word2VecModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): Word2VecModel.this.type
Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value
Attributes
protected[ml]
Definition Classes
Params
def setInputCol(value: String): Word2VecModel.this.type
Annotations
@Since("1.4.0")
def setOutputCol(value: String): Word2VecModel.this.type
Annotations
@Since("1.4.0")
def setParent(parent: Estimator[Word2VecModel]): Word2VecModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Definition Classes
Model
val stepSize: DoubleParam
Param for Step size to be used for each iteration of optimization (> 0).
Param for Step size to be used for each iteration of optimization (> 0).
Definition Classes
HasStepSize
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
Word2VecModel → Identifiable → AnyRef → Any
Annotations
@Since("3.0.0")
def transform(dataset: Dataset[_]): DataFrame
Transform a sentence column to a vector column to represent the whole sentence.
Transform a sentence column to a vector column to represent the whole sentence. The transform is performed by averaging all word vectors it contains.
Definition Classes
Word2VecModel → Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
dataset
input dataset
paramMap
additional parameters, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
dataset
input dataset
firstParamPair
the first param pair, overwrite embedded params
otherParamPairs
other param pairs, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0") @varargs()
def transformSchema(schema: StructType): StructType
Check transform validity and derive the output schema from the input schema.
Check transform validity and derive the output schema from the input schema.
We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().
Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.
Definition Classes
Word2VecModel → PipelineStage
Annotations
@Since("1.4.0")
def transformSchema(schema: StructType, logging: Boolean): StructType
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
val uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
Definition Classes
Word2VecModel → Identifiable
Annotations
@Since("1.4.0")
def validateAndTransformSchema(schema: StructType): StructType
Validate and transform the input schema.
Validate and transform the input schema.
Attributes
protected
Definition Classes
Word2VecBase
final val vectorSize: IntParam
The dimension of the code that you want to transform from words.
The dimension of the code that you want to transform from words. Default: 100
Definition Classes
Word2VecBase
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final val windowSize: IntParam
The window size (context words from [-window, window]).
The window size (context words from [-window, window]). Default: 5
Definition Classes
Word2VecBase
def withLogContext(context: HashMap[String, String])(body: => Unit): Unit
Attributes
protected
Definition Classes
Logging
def write: MLWriter
Returns an MLWriter instance for this ML instance.
Returns an MLWriter instance for this ML instance.
Definition Classes
Word2VecModel → MLWritable
Annotations
@Since("1.6.0")

Inherited from MLWritable

Value Members

def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of write.save(path).
Saves this ML instance to the input path, a shortcut of write.save(path).
Definition Classes
MLWritable
Annotations
@Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")

Inherited from Word2VecBase

Value Members

def getMaxSentenceLength: Int
Definition Classes
Word2VecBase
def getMinCount: Int
Definition Classes
Word2VecBase
def getNumPartitions: Int
Definition Classes
Word2VecBase
def getVectorSize: Int
Definition Classes
Word2VecBase
def getWindowSize: Int
Definition Classes
Word2VecBase
final val maxSentenceLength: IntParam
Sets the maximum length (in words) of each sentence in the input data.
Sets the maximum length (in words) of each sentence in the input data. Any sentence longer than this threshold will be divided into chunks of up to maxSentenceLength size. Default: 1000
Definition Classes
Word2VecBase
final val minCount: IntParam
The minimum number of times a token must appear to be included in the word2vec model's vocabulary.
The minimum number of times a token must appear to be included in the word2vec model's vocabulary. Default: 5
Definition Classes
Word2VecBase
final val numPartitions: IntParam
Number of partitions for sentences of words.
Number of partitions for sentences of words. Default: 1
Definition Classes
Word2VecBase
def validateAndTransformSchema(schema: StructType): StructType
Validate and transform the input schema.
Validate and transform the input schema.
Attributes
protected
Definition Classes
Word2VecBase
final val vectorSize: IntParam
The dimension of the code that you want to transform from words.
The dimension of the code that you want to transform from words. Default: 100
Definition Classes
Word2VecBase
final val windowSize: IntParam
The window size (context words from [-window, window]).
The window size (context words from [-window, window]). Default: 5
Definition Classes
Word2VecBase

Inherited from HasSeed

Value Members

final def getSeed: Long
Definition Classes
HasSeed
final val seed: LongParam
Param for random seed.
Param for random seed.
Definition Classes
HasSeed

Inherited from HasStepSize

Value Members

final def getStepSize: Double
Definition Classes
HasStepSize
val stepSize: DoubleParam
Param for Step size to be used for each iteration of optimization (> 0).
Param for Step size to be used for each iteration of optimization (> 0).
Definition Classes
HasStepSize

Inherited from HasMaxIter

Value Members

final def getMaxIter: Int
Definition Classes
HasMaxIter
final val maxIter: IntParam
Param for maximum number of iterations (>= 0).
Param for maximum number of iterations (>= 0).
Definition Classes
HasMaxIter

Inherited from HasOutputCol

Value Members

final def getOutputCol: String
Definition Classes
HasOutputCol
final val outputCol: Param[String]
Param for output column name.
Param for output column name.
Definition Classes
HasOutputCol

Inherited from HasInputCol

Value Members

final def getInputCol: String
Definition Classes
HasInputCol
final val inputCol: Param[String]
Param for input column name.
Param for input column name.
Definition Classes
HasInputCol

Inherited from Model[Word2VecModel]

Value Members

def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
Indicates whether this Model has a corresponding parent.
Definition Classes
Model
var parent: Estimator[Word2VecModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
Definition Classes
Model
Note
For ensembles' component Models, this value can be null.
def setParent(parent: Estimator[Word2VecModel]): Word2VecModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Definition Classes
Model

Inherited from Transformer

Value Members

def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
dataset
input dataset
paramMap
additional parameters, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
dataset
input dataset
firstParamPair
the first param pair, overwrite embedded params
otherParamPairs
other param pairs, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0") @varargs()

Inherited from PipelineStage

Value Members

def transformSchema(schema: StructType, logging: Boolean): StructType
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()

Inherited from Logging

Value Members

def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit
Attributes
protected
Definition Classes
Logging
def isTraceEnabled(): Boolean
Attributes
protected
Definition Classes
Logging
def log: Logger
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logName: String
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def withLogContext(context: HashMap[String, String])(body: => Unit): Unit
Attributes
protected
Definition Classes
Logging

Inherited from Params

Value Members

final def $[T](param: Param[T]): T
An alias for getOrDefault().
An alias for getOrDefault().
Attributes
protected
Definition Classes
Params
final def clear(param: Param[_]): Word2VecModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Definition Classes
Params
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied
Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
Attributes
protected
Definition Classes
Params
def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Definition Classes
Params
def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See explainParam().
Definition Classes
Params
final def extractParamMap(): ParamMap
extractParamMap with no extra values.
extractParamMap with no extra values.
Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Definition Classes
Params
final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Definition Classes
Params
final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
Definition Classes
Params
final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
Definition Classes
Params
def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
Definition Classes
Params
final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Definition Classes
Params
def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Definition Classes
Params
final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Definition Classes
Params
final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Definition Classes
Params
lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
final def set(paramPair: ParamPair[_]): Word2VecModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): Word2VecModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): Word2VecModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): Word2VecModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): Word2VecModel.this.type
Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value
Attributes
protected[ml]
Definition Classes
Params

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

final val inputCol: Param[String]
Param for input column name.
Param for input column name.
Definition Classes
HasInputCol
final val maxIter: IntParam
Param for maximum number of iterations (>= 0).
Param for maximum number of iterations (>= 0).
Definition Classes
HasMaxIter
final val maxSentenceLength: IntParam
Sets the maximum length (in words) of each sentence in the input data.
Sets the maximum length (in words) of each sentence in the input data. Any sentence longer than this threshold will be divided into chunks of up to maxSentenceLength size. Default: 1000
Definition Classes
Word2VecBase
final val minCount: IntParam
The minimum number of times a token must appear to be included in the word2vec model's vocabulary.
The minimum number of times a token must appear to be included in the word2vec model's vocabulary. Default: 5
Definition Classes
Word2VecBase
final val numPartitions: IntParam
Number of partitions for sentences of words.
Number of partitions for sentences of words. Default: 1
Definition Classes
Word2VecBase
final val outputCol: Param[String]
Param for output column name.
Param for output column name.
Definition Classes
HasOutputCol
final val seed: LongParam
Param for random seed.
Param for random seed.
Definition Classes
HasSeed
val stepSize: DoubleParam
Param for Step size to be used for each iteration of optimization (> 0).
Param for Step size to be used for each iteration of optimization (> 0).
Definition Classes
HasStepSize
final val vectorSize: IntParam
The dimension of the code that you want to transform from words.
The dimension of the code that you want to transform from words. Default: 100
Definition Classes
Word2VecBase

Members

implicit class LogStringContext extends AnyRef
Definition Classes
Logging

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T
An alias for getOrDefault().
An alias for getOrDefault().
Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def clear(param: Param[_]): Word2VecModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Definition Classes
Params
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
def copy(extra: ParamMap): Word2VecModel
Creates a copy of this instance with the same UID and some extra params.
Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().
Definition Classes
Word2VecModel → Model → Transformer → PipelineStage → Params
Annotations
@Since("1.4.1")
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied
Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
Attributes
protected
Definition Classes
Params
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Definition Classes
Params
def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See explainParam().
Definition Classes
Params
final def extractParamMap(): ParamMap
extractParamMap with no extra values.
extractParamMap with no extra values.
Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Definition Classes
Params
def findSynonyms(vec: Vector, num: Int): DataFrame
Find "num" number of words whose vector representation is most similar to the supplied vector.
Find "num" number of words whose vector representation is most similar to the supplied vector. If the supplied vector is the vector representation of a word in the model's vocabulary, that word will be in the results.
returns
a dataframe with columns "word" and "similarity" of the word and the cosine similarities between the synonyms and the given word vector.
Annotations
@Since("2.0.0")
def findSynonyms(word: String, num: Int): DataFrame
Find "num" number of words closest in similarity to the given word, not including the word itself.
Find "num" number of words closest in similarity to the given word, not including the word itself.
returns
a dataframe with columns "word" and "similarity" of the word and the cosine similarities between the synonyms and the given word.
Annotations
@Since("1.5.0")
def findSynonymsArray(word: String, num: Int): Array[(String, Double)]
Find "num" number of words closest in similarity to the given word, not including the word itself.
Find "num" number of words closest in similarity to the given word, not including the word itself.
returns
an array of the words and the cosine similarities between the synonyms given word vector.
Annotations
@Since("2.2.0")
def findSynonymsArray(vec: Vector, num: Int): Array[(String, Double)]
Find "num" number of words whose vector representation is most similar to the supplied vector.
Find "num" number of words whose vector representation is most similar to the supplied vector. If the supplied vector is the vector representation of a word in the model's vocabulary, that word will be in the results.
returns
an array of the words and the cosine similarities between the synonyms given word vector.
Annotations
@Since("2.2.0")
final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Definition Classes
Params
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
Definition Classes
Params
final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
Definition Classes
Params
def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
Definition Classes
Params
lazy val getVectors: DataFrame
Returns a dataframe with two fields, "word" and "vector", with "word" being a String and and the vector the DenseVector that it is mapped to.
Returns a dataframe with two fields, "word" and "vector", with "word" being a String and and the vector the DenseVector that it is mapped to.
Annotations
@Since("1.5.0") @transient()
final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Definition Classes
Params
def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Definition Classes
Params
def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
Indicates whether this Model has a corresponding parent.
Definition Classes
Model
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit
Attributes
protected
Definition Classes
Logging
final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Definition Classes
Params
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Definition Classes
Params
def isTraceEnabled(): Boolean
Attributes
protected
Definition Classes
Logging
def log: Logger
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logName: String
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
var parent: Estimator[Word2VecModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
Definition Classes
Model
Note
For ensembles' component Models, this value can be null.
def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of write.save(path).
Saves this ML instance to the input path, a shortcut of write.save(path).
Definition Classes
MLWritable
Annotations
@Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")
final def set(paramPair: ParamPair[_]): Word2VecModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): Word2VecModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): Word2VecModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): Word2VecModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): Word2VecModel.this.type
Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value
Attributes
protected[ml]
Definition Classes
Params
def setParent(parent: Estimator[Word2VecModel]): Word2VecModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Definition Classes
Model
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
Word2VecModel → Identifiable → AnyRef → Any
Annotations
@Since("3.0.0")
def transform(dataset: Dataset[_]): DataFrame
Transform a sentence column to a vector column to represent the whole sentence.
Transform a sentence column to a vector column to represent the whole sentence. The transform is performed by averaging all word vectors it contains.
Definition Classes
Word2VecModel → Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
dataset
input dataset
paramMap
additional parameters, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
dataset
input dataset
firstParamPair
the first param pair, overwrite embedded params
otherParamPairs
other param pairs, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0") @varargs()
def transformSchema(schema: StructType): StructType
Check transform validity and derive the output schema from the input schema.
Check transform validity and derive the output schema from the input schema.
We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().
Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.
Definition Classes
Word2VecModel → PipelineStage
Annotations
@Since("1.4.0")
def transformSchema(schema: StructType, logging: Boolean): StructType
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
val uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
Definition Classes
Word2VecModel → Identifiable
Annotations
@Since("1.4.0")
def validateAndTransformSchema(schema: StructType): StructType
Validate and transform the input schema.
Validate and transform the input schema.
Attributes
protected
Definition Classes
Word2VecBase
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def withLogContext(context: HashMap[String, String])(body: => Unit): Unit
Attributes
protected
Definition Classes
Logging
def write: MLWriter
Returns an MLWriter instance for this ML instance.
Returns an MLWriter instance for this ML instance.
Definition Classes
Word2VecModel → MLWritable
Annotations
@Since("1.6.0")
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Parameter setters

def setInputCol(value: String): Word2VecModel.this.type
Annotations
@Since("1.4.0")
def setOutputCol(value: String): Word2VecModel.this.type
Annotations
@Since("1.4.0")

Parameter getters

final def getInputCol: String
Definition Classes
HasInputCol
final def getMaxIter: Int
Definition Classes
HasMaxIter
def getMaxSentenceLength: Int
Definition Classes
Word2VecBase
def getMinCount: Int
Definition Classes
Word2VecBase
def getNumPartitions: Int
Definition Classes
Word2VecBase
final def getOutputCol: String
Definition Classes
HasOutputCol
final def getSeed: Long
Definition Classes
HasSeed
final def getStepSize: Double
Definition Classes
HasStepSize
def getVectorSize: Int
Definition Classes
Word2VecBase

(expert-only) Parameters

A list of advanced, expert-only (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

final val windowSize: IntParam
The window size (context words from [-window, window]).
The window size (context words from [-window, window]). Default: 5
Definition Classes
Word2VecBase

(expert-only) Parameter getters

def getWindowSize: Int
Definition Classes
Word2VecBase

Packages

Feature transformers

Word2VecModel

Companion object Word2VecModel

class Word2VecModel extends Model[Word2VecModel] with Word2VecBase with MLWritable

Type Members

Value Members

Deprecated Value Members

Inherited from MLWritable

Value Members

Inherited from Word2VecBase

Value Members

Inherited from HasSeed

Value Members

Inherited from HasStepSize

Value Members

Inherited from HasMaxIter

Value Members

Inherited from HasOutputCol

Value Members

Inherited from HasInputCol

Value Members

Inherited from Model[Word2VecModel]

Value Members

Inherited from Transformer

Value Members

Inherited from PipelineStage

Value Members

Inherited from Logging

Value Members

Inherited from Params

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Parameters

Members

Parameter setters

Parameter getters

(expert-only) Parameters

(expert-only) Parameter getters

Word2VecModel