Class

com.salesforce.op.stages.impl.feature

OPMapVectorizer

Related Doc: package feature

Permalink

abstract class OPMapVectorizer[A, T <: OPMap[A]] extends SequenceEstimator[T, OPVector] with MapVectorizerFuns[Double, RealMap] with NumericMapDefaultParam with TrackNullsParam

Base class for vectorizing OPMap[A] features. Individual vectorizers for different feature types need to implement the getFillByKey function (which calculates any fill values that differ by key - means, modes, etc.) and the makeModel function (which specifies which type of model will be returned).

A

value type for underlying map

T

input feature type to vectorize into an OPVector

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OPMapVectorizer
  2. TrackNullsParam
  3. NumericMapDefaultParam
  4. MapVectorizerFuns
  5. CleanTextMapFun
  6. CleanTextFun
  7. MapPivotParams
  8. VectorizerDefaults
  9. SequenceEstimator
  10. OpPipelineStageN
  11. HasInN
  12. OpPipelineStage
  13. OpPipelineStageBase
  14. MLWritable
  15. OpPipelineStageParams
  16. InputParams
  17. Estimator
  18. PipelineStage
  19. Logging
  20. Params
  21. Serializable
  22. Serializable
  23. Identifiable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OPMapVectorizer(uid: String = UID[OPMapVectorizer[A, T]], operationName: String, convertFn: (Map[String, A]) ⇒ Map[String, Double])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T], ttiv: scala.reflect.api.JavaUniverse.TypeTag[Map[String, A]])

    Permalink

    uid

    uid for instance

    operationName

    unique name of the operation this stage performs

    convertFn

    maps input type into a Map[String, Double] on the way to conversion to OPVector

    tti

    type tag for input

    ttiv

    type tag for input value

Type Members

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

    Permalink

    Input Features type

    Input Features type

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

    Permalink
    Definition Classes
    OpPipelineStageOpPipelineStageBase

Abstract Value Members

  1. abstract def makeModel(args: OPMapVectorizerModelArgs, operationName: String, uid: String): OPMapVectorizerModel[A, T]

    Permalink

Concrete 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 val blackListKeys: StringArrayParam

    Permalink
    Definition Classes
    MapPivotParams
  7. implicit def booleanToDouble(v: Boolean): Double

    Permalink
    Definition Classes
    VectorizerDefaults
  8. 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
    OpPipelineStageNInputParams
  9. final def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

    Definition Classes
    SequenceEstimatorOpPipelineStageBase
  10. final val cleanKeys: BooleanParam

    Permalink
    Definition Classes
    MapPivotParams
  11. def cleanMap[V](m: Map[String, V], shouldCleanKey: Boolean, shouldCleanValue: Boolean): Map[String, V]

    Permalink
    Definition Classes
    CleanTextMapFun
  12. def cleanTextFn(s: String, shouldClean: Boolean): String

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. val convertFn: (Map[String, A]) ⇒ Map[String, Double]

    Permalink

    maps input type into a Map[String, Double] on the way to conversion to OPVector

  16. final def copy(extra: ParamMap): OPMapVectorizer.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
  17. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  19. final val defaultValue: DoubleParam

    Permalink
    Definition Classes
    NumericMapDefaultParam
  20. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  26. def fillByKey(dataset: Dataset[Seq[Map[String, A]]]): Seq[Map[String, Double]]

    Permalink
  27. def filterKeys[V](m: Map[String, V], shouldCleanKey: Boolean, shouldCleanValue: Boolean): Map[String, V]

    Permalink
    Attributes
    protected
    Definition Classes
    MapPivotParams
  28. def finalize(): Unit

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

    Permalink

    Spark operation on dataset to produce Dataset for constructor fit function and then turn output function into a Model

    Spark operation on dataset to produce Dataset for constructor fit function and then turn output function into a Model

    dataset

    input data for this stage

    returns

    a fitted model that will perform the transformation specified by the function defined in constructor fit

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

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

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

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

    Permalink

    Function that fits the sequence model

    Function that fits the sequence model

    Definition Classes
    OPMapVectorizerSequenceEstimator
  34. final def get[T](param: Param[T]): Option[T]

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

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

    Permalink
    Definition Classes
    Params
  37. 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

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

  39. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams
  40. def getKeyValues(in: Dataset[Seq[Map[String, Double]]], shouldCleanKeys: Boolean, shouldCleanValues: Boolean): Seq[Seq[String]]

    Permalink
    Attributes
    protected
    Definition Classes
    MapVectorizerFuns
  41. final def getMetadata(): Metadata

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

    Permalink
    Definition Classes
    Params
  43. 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
    OpPipelineStageNOpPipelineStageBase
  44. 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
  45. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  46. 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
  47. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasInN
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. 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
    OpPipelineStageNInputParams
  55. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def makeVectorMetaWithNullIndicators(allKeys: Seq[Seq[String]]): OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    MapVectorizerFuns
  72. def makeVectorMetadata(allKeys: Seq[Seq[String]]): OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    MapVectorizerFuns
  73. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Definition Classes
    VectorizerDefaultsOpPipelineStageBase
  78. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    SequenceEstimatorOpPipelineStageBase
  79. 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
  80. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStageNOpPipelineStage
  81. 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
  82. 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
  83. lazy val params: Array[Param[_]]

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  90. final def setBlackListKeys(keys: Array[String]): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    MapPivotParams
  91. def setCleanKeys(clean: Boolean): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    MapPivotParams
  92. final def setDefault(paramPairs: ParamPair[_]*): OPMapVectorizer.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  94. def setDefaultValue(value: Double): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    NumericMapDefaultParam
  95. def setFillWithConstant(value: Double): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    NumericMapDefaultParam
  96. final def setInput(features: FeatureLike[T]*): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStageN
  97. final def setInput(features: InputFeatures): OPMapVectorizer.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
  98. final def setInputFeatures[S <: OPFeature](features: Array[S]): OPMapVectorizer.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
  99. final def setMetadata(m: Metadata): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  100. def setOutputFeatureName(name: String): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  101. def setTrackNulls(v: Boolean): OPMapVectorizer.this.type

    Permalink

    Option to keep track of values that were missing

    Option to keep track of values that were missing

    Definition Classes
    TrackNullsParam
  102. final def setWhiteListKeys(keys: Array[String]): OPMapVectorizer.this.type

    Permalink
    Definition Classes
    MapPivotParams
  103. val shouldCleanValues: Boolean

    Permalink
    Attributes
    protected
  104. 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
  105. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  107. final val trackNulls: BooleanParam

    Permalink
    Definition Classes
    TrackNullsParam
  108. 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
  109. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    type tag for input

    type tag for input

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

    Permalink

    type tag for input value

    type tag for input value

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

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    SequenceEstimatorOpPipelineStageN
  113. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    SequenceEstimatorOpPipelineStageN
  114. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    SequenceEstimator → Identifiable
  115. 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
  116. def vectorMetadataWithNullIndicators: OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    VectorizerDefaults
  117. 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
  118. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. final val whiteListKeys: StringArrayParam

    Permalink
    Definition Classes
    MapPivotParams
  122. final val withConstant: BooleanParam

    Permalink
    Definition Classes
    NumericMapDefaultParam
  123. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from TrackNullsParam

Inherited from NumericMapDefaultParam

Inherited from MapVectorizerFuns[Double, RealMap]

Inherited from CleanTextMapFun

Inherited from CleanTextFun

Inherited from MapPivotParams

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