Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def $[T](param: Param[T]): T

   An alias for getOrDefault().

   An alias for getOrDefault().

   Attributes

   protected

   Definition Classes

   Params

4.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

5.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

6.  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

7.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

8.  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" )

9.  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

10.  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

11.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

12.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

13.  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

14.  def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes

    Params

15.  final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes

    Params

16.  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

17.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18.  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" )

19.  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" )

20.  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" )

21.  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" )

22.  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

23.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

24.  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

25.  final def getInputCol: String
    Definition Classes

    HasInputCol

26.  final def getMaxIter: Int
    Definition Classes

    HasMaxIter

27.  def getMaxSentenceLength: Int
    Definition Classes

    Word2VecBase

28.  def getMinCount: Int
    Definition Classes

    Word2VecBase

29.  def getNumPartitions: Int
    Definition Classes

    Word2VecBase

30.  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

31.  final def getOutputCol: String
    Definition Classes

    HasOutputCol

32.  def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes

    Params

33.  final def getSeed: Long
    Definition Classes

    HasSeed

34.  final def getStepSize: Double
    Definition Classes

    HasStepSize

35.  def getVectorSize: Int
    Definition Classes

    Word2VecBase

36.  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()

37.  def getWindowSize: Int
    Definition Classes

    Word2VecBase

38.  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

39.  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

40.  def hasParent: Boolean

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes

    Model

41.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

42.  def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

    Attributes

    protected

    Definition Classes

    Logging

43.  def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes

    protected

    Definition Classes

    Logging

44.  final val inputCol: Param[String]

    Param for input column name.

    Param for input column name.

    Definition Classes

    HasInputCol

45.  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

46.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

47.  final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes

    Params

48.  def isTraceEnabled(): Boolean

    Attributes

    protected

    Definition Classes

    Logging

49.  def log: Logger

    Attributes

    protected

    Definition Classes

    Logging

50.  def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

51.  def logDebug(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

52.  def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

53.  def logError(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

54.  def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

55.  def logInfo(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

56.  def logName: String

    Attributes

    protected

    Definition Classes

    Logging

57.  def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

58.  def logTrace(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

59.  def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

60.  def logWarning(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

61.  final val maxIter: IntParam

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

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

    Definition Classes

    HasMaxIter

62.  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

63.  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

64.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

65.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

66.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

67.  final val numPartitions: IntParam

    Number of partitions for sentences of words.

    Number of partitions for sentences of words. Default: 1

    Definition Classes

    Word2VecBase

68.  final val outputCol: Param[String]

    Param for output column name.

    Param for output column name.

    Definition Classes

    HasOutputCol

69.  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.

70.  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.

71.  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( ... )

72.  final val seed: LongParam

    Param for random seed.

    Param for random seed.

    Definition Classes

    HasSeed

73.  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

74.  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

75.  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

76.  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

77.  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

    Definition Classes

    Params

78.  def setInputCol(value: String): Word2VecModel.this.type
    Annotations

    @Since( "1.4.0" )

79.  def setOutputCol(value: String): Word2VecModel.this.type
    Annotations

    @Since( "1.4.0" )

80.  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

81.  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

82.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

83.  def toString(): String

    Definition Classes

    Identifiable → AnyRef → Any

84.  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" )

85.  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" )

86.  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()

87.  def transformSchema(schema: StructType): StructType

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

    Definition Classes

    Word2VecModel → PipelineStage

    Annotations

    @Since( "1.4.0" )

88.  def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Attributes

    protected

    Definition Classes

    PipelineStage

    Annotations

    @DeveloperApi()

89.  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" )

90.  def validateAndTransformSchema(schema: StructType): StructType

    Validate and transform the input schema.

    Validate and transform the input schema.

    Attributes

    protected

    Definition Classes

    Word2VecBase

91.  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

92.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

93.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

94.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

95.  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

96.  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" )