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[_]): Word2Vec.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): Word2Vec

   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

   Word2Vec → Estimator → 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 fit(dataset: Dataset[_]): Word2VecModel

    Fits a model to the input data.

    Fits a model to the input data.

    Definition Classes

    Word2Vec → Estimator

    Annotations

    @Since( "2.0.0" )

19.  def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[Word2VecModel]

    Fits multiple models to the input data with multiple sets of parameters.

    Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.

    dataset

    input dataset

    paramMaps

    An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted models, matching the input parameter maps

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

20.  def fit(dataset: Dataset[_], paramMap: ParamMap): Word2VecModel

    Fits a single model to the input data with provided parameter map.

    Fits a single model to the input data with provided parameter map.

    dataset

    input dataset

    paramMap

    Parameter map. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

21.  def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): Word2VecModel

    Fits a single model to the input data with optional parameters.

    Fits a single model to the input data with optional parameters.

    dataset

    input dataset

    firstParamPair

    the first param pair, overrides embedded params

    otherParamPairs

    other param pairs. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" ) @varargs()

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.  def getWindowSize: Int
    Definition Classes

    Word2VecBase

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

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

39.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

42.  final val inputCol: Param[String]

    Param for input column name.

    Param for input column name.

    Definition Classes

    HasInputCol

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

44.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

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

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes

    Params

46.  def isTraceEnabled(): Boolean

    Attributes

    protected

    Definition Classes

    Logging

47.  def log: Logger

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

54.  def logName: String

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

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

    Attributes

    protected

    Definition Classes

    Logging

59.  final val maxIter: IntParam

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

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

    Definition Classes

    HasMaxIter

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

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

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

    Definition Classes

    AnyRef

63.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

64.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

65.  final val numPartitions: IntParam

    Number of partitions for sentences of words.

    Number of partitions for sentences of words. Default: 1

    Definition Classes

    Word2VecBase

66.  final val outputCol: Param[String]

    Param for output column name.

    Param for output column name.

    Definition Classes

    HasOutputCol

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

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

69.  final val seed: LongParam

    Param for random seed.

    Param for random seed.

    Definition Classes

    HasSeed

70.  final def set(paramPair: ParamPair[_]): Word2Vec.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

71.  final def set(param: String, value: Any): Word2Vec.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

72.  final def set[T](param: Param[T], value: T): Word2Vec.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes

    Params

73.  final def setDefault(paramPairs: ParamPair[_]*): Word2Vec.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

74.  final def setDefault[T](param: Param[T], value: T): Word2Vec.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

75.  def setInputCol(value: String): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

76.  def setMaxIter(value: Int): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

77.  def setMaxSentenceLength(value: Int): Word2Vec.this.type
    Annotations

    @Since( "2.0.0" )

78.  def setMinCount(value: Int): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

79.  def setNumPartitions(value: Int): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

80.  def setOutputCol(value: String): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

81.  def setSeed(value: Long): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

82.  def setStepSize(value: Double): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

83.  def setVectorSize(value: Int): Word2Vec.this.type
    Annotations

    @Since( "1.4.0" )

84.  def setWindowSize(value: Int): Word2Vec.this.type
    Annotations

    @Since( "1.6.0" )

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

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

    Definition Classes

    AnyRef

87.  def toString(): String

    Definition Classes

    Identifiable → AnyRef → Any

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

    Word2Vec → PipelineStage

    Annotations

    @Since( "1.4.0" )

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

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

    Word2Vec → Identifiable

    Annotations

    @Since( "1.4.0" )

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

    Validate and transform the input schema.

    Validate and transform the input schema.

    Attributes

    protected

    Definition Classes

    Word2VecBase

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

93.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

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

97.  def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes

    DefaultParamsWritable → MLWritable