Class

com.salesforce.op.stages.impl.feature

TextMapNullEstimator

Related Doc: package feature

Permalink

class TextMapNullEstimator[T <: OPMap[String]] extends SequenceEstimator[T, OPVector] with MapVectorizerFuns[String, T]

Creates null indicator columns for a sequence of input TextMap features, originally for use as a separate stage in null tracking for hashed text features (easier to do outside the hashing vectorizer since we can make a null indicator column for each input feature without having to add lots of complex logic in the hashing vectorizer to deal with metadata for shared vs. separate hash spaces.

Linear Supertypes
MapVectorizerFuns[String, T], CleanTextMapFun, CleanTextFun, MapPivotParams, VectorizerDefaults, SequenceEstimator[T, OPVector], OpPipelineStageN[T, OPVector], HasOut[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. TextMapNullEstimator
  2. MapVectorizerFuns
  3. CleanTextMapFun
  4. CleanTextFun
  5. MapPivotParams
  6. VectorizerDefaults
  7. SequenceEstimator
  8. OpPipelineStageN
  9. HasOut
  10. HasInN
  11. OpPipelineStage
  12. OpPipelineStageBase
  13. MLWritable
  14. OpPipelineStageParams
  15. InputParams
  16. Estimator
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TextMapNullEstimator(uid: String = UID[TextMapNullEstimator[_]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T])

    Permalink

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. 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
    Definition Classes
    OpPipelineStageN → InputParams

  9. final def checkSerializable: Try[Unit]

    Permalink
    Definition Classes
    SequenceEstimator → OpPipelineStageBase

  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[_]): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    Params

  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  15. final def copy(extra: ParamMap): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStageBase → Params

  16. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  17. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  20. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  21. def explainParams(): String

    Permalink
    Definition Classes
    Params

  22. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  23. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    MapPivotParams

  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  26. def fit(dataset: Dataset[_]): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    SequenceEstimator → Estimator

  27. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SequenceModel[T, OPVector]]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  28. def fit(dataset: Dataset[_], paramMap: ParamMap): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  29. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()

  30. def fitFn(dataset: Dataset[Seq[Map[String, String]]]): SequenceModel[T, OPVector]

    Permalink
    Definition Classes
    TextMapNullEstimator → SequenceEstimator

  31. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  33. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  34. final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

    Permalink
    Definition Classes
    InputParams

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

    Permalink
    Definition Classes
    InputParams

  36. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams

  37. def getKeyValues(in: Dataset[Seq[Map[String, String]]], shouldCleanKeys: Boolean, shouldCleanValues: Boolean): Seq[Seq[String]]

    Permalink
    Attributes
    protected
    Definition Classes
    MapVectorizerFuns

  38. final def getMetadata(): Metadata

    Permalink
    Definition Classes
    OpPipelineStageParams

  39. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  40. def getOutput(): FeatureLike[OPVector]

    Permalink
    Definition Classes
    HasOut → OpPipelineStageBase

  41. final def getOutputFeatureName: String

    Permalink
    Definition Classes
    OpPipelineStage

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

    Permalink
    Definition Classes
    Params

  43. final def getTransientFeature(i: Int): Option[TransientFeature]

    Permalink
    Definition Classes
    InputParams

  44. final def getTransientFeatures(): Array[TransientFeature]

    Permalink
    Definition Classes
    InputParams

  45. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  46. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  47. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  48. final def inN: Array[TransientFeature]

    Permalink
    Attributes
    protected
    Definition Classes
    HasInN

  49. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. final def inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStageN → InputParams

  52. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Params

  55. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  56. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  58. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  60. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  62. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  63. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  65. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  67. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  68. def makeVectorMetaWithNullIndicators(allKeys: Seq[Seq[String]]): OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    MapVectorizerFuns

  69. def makeVectorMetadata(allKeys: Seq[Seq[String]]): OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    MapVectorizerFuns

  70. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  71. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  72. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  73. def onGetMetadata(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    OpPipelineStageParams

  74. def onSetInput(): Unit

    Permalink
    Definition Classes
    VectorizerDefaults → InputParams

  75. val operationName: String

    Permalink
    Definition Classes
    SequenceEstimator → OpPipelineStageBase

  76. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase

  77. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStageN → OpPipelineStage

  78. def outputIsResponse: Boolean

    Permalink
    Definition Classes
    OpPipelineStage

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

  80. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  81. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  82. val seqIConvert: FeatureTypeSparkConverter[T]

    Permalink
    Definition Classes
    SequenceEstimator

  83. implicit val seqIEncoder: Encoder[Seq[T.Value]]

    Permalink
    Definition Classes
    SequenceEstimator

  84. final def set(paramPair: ParamPair[_]): TextMapNullEstimator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  85. final def set(param: String, value: Any): TextMapNullEstimator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  86. final def set[T](param: Param[T], value: T): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    Params

  87. final def setBlackListKeys(keys: Array[String]): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    MapPivotParams

  88. def setCleanKeys(clean: Boolean): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    MapPivotParams

  89. final def setDefault(paramPairs: ParamPair[_]*): TextMapNullEstimator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  90. final def setDefault[T](param: Param[T], value: T): TextMapNullEstimator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  91. final def setInput(features: FeatureLike[T]*): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStageN

  92. final def setInput(features: InputFeatures): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStageBase

  93. final def setInputFeatures[S <: OPFeature](features: Array[S]): TextMapNullEstimator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    InputParams

  94. final def setMetadata(m: Metadata): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams

  95. def setOutputFeatureName(name: String): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStage

  96. final def setWhiteListKeys(keys: Array[String]): TextMapNullEstimator.this.type

    Permalink
    Definition Classes
    MapPivotParams

  97. val shouldCleanValues: Boolean

    Permalink
    Attributes
    protected

  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 def transformSchema(schema: StructType): StructType

    Permalink
    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[T]

    Permalink
    Definition Classes
    SequenceEstimator

  104. implicit val ttiv: scala.reflect.api.JavaUniverse.TypeTag[T.Value]

    Permalink
    Definition Classes
    SequenceEstimator

  105. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[OPVector]

    Permalink
    Definition Classes
    SequenceEstimator → HasOut

  106. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink
    Definition Classes
    SequenceEstimator → HasOut

  107. val uid: String

    Permalink
    Definition Classes
    SequenceEstimator → Identifiable

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

  109. def vectorMetadataWithNullIndicators: OpVectorMetadata

    Permalink
    Attributes
    protected
    Definition Classes
    VectorizerDefaults

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

  111. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  113. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  114. final val whiteListKeys: StringArrayParam

    Permalink
    Definition Classes
    MapPivotParams

  115. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from MapVectorizerFuns[String, T]

Inherited from CleanTextMapFun

Inherited from CleanTextFun

Inherited from MapPivotParams

Inherited from VectorizerDefaults

Inherited from SequenceEstimator[T, OPVector]

Inherited from OpPipelineStageN[T, OPVector]

Inherited from HasOut[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