Class/Object

com.salesforce.op.stages.impl.feature

TextTokenizer

Related Docs: object TextTokenizer | package feature

Permalink

class TextTokenizer[T <: Text] extends UnaryTransformer[T, TextList] with TextTokenizerParams

Transformer that takes anything of type Text or lower and returns a TextList of tokens extracted from that text

Linear Supertypes
TextTokenizerParams, LanguageDetectionParams, UnaryTransformer[T, TextList], OpTransformer1[T, TextList], OpTransformer, OpPipelineStage1[T, TextList], HasIn1, OpPipelineStage[TextList], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextTokenizer
  2. TextTokenizerParams
  3. LanguageDetectionParams
  4. UnaryTransformer
  5. OpTransformer1
  6. OpTransformer
  7. OpPipelineStage1
  8. HasIn1
  9. OpPipelineStage
  10. OpPipelineStageBase
  11. MLWritable
  12. OpPipelineStageParams
  13. InputParams
  14. Transformer
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Serializable
  20. Identifiable
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TextTokenizer(languageDetector: LanguageDetector = TextTokenizer.LanguageDetector, analyzer: TextAnalyzer = TextTokenizer.Analyzer, uid: String = UID[TextTokenizer[_]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T])

    Permalink

    languageDetector

    a language detector instance (defaults to OptimaizeLanguageDetector

    analyzer

    a text analyzer instance (defaults to a LuceneTextAnalyzer)

    uid

    uid of the stage

Type Members

  1. final type InputFeatures = FeatureLike[T]

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage1OpPipelineStageInputParams
  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[TextList]

    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. val analyzer: TextAnalyzer

    Permalink

    a text analyzer instance (defaults to a LuceneTextAnalyzer)

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. final val autoDetectLanguage: BooleanParam

    Permalink

    Indicates whether to attempt language detection.

    Indicates whether to attempt language detection.

    Definition Classes
    LanguageDetectionParams
  8. 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
  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
    OpPipelineStage1InputParams
  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
    OpTransformer1OpPipelineStageBase
  11. final def clear(param: Param[_]): TextTokenizer.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def copy(extra: ParamMap): TextTokenizer.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
  14. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  16. 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
  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. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  25. def getAutoDetectLanguage: Boolean

    Permalink
    Definition Classes
    LanguageDetectionParams
  26. def getAutoDetectThreshold: Double

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

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

    Permalink
    Definition Classes
    Params
  29. def getDefaultLanguage: Language

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

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

  32. final def getInputSchema(): StructType

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

    Permalink
    Definition Classes
    OpPipelineStageParams
  34. def getMinTokenLength: Int

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

    Permalink
    Definition Classes
    Params
  36. def getOutput(): FeatureLike[TextList]

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

    Permalink
    Definition Classes
    Params
  39. def getToLowercase: Boolean

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

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. 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
  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. val languageDetector: LanguageDetector

    Permalink

    a language detector instance (defaults to OptimaizeLanguageDetector

  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

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  72. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    UnaryTransformerOpPipelineStageBase
  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
    OpPipelineStage1OpPipelineStage
  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. lazy val params: Array[Param[_]]

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

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

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

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

    Permalink
    Definition Classes
    Params
  81. def setAutoDetectLanguage(value: Boolean): TextTokenizer.this.type

    Permalink
    Definition Classes
    LanguageDetectionParams
  82. def setAutoDetectThreshold(value: Double): TextTokenizer.this.type

    Permalink
    Definition Classes
    LanguageDetectionParams
  83. final def setDefault(paramPairs: ParamPair[_]*): TextTokenizer.this.type

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

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

    Permalink
    Definition Classes
    LanguageDetectionParams
  86. final def setInput(features: InputFeatures): TextTokenizer.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
  87. final def setInputFeatures[S <: OPFeature](features: Array[S]): TextTokenizer.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
  88. final def setMetadata(m: Metadata): TextTokenizer.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  89. def setMinTokenLength(value: Int): TextTokenizer.this.type

    Permalink
    Definition Classes
    TextTokenizerParams
  90. def setOutputFeatureName(name: String): TextTokenizer.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  91. def setToLowercase(value: Boolean): TextTokenizer.this.type

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

    Permalink
    Definition Classes
    AnyRef
  94. 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
  95. def toString(): String

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

    Permalink
    Definition Classes
    TextTokenizerParams
  97. 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
    OpTransformer1 → Transformer
  98. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  100. def transformFn: (T) ⇒ TextList

    Permalink

    Function used to convert input to output

    Function used to convert input to output

    Definition Classes
    TextTokenizerOpTransformer1
  101. 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
    OpTransformer1 → OpTransformer
  102. 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
  103. 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
  104. 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
  105. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    UnaryTransformerOpTransformer1
  107. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[TextList]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    UnaryTransformerOpPipelineStage1
  108. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[features.types.TextList.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    UnaryTransformerOpPipelineStage1
  109. val uid: String

    Permalink

    uid for instance

    uid for instance

    Definition Classes
    UnaryTransformer → Identifiable
  110. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from TextTokenizerParams

Inherited from LanguageDetectionParams

Inherited from UnaryTransformer[T, TextList]

Inherited from OpTransformer1[T, TextList]

Inherited from OpTransformer

Inherited from OpPipelineStage1[T, TextList]

Inherited from HasIn1

Inherited from OpPipelineStage[TextList]

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