Word2VecModel
Related Docs:
object Word2VecModel
| package feature
An alias for getOrDefault().
An alias for getOrDefault().
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
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().
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.
the target instance, which should work with the same set of default Params as this source instance
extra params to be copied to the target's paramMap
the target instance with param values copied
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.
Explains a param.
Explains a param.
input param, must belong to this instance.
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Explains all params of this instance.
Explains all params of this instance. See explainParam().
extractParamMap with no extra values.
extractParamMap with no extra values.
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.
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.
a dataframe with columns "word" and "similarity" of the word and the cosine similarities between the synonyms and the given word vector.
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.
a dataframe with columns "word" and "similarity" of the word and the cosine similarities between the synonyms and the given word vector.
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.
an array of the words and the cosine similarities between the synonyms given word vector.
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.
an array of the words and the cosine similarities between the synonyms given word vector.
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Gets the default value of a parameter.
Gets the default value of a parameter.
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.
Gets a param by its name.
Gets a param by its name.
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.
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Indicates whether this Model has a corresponding parent.
Param for input column name.
Param for input column name.
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Param for maximum number of iterations (>= 0).
Param for maximum number of iterations (>= 0).
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
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
Number of partitions for sentences of words.
Number of partitions for sentences of words. Default: 1
Param for output column name.
Param for output column name.
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.
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
The parent estimator that produced this model.
The parent estimator that produced this model.
For ensembles' component Models, this value can be null.
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).
Param for random seed.
Param for random seed.
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
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.
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.
Sets a default value for a param.
Sets a default value for a param.
param to set the default value. Make sure that this param is initialized before this method gets called.
the default value
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
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).
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.
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
input dataset
additional parameters, overwrite embedded params
transformed dataset
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
input dataset
the first param pair, overwrite embedded params
other param pairs, overwrite embedded params
transformed dataset
:: DeveloperApi ::
:: DeveloperApi ::
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.
:: DeveloperApi ::
:: DeveloperApi ::
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.
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
Validate and transform the input schema.
Validate and transform the input schema.
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
The window size (context words from [-window, window]).
The window size (context words from [-window, window]). Default: 5
Returns an MLWriter instance for this ML instance.
Returns an MLWriter instance for this ML instance.
A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.
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.
Model fitted by Word2Vec.