org.apache.spark.ml.feature

Class Word2Vec

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<Word2VecModel>

org.apache.spark.ml.feature.Word2Vec

All Implemented Interfaces:

java.io.Serializable, Logging, Params, DefaultParamsWritable, Identifiable, MLWritable

public final class Word2Vec
extends Estimator<Word2VecModel>
implements DefaultParamsWritable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Word2Vec()
Word2Vec(String uid)

Method Summary

Modifier and Type	Method and Description
static Params	clear(Param<?> param)
Word2Vec	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static String	explainParam(Param<?> param)
static String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
Word2VecModel	fit(Dataset<?> dataset) Fits a model to the input data.
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static String	getInputCol()
static int	getMaxIter()
static int	getMaxSentenceLength()
int	getMaxSentenceLength()
static int	getMinCount()
int	getMinCount()
static int	getNumPartitions()
int	getNumPartitions()
static <T> T	getOrDefault(Param<T> param)
static String	getOutputCol()
static Param<Object>	getParam(String paramName)
static long	getSeed()
static double	getStepSize()
static int	getVectorSize()
int	getVectorSize()
static int	getWindowSize()
int	getWindowSize()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static Param<String>	inputCol()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static Word2Vec	load(String path)
static IntParam	maxIter()
static IntParam	maxSentenceLength()
IntParam	maxSentenceLength() Sets the maximum length (in words) of each sentence in the input data.
static IntParam	minCount()
IntParam	minCount() The minimum number of times a token must appear to be included in the word2vec model's vocabulary.
static IntParam	numPartitions()
IntParam	numPartitions() Number of partitions for sentences of words.
static Param<String>	outputCol()
static Param<?>[]	params()
static void	save(String path)
static LongParam	seed()
static <T> Params	set(Param<T> param, T value)
Word2Vec	setInputCol(String value)
Word2Vec	setMaxIter(int value)
Word2Vec	setMaxSentenceLength(int value)
Word2Vec	setMinCount(int value)
Word2Vec	setNumPartitions(int value)
Word2Vec	setOutputCol(String value)
Word2Vec	setSeed(long value)
Word2Vec	setStepSize(double value)
Word2Vec	setVectorSize(int value)
Word2Vec	setWindowSize(int value)
static DoubleParam	stepSize()
static String	toString()
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema) Validate and transform the input schema.
static IntParam	vectorSize()
IntParam	vectorSize() The dimension of the code that you want to transform from words.
static IntParam	windowSize()
IntParam	windowSize() The window size (context words from [-window, window]).
static MLWriter	write()

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.shared.HasInputCol

getInputCol, inputCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasOutputCol

getOutputCol, outputCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasMaxIter

getMaxIter, maxIter

Methods inherited from interface org.apache.spark.ml.param.shared.HasStepSize

getStepSize, stepSize

Methods inherited from interface org.apache.spark.ml.param.shared.HasSeed

getSeed, seed

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Methods inherited from interface org.apache.spark.ml.util.DefaultParamsWritable

write

Methods inherited from interface org.apache.spark.ml.util.MLWritable

save

Methods inherited from interface org.apache.spark.internal.Logging

initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

Word2Vec

public Word2Vec(String uid)

Word2Vec

public Word2Vec()

Method Detail

load

public static Word2Vec load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

explainParam

public static String explainParam(Param<?> param)

explainParams

public static String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(String paramName)

getParam

public static Param<Object> getParam(String paramName)

set

public static final <T> Params set(Param<T> param,
                                   T value)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

inputCol

public static final Param<String> inputCol()

getInputCol

public static final String getInputCol()

outputCol

public static final Param<String> outputCol()

getOutputCol

public static final String getOutputCol()

maxIter

public static final IntParam maxIter()

getMaxIter

public static final int getMaxIter()

stepSize

public static DoubleParam stepSize()

getStepSize

public static final double getStepSize()

seed

public static final LongParam seed()

getSeed

public static final long getSeed()

vectorSize

public static final IntParam vectorSize()

getVectorSize

public static int getVectorSize()

windowSize

public static final IntParam windowSize()

getWindowSize

public static int getWindowSize()

numPartitions

public static final IntParam numPartitions()

getNumPartitions

public static int getNumPartitions()

minCount

public static final IntParam minCount()

getMinCount

public static int getMinCount()

maxSentenceLength

public static final IntParam maxSentenceLength()

getMaxSentenceLength

public static int getMaxSentenceLength()

save

public static void save(String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

setInputCol

public Word2Vec setInputCol(String value)

setOutputCol

public Word2Vec setOutputCol(String value)

setVectorSize

public Word2Vec setVectorSize(int value)

setWindowSize

public Word2Vec setWindowSize(int value)

setStepSize

public Word2Vec setStepSize(double value)

setNumPartitions

public Word2Vec setNumPartitions(int value)

setMaxIter

public Word2Vec setMaxIter(int value)

setSeed

public Word2Vec setSeed(long value)

setMinCount

public Word2Vec setMinCount(int value)

setMaxSentenceLength

public Word2Vec setMaxSentenceLength(int value)

fit

public Word2VecModel fit(Dataset<?> dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<Word2VecModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: 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.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public Word2Vec copy(ParamMap extra)

Description copied from interface: 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().

Specified by:

copy in interface Params

Specified by:

copy in class Estimator<Word2VecModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

vectorSize

public IntParam vectorSize()

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

Returns:

(undocumented)

getVectorSize

public int getVectorSize()

windowSize

public IntParam windowSize()

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

Returns:

(undocumented)

getWindowSize

public int getWindowSize()

numPartitions

public IntParam numPartitions()

Number of partitions for sentences of words. Default: 1

Returns:

(undocumented)

getNumPartitions

public int getNumPartitions()

minCount

public IntParam minCount()

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

Returns:

(undocumented)

getMinCount

public int getMinCount()

maxSentenceLength

public IntParam maxSentenceLength()

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

Returns:

(undocumented)

getMaxSentenceLength

public int getMaxSentenceLength()

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema)

Validate and transform the input schema.

Parameters:

schema - (undocumented)

Returns:

(undocumented)