Class

com.salesforce.op.stages.impl.feature

OpWord2Vec

Related Doc: package feature

Permalink

class OpWord2Vec extends OpEstimatorWrapper[TextList, OPVector, Word2Vec, Word2VecModel]

Wrapper around spark ml word2vec for use with OP pipelines

Linear Supertypes
OpEstimatorWrapper[TextList, OPVector, Word2Vec, Word2VecModel], SwUnaryEstimator[TextList, OPVector, Word2VecModel, Word2Vec], SparkWrapperParams[Word2Vec], OpPipelineStage1[TextList, OPVector], HasIn1, OpPipelineStage[OPVector], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[SwUnaryModel[TextList, OPVector, Word2VecModel]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpWord2Vec
  2. OpEstimatorWrapper
  3. SwUnaryEstimator
  4. SparkWrapperParams
  5. OpPipelineStage1
  6. HasIn1
  7. OpPipelineStage
  8. OpPipelineStageBase
  9. MLWritable
  10. OpPipelineStageParams
  11. InputParams
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpWord2Vec(uid: String = UID[OpWord2Vec])

    Permalink

Type Members

  1. final type InputFeatures = FeatureLike[TextList]

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage1OpPipelineStageInputParams
  2. final type OutputFeatures = FeatureLike[OPVector]

    Permalink
    Definition Classes
    OpPipelineStageOpPipelineStageBase

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final def checkInputLength(features: Array[_]): Boolean

    Permalink

    Checks the input length

    Checks the input length

    features

    input features

    returns

    true is input size as expected, false otherwise

    Definition Classes
    OpPipelineStage1InputParams
  7. def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

    Definition Classes
    OpPipelineStageBase
  8. final def clear(param: Param[_]): OpWord2Vec.this.type

    Permalink
    Definition Classes
    Params
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def copy(extra: ParamMap): OpWord2Vec.this.type

    Permalink

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    Note: that the convention in spark is to have the uid be a constructor argument, so that copies will share a uid with the original (developers should follow this convention).

    extra

    new parameters want to add to instance

    returns

    a new instance with the same uid

    Definition Classes
    OpPipelineStageBase → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. val estimator: Word2Vec

    Permalink

    the estimator to wrap

    the estimator to wrap

    Definition Classes
    OpEstimatorWrapper
  16. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  17. def explainParams(): String

    Permalink
    Definition Classes
    Params
  18. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  19. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def fit(dataset: Dataset[_]): SwUnaryModel[TextList, OPVector, Word2VecModel]

    Permalink
    Definition Classes
    SwUnaryEstimator → Estimator
  22. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SwUnaryModel[TextList, OPVector, Word2VecModel]]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], paramMap: ParamMap): SwUnaryModel[TextList, OPVector, Word2VecModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SwUnaryModel[TextList, OPVector, Word2VecModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  25. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  28. final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

    Permalink

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  29. final def getInputFeatures(): Array[OPFeature]

    Permalink

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  30. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams
  31. final def getMetadata(): Metadata

    Permalink
    Definition Classes
    OpPipelineStageParams
  32. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  33. def getOutput(): FeatureLike[OPVector]

    Permalink

    Output features that will be created by this stage

    Output features that will be created by this stage

    returns

    feature of type OutputFeatures

    Definition Classes
    OpPipelineStage1OpPipelineStageBase
  34. final def getOutputFeatureName: String

    Permalink

    Name of output feature (i.e.

    Name of output feature (i.e. column created by this stage)

    Definition Classes
    OpPipelineStage
  35. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  36. def getSparkMlStage(): Option[Word2Vec]

    Permalink

    Method to access the spark stage being wrapped

    Method to access the spark stage being wrapped

    returns

    Option of spark ml stage

    Definition Classes
    SparkWrapperParams
  37. def getStageSavePath(): Option[String]

    Permalink

    Gets a save path for wrapped spark stage

    Gets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  38. final def getTransientFeature(i: Int): Option[TransientFeature]

    Permalink

    Gets an input feature at index i

    Gets an input feature at index i

    i

    input index

    returns

    maybe an input feature

    Definition Classes
    InputParams
  39. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

    Definition Classes
    InputParams
  40. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  41. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  42. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  43. final def in1: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  44. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  46. final def inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink

    Function to convert InputFeatures to an Array of FeatureLike

    Function to convert InputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStage1InputParams
  47. val inputParamName: String

    Permalink

    name of spark parameter that sets the second input column

    name of spark parameter that sets the second input column

    Definition Classes
    SwUnaryEstimator
  48. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  49. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  50. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  51. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  65. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  66. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  67. def onGetMetadata(): Unit

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

    Attributes
    protected
    Definition Classes
    OpPipelineStageParams
  68. def onSetInput(): Unit

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  69. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    SwUnaryEstimatorOpPipelineStageBase
  70. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink

    Function to convert OutputFeatures to an Array of FeatureLike

    Function to convert OutputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStageOpPipelineStageBase
  71. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage1OpPipelineStage
  72. def outputIsResponse: Boolean

    Permalink

    Should output feature be a response? Yes, if any of the input features are.

    Should output feature be a response? Yes, if any of the input features are.

    returns

    true if the the output feature should be a response

    Definition Classes
    OpPipelineStage
  73. val outputParamName: String

    Permalink

    name of spark parameter that sets the first output column

    name of spark parameter that sets the first output column

    Definition Classes
    SwUnaryEstimator
  74. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  75. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  76. final def set(paramPair: ParamPair[_]): OpWord2Vec.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  77. final def set(param: String, value: Any): OpWord2Vec.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  78. final def set[T](param: Param[T], value: T): OpWord2Vec.this.type

    Permalink
    Definition Classes
    Params
  79. final def setDefault(paramPairs: ParamPair[_]*): OpWord2Vec.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  80. final def setDefault[T](param: Param[T], value: T): OpWord2Vec.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  81. final def setInput(features: InputFeatures): OpWord2Vec.this.type

    Permalink

    Input features that will be used by the stage

    Input features that will be used by the stage

    returns

    feature of type InputFeatures

    Definition Classes
    OpPipelineStageBase
  82. final def setInputFeatures[S <: OPFeature](features: Array[S]): OpWord2Vec.this.type

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected
    Definition Classes
    InputParams
  83. def setMaxIter(value: Int): OpWord2Vec.this.type

    Permalink

    Number of iterations Default is 1

  84. def setMaxSentenceLength(value: Int): OpWord2Vec.this.type

    Permalink

    Maximum length (in words) of each sentence in the input data.

    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

  85. final def setMetadata(m: Metadata): OpWord2Vec.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  86. def setMinCount(value: Int): OpWord2Vec.this.type

    Permalink

    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

  87. def setNumPartitions(value: Int): OpWord2Vec.this.type

    Permalink

    Number of partitions for sentences of words Default: 1

  88. def setOutputFeatureName(name: String): OpWord2Vec.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  89. def setSeed(value: Long): OpWord2Vec.this.type

    Permalink
  90. def setSparkMlStage(stage: Option[Word2Vec]): OpWord2Vec.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    SparkWrapperParams
  91. def setStageSavePath(path: String): OpWord2Vec.this.type

    Permalink

    Sets a save path for wrapped spark stage

    Sets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  92. def setStepSize(value: Double): OpWord2Vec.this.type

    Permalink

    Initial learning rate Default: 0.025

  93. def setVectorSize(value: Int): OpWord2Vec.this.type

    Permalink

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

  94. def setWindowSize(value: Int): OpWord2Vec.this.type

    Permalink

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

  95. final val sparkInputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  96. final val sparkMlStage: SparkStageParam[Word2Vec]

    Permalink
    Definition Classes
    SparkWrapperParams
  97. final val sparkOutputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  98. final def stageName: String

    Permalink

    Stage unique name consisting of the stage operation name and uid

    Stage unique name consisting of the stage operation name and uid

    returns

    stage name

    Definition Classes
    OpPipelineStageBase
  99. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  100. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  101. final def transformSchema(schema: StructType): StructType

    Permalink

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    schema

    schema of the input data frame

    returns

    a new schema with the output features added

    Definition Classes
    OpPipelineStageBase
  102. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  103. implicit val tti: scala.reflect.api.JavaUniverse.TypeTag[TextList]

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    SwUnaryEstimator
  104. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[OPVector]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    SwUnaryEstimatorOpPipelineStage1
  105. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    SwUnaryEstimatorOpPipelineStage1
  106. val uid: String

    Permalink

    stage uid

    stage uid

    Definition Classes
    SwUnaryEstimator → Identifiable
  107. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from OpEstimatorWrapper[TextList, OPVector, Word2Vec, Word2VecModel]

Inherited from SwUnaryEstimator[TextList, OPVector, Word2VecModel, Word2Vec]

Inherited from SparkWrapperParams[Word2Vec]

Inherited from HasIn1

Inherited from OpPipelineStage[OPVector]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[SwUnaryModel[TextList, OPVector, Word2VecModel]]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

expertParam

param

setParam

Ungrouped