Class

com.salesforce.op.stages.impl.feature

TextLenTransformer

Related Doc: package feature

Permalink

class TextLenTransformer[T <: TextList] extends SequenceTransformer[T, OPVector] with VectorizerDefaults with TextTokenizerParams with TextParams

Sequence transformer for generating a sequence of text lengths from a sequence of TextList values (eg. tokenized raw text)

Linear Supertypes
TextParams, TextTokenizerParams, LanguageDetectionParams, VectorizerDefaults, SequenceTransformer[T, OPVector], OpTransformerN[T, OPVector], OpTransformer, OpPipelineStageN[T, OPVector], HasInN, OpPipelineStage[OPVector], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextLenTransformer
  2. TextParams
  3. TextTokenizerParams
  4. LanguageDetectionParams
  5. VectorizerDefaults
  6. SequenceTransformer
  7. OpTransformerN
  8. OpTransformer
  9. OpPipelineStageN
  10. HasInN
  11. OpPipelineStage
  12. OpPipelineStageBase
  13. MLWritable
  14. OpPipelineStageParams
  15. InputParams
  16. Transformer
  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 TextLenTransformer(uid: String = UID[TextLenTransformer[_]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T], ttiv: scala.reflect.api.JavaUniverse.TypeTag[Seq[String]])

    Permalink

Type Members

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

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStageNOpPipelineStageInputParams
  2. type KeyValue = (String) ⇒ Any

    Permalink

    Feature name (key) -> value lookup, e.g Row, Map etc.

    Feature name (key) -> value lookup, e.g Row, Map etc.

    Definition Classes
    OpTransformer
  3. 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 val autoDetectLanguage: BooleanParam

    Permalink

    Indicates whether to attempt language detection.

    Indicates whether to attempt language detection.

    Definition Classes
    LanguageDetectionParams
  7. final val autoDetectThreshold: DoubleParam

    Permalink

    Language detection threshold.

    Language detection threshold. If none of the detected languages have confidence greater than the threshold then defaultLanguage is used.

    Definition Classes
    LanguageDetectionParams
  8. implicit def booleanToDouble(v: Boolean): Double

    Permalink
    Definition Classes
    VectorizerDefaults
  9. 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
  10. 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
    OpTransformerNOpPipelineStageBase
  11. final val cleanText: BooleanParam

    Permalink
    Definition Classes
    TextParams
  12. final def clear(param: Param[_]): TextLenTransformer.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. final def copy(extra: ParamMap): TextLenTransformer.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
  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 val defaultLanguage: Param[String]

    Permalink

    Default language to assume in case autoDetectLanguage is disabled or failed to make a good enough prediction.

    Default language to assume in case autoDetectLanguage is disabled or failed to make a good enough prediction.

    Definition Classes
    LanguageDetectionParams
  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 finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  26. def getAutoDetectLanguage: Boolean

    Permalink
    Definition Classes
    LanguageDetectionParams
  27. def getAutoDetectThreshold: Double

    Permalink
    Definition Classes
    LanguageDetectionParams
  28. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  30. def getDefaultLanguage: Language

    Permalink
    Definition Classes
    LanguageDetectionParams
  31. 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

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

  33. final def getInputSchema(): StructType

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

    Permalink
    Definition Classes
    OpPipelineStageParams
  35. def getMinTokenLength: Int

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

    Permalink
    Definition Classes
    Params
  37. 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
  38. 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
  39. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  40. def getToLowercase: Boolean

    Permalink
    Definition Classes
    TextTokenizerParams
  41. 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
  42. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

    Definition Classes
    InputParams
  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, silent: Boolean): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. final val minTokenLength: IntParam

    Permalink

    Minimum token length, >= 1.

    Minimum token length, >= 1.

    Definition Classes
    TextTokenizerParams
  67. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

    Definition Classes
    TextLenTransformerOpPipelineStageParams
  71. def onSetInput(): Unit

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Definition Classes
    VectorizerDefaultsOpPipelineStageBase
  72. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    SequenceTransformerOpPipelineStageBase
  73. 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
  74. def outputFeatureUid: String

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  82. def setAutoDetectLanguage(value: Boolean): TextLenTransformer.this.type

    Permalink
    Definition Classes
    LanguageDetectionParams
  83. def setAutoDetectThreshold(value: Double): TextLenTransformer.this.type

    Permalink
    Definition Classes
    LanguageDetectionParams
  84. def setCleanText(clean: Boolean): TextLenTransformer.this.type

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  87. def setDefaultLanguage(value: Language): TextLenTransformer.this.type

    Permalink
    Definition Classes
    LanguageDetectionParams
  88. final def setInput(features: FeatureLike[T]*): TextLenTransformer.this.type

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

    Permalink
    Definition Classes
    OpPipelineStageParams
  92. def setMinTokenLength(value: Int): TextLenTransformer.this.type

    Permalink
    Definition Classes
    TextTokenizerParams
  93. def setOutputFeatureName(name: String): TextLenTransformer.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  94. def setToLowercase(value: Boolean): TextLenTransformer.this.type

    Permalink
    Definition Classes
    TextTokenizerParams
  95. 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
  96. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  97. final val toLowercase: BooleanParam

    Permalink

    Indicates whether to convert all characters to lowercase before tokenizing.

    Indicates whether to convert all characters to lowercase before tokenizing.

    Definition Classes
    TextTokenizerParams
  98. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  99. def tokenize(text: Text, languageDetector: LanguageDetector = TextTokenizer.LanguageDetector, analyzer: TextAnalyzer = TextTokenizer.Analyzer): TextTokenizerResult

    Permalink
    Definition Classes
    TextTokenizerParams
  100. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Spark operation on dataset to produce new output feature column using defined function

    Spark operation on dataset to produce new output feature column using defined function

    dataset

    input data for this stage

    returns

    a new dataset containing a column for the transformed feature

    Definition Classes
    OpTransformerN → Transformer
  101. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  102. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  103. def transformFn: (Seq[T]) ⇒ OPVector

    Permalink

    Function used to convert input to output

    Function used to convert input to output

    Definition Classes
    TextLenTransformerOpTransformerN
  104. lazy val transformKeyValue: (KeyValue) ⇒ Any

    Permalink

    Creates a transform function to transform any key/value to a value

    Creates a transform function to transform any key/value to a value

    returns

    a transform function to transform any key/value to a value

    Definition Classes
    OpTransformerN → OpTransformer
  105. def transformMap: (Map[String, Any]) ⇒ Any

    Permalink

    Creates a transform function to transform Map to a value

    Creates a transform function to transform Map to a value

    returns

    a transform function to transform Map to a value

    Definition Classes
    OpTransformer
  106. def transformRow: (Row) ⇒ Any

    Permalink

    Creates a transform function to transform Row to a value

    Creates a transform function to transform Row to a value

    returns

    a transform function to transform Row to a value

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

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

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    SequenceTransformerOpTransformerN
  110. implicit val ttiv: scala.reflect.api.JavaUniverse.TypeTag[Seq[String]]

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

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    SequenceTransformerOpPipelineStageN
  112. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    SequenceTransformerOpPipelineStageN
  113. val uid: String

    Permalink

    uid for instance

    uid for instance

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

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

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from TextParams

Inherited from TextTokenizerParams

Inherited from LanguageDetectionParams

Inherited from VectorizerDefaults

Inherited from SequenceTransformer[T, OPVector]

Inherited from OpTransformerN[T, OPVector]

Inherited from OpTransformer

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 Transformer

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