Class

com.salesforce.op.stages.impl.feature

OpTextPivotVectorizer

Related Doc: package feature

Permalink

class OpTextPivotVectorizer[T <: Text] extends OpOneHotVectorizer[T]

Converts a sequence of Text features into a vector keeping the top K most common occurrences of each feature (ie the final vector has length K * number of inputs). Plus an additional column for "other" values - which will capture values that do not make the cut or values not seen in training, and an additional column for empty values unless null tracking is disabled.

Linear Supertypes
OpOneHotVectorizer[T], OneHotFun, MinSupportParam, TrackNullsParam, SaveOthersParams, CleanTextFun, PivotParams, TextParams, VectorizerDefaults, SequenceEstimator[T, OPVector], OpPipelineStageN[T, OPVector], HasInN, OpPipelineStage[OPVector], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[SequenceModel[T, OPVector]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpTextPivotVectorizer
  2. OpOneHotVectorizer
  3. OneHotFun
  4. MinSupportParam
  5. TrackNullsParam
  6. SaveOthersParams
  7. CleanTextFun
  8. PivotParams
  9. TextParams
  10. VectorizerDefaults
  11. SequenceEstimator
  12. OpPipelineStageN
  13. HasInN
  14. OpPipelineStage
  15. OpPipelineStageBase
  16. MLWritable
  17. OpPipelineStageParams
  18. InputParams
  19. Estimator
  20. PipelineStage
  21. Logging
  22. Params
  23. Serializable
  24. Serializable
  25. Identifiable
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpTextPivotVectorizer(operationName: String = "pivotText", uid: String = UID[OpSetVectorizer[_]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T], ttiv: scala.reflect.api.JavaUniverse.TypeTag[Option[String]])

    Permalink

    operationName

    unique name of the operation this stage performs

    uid

    uid for instance

Type Members

  1. final type InputFeatures = Array[FeatureLike[T]]

    Permalink
    Definition Classes
    OpPipelineStageN → OpPipelineStage → InputParams
  2. final type OutputFeatures = FeatureLike[OPVector]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase

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. implicit def booleanToDouble(v: Boolean): Double

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

    Permalink
    Definition Classes
    OpPipelineStageN → InputParams
  8. final def checkSerializable: Try[Unit]

    Permalink
    Definition Classes
    SequenceEstimator → OpPipelineStageBase
  9. final val cleanText: BooleanParam

    Permalink
    Definition Classes
    TextParams
  10. def cleanTextFn(s: String, shouldClean: Boolean): String

    Permalink
    Definition Classes
    CleanTextFun
  11. final def clear(param: Param[_]): OpTextPivotVectorizer.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def convertToSeqOfMaps(dataset: Dataset[Seq[Option[String]]]): RDD[Seq[Map[String, Int]]]

    Permalink
    Attributes
    protected
    Definition Classes
    OpTextPivotVectorizerOpOneHotVectorizer
  14. final def copy(extra: ParamMap): OpTextPivotVectorizer.this.type

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. def explainParam(param: Param[_]): String

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def fit(dataset: Dataset[_]): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    SequenceEstimator → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SequenceModel[T, OPVector]]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. def fitFn(dataset: Dataset[Seq[T.Value]]): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    OpOneHotVectorizer → SequenceEstimator
  29. final def get[T](param: Param[T]): Option[T]

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

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

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

    Permalink
    Definition Classes
    InputParams
  33. final def getInputFeatures(): Array[OPFeature]

    Permalink
    Definition Classes
    InputParams
  34. final def getInputSchema(): StructType

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageN → OpPipelineStageBase
  38. final def getOutputFeatureName: String

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

    Permalink
    Definition Classes
    Params
  40. final def getTransientFeature(i: Int): Option[TransientFeature]

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

    Permalink
    Definition Classes
    InputParams
  42. def getUnseenName: String

    Permalink
    Definition Classes
    SaveOthersParams
  43. final def hasDefault[T](param: Param[T]): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  46. final def inN: Array[TransientFeature]

    Permalink
    Attributes
    protected
    Definition Classes
    HasInN
  47. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

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

    Permalink
    Definition Classes
    OpPipelineStageN → InputParams
  49. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def makeModel(topValues: Seq[Seq[String]], shouldCleanText: Boolean, shouldTrackNulls: Boolean, operationName: String, uid: String): OpTextPivotVectorizerModel[T]

    Permalink
    Attributes
    protected
    Definition Classes
    OpTextPivotVectorizerOpOneHotVectorizer
  66. def makeVectorColumnMetadata(shouldTrackNulls: Boolean, unseen: Option[String], topValues: Seq[Seq[String]], features: Array[TransientFeature]): Array[OpVectorColumnMetadata]

    Permalink
    Attributes
    protected
    Definition Classes
    OneHotFun
  67. def makeVectorMetadata(shouldTrackNulls: Boolean, unseen: Option[String], topValues: Seq[Seq[String]], outputName: String, features: Array[TransientFeature], stageName: String): OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    OneHotFun
  68. final val minSupport: IntParam

    Permalink
    Definition Classes
    MinSupportParam
  69. final def ne(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    VectorizerDefaults → OpPipelineStageBase
  74. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    SequenceEstimator → OpPipelineStageBase
  75. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase
  76. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStageN → OpPipelineStage
  77. def outputIsResponse: Boolean

    Permalink
    Definition Classes
    OpPipelineStage
  78. def outputVectorMeta: OpVectorMetadata

    Permalink

    Get the metadata describing the output vector

    Get the metadata describing the output vector

    This does not trigger onGetMetadata()

    returns

    Metadata of output vector

    Attributes
    protected
    Definition Classes
    VectorizerDefaults
  79. lazy val params: Array[Param[_]]

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

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  81. val seqIConvert: FeatureTypeSparkConverter[T]

    Permalink
    Definition Classes
    SequenceEstimator
  82. implicit val seqIEncoder: Encoder[Seq[T.Value]]

    Permalink
    Definition Classes
    SequenceEstimator
  83. final def set(paramPair: ParamPair[_]): OpTextPivotVectorizer.this.type

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

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

    Permalink
    Definition Classes
    Params
  86. def setCleanText(clean: Boolean): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    TextParams
  87. final def setDefault(paramPairs: ParamPair[_]*): OpTextPivotVectorizer.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  89. final def setInput(features: FeatureLike[T]*): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStageN
  90. final def setInput(features: InputFeatures): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStageBase
  91. final def setInputFeatures[S <: OPFeature](features: Array[S]): OpTextPivotVectorizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    InputParams
  92. final def setMetadata(m: Metadata): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  93. def setMinSupport(min: Int): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    MinSupportParam
  94. def setOutputFeatureName(name: String): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  95. def setTopK(numberToKeep: Int): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    PivotParams
  96. def setTrackNulls(v: Boolean): OpTextPivotVectorizer.this.type

    Permalink

    Option to keep track of values that were missing

    Option to keep track of values that were missing

    Definition Classes
    TrackNullsParam
  97. def setUnseenName(unseenNameIn: String): OpTextPivotVectorizer.this.type

    Permalink
    Definition Classes
    SaveOthersParams
  98. final def stageName: String

    Permalink
    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 val topK: IntParam

    Permalink
    Definition Classes
    PivotParams
  102. final val trackNulls: BooleanParam

    Permalink
    Definition Classes
    TrackNullsParam
  103. final def transformSchema(schema: StructType): StructType

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

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

    Permalink
    Definition Classes
    SequenceEstimator
  106. implicit val ttiv: scala.reflect.api.JavaUniverse.TypeTag[T.Value]

    Permalink
    Definition Classes
    SequenceEstimator
  107. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[OPVector]

    Permalink
    Definition Classes
    SequenceEstimator → OpPipelineStageN
  108. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink
    Definition Classes
    SequenceEstimator → OpPipelineStageN
  109. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    SequenceEstimator → Identifiable
  110. final val unseenName: Param[String]

    Permalink
    Definition Classes
    SaveOthersParams
  111. def vectorMetadataFromInputFeatures: OpVectorMetadata

    Permalink

    Compute the output vector metadata only from the input features.

    Compute the output vector metadata only from the input features. Vectorizers use this to derive the full vector, including pivot columns or indicator features.

    returns

    Vector metadata from input features

    Attributes
    protected
    Definition Classes
    VectorizerDefaults
  112. def vectorMetadataWithNullIndicators: OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    VectorizerDefaults
  113. def vectorOutputName: String

    Permalink

    Get the name of the output vector

    Get the name of the output vector

    returns

    Output vector name as a string

    Attributes
    protected
    Definition Classes
    VectorizerDefaults
  114. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from OpOneHotVectorizer[T]

Inherited from OneHotFun

Inherited from MinSupportParam

Inherited from TrackNullsParam

Inherited from SaveOthersParams

Inherited from CleanTextFun

Inherited from PivotParams

Inherited from TextParams

Inherited from VectorizerDefaults

Inherited from SequenceEstimator[T, OPVector]

Inherited from OpPipelineStageN[T, OPVector]

Inherited from HasInN

Inherited from OpPipelineStage[OPVector]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[SequenceModel[T, OPVector]]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped