Packages

class TextFeaturizer extends Estimator[PipelineModel] with TextFeaturizerParams with HasInputCol with HasOutputCol with SynapseMLLogging

Featurize text.

Linear Supertypes
SynapseMLLogging, HasOutputCol, HasInputCol, TextFeaturizerParams, DefaultParamsWritable, MLWritable, Wrappable, RWrappable, PythonWrappable, BaseWrappable, Estimator[PipelineModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextFeaturizer
  2. SynapseMLLogging
  3. HasOutputCol
  4. HasInputCol
  5. TextFeaturizerParams
  6. DefaultParamsWritable
  7. MLWritable
  8. Wrappable
  9. RWrappable
  10. PythonWrappable
  11. BaseWrappable
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TextFeaturizer()
  2. new TextFeaturizer(uid: String)

    uid

    The id of the module

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val binary: BooleanParam

    All nonnegative word counts are set to 1 when set to true

    All nonnegative word counts are set to 1 when set to true

    Definition Classes
    TextFeaturizerParams
  7. val caseSensitiveStopWords: BooleanParam

    Indicates whether a case sensitive comparison is performed on stop words.

    Indicates whether a case sensitive comparison is performed on stop words.

    Definition Classes
    TextFeaturizerParams
  8. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  9. final def clear(param: Param[_]): TextFeaturizer.this.type
    Definition Classes
    Params
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  12. def copy(extra: ParamMap): TextFeaturizer.this.type
    Definition Classes
    TextFeaturizer → Estimator → PipelineStage → Params
  13. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  15. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. val defaultStopWordLanguage: Param[String]

    Specify the language to use for stop word removal.

    Specify the language to use for stop word removal. The Use the custom setting when using the stopWords input

    Definition Classes
    TextFeaturizerParams
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  20. def explainParams(): String
    Definition Classes
    Params
  21. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  22. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def fit(dataset: Dataset[_]): PipelineModel
    Definition Classes
    TextFeaturizer → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[PipelineModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): PipelineModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): PipelineModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. final def getBinary: Boolean

    Definition Classes
    TextFeaturizerParams
  30. final def getCaseSensitiveStopWords: Boolean

    Definition Classes
    TextFeaturizerParams
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  33. final def getDefaultStopWordLanguage: String

    Definition Classes
    TextFeaturizerParams
  34. def getInputCol: String

    Definition Classes
    HasInputCol
  35. final def getMinDocFreq: Int

    Definition Classes
    TextFeaturizerParams
  36. final def getMinTokenLength: Int

    Definition Classes
    TextFeaturizerParams
  37. final def getNGramLength: Int

    Definition Classes
    TextFeaturizerParams
  38. final def getNumFeatures: Int

    Definition Classes
    TextFeaturizerParams
  39. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  40. def getOutputCol: String

    Definition Classes
    HasOutputCol
  41. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  42. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  43. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  44. final def getStopWords: String

    Definition Classes
    TextFeaturizerParams
  45. final def getToLowercase: Boolean

    Definition Classes
    TextFeaturizerParams
  46. final def getTokenizerGaps: Boolean

    Definition Classes
    TextFeaturizerParams
  47. final def getTokenizerPattern: String

    Definition Classes
    TextFeaturizerParams
  48. final def getUseIDF: Boolean

    Definition Classes
    TextFeaturizerParams
  49. final def getUseNGram: Boolean

    Definition Classes
    TextFeaturizerParams
  50. final def getUseStopWordsRemover: Boolean

    Definition Classes
    TextFeaturizerParams
  51. final def getUseTokenizer: Boolean

    Definition Classes
    TextFeaturizerParams
  52. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  53. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  54. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  55. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  56. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. val inputCol: Param[String]

    The name of the input column

    The name of the input column

    Definition Classes
    HasInputCol
  58. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  63. def logBase(info: Map[String, String], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  64. def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  65. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  66. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  71. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  72. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  75. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  78. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  79. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  82. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  83. val minDocFreq: IntParam

    Minimum number of documents in which a term should appear.

    Minimum number of documents in which a term should appear.

    Definition Classes
    TextFeaturizerParams
  84. val minTokenLength: IntParam

    Minumum token length; must be 0 or greater.

    Minumum token length; must be 0 or greater.

    Definition Classes
    TextFeaturizerParams
  85. val nGramLength: IntParam

    The size of the Ngrams

    The size of the Ngrams

    Definition Classes
    TextFeaturizerParams
  86. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  87. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  88. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  89. val numFeatures: IntParam

    Set the number of features to hash each document to

    Set the number of features to hash each document to

    Definition Classes
    TextFeaturizerParams
  90. val outputCol: Param[String]

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol
  91. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  92. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  93. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  94. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  95. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  96. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  97. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  98. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  99. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  100. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  101. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  102. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  103. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  104. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  105. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  106. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  107. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  108. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  109. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  110. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  111. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  112. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  113. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  114. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  115. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  116. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  117. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  118. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  119. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  120. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  121. final def set(paramPair: ParamPair[_]): TextFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  122. final def set(param: String, value: Any): TextFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  123. final def set[T](param: Param[T], value: T): TextFeaturizer.this.type
    Definition Classes
    Params
  124. def setBinary(value: Boolean): TextFeaturizer.this.type

  125. def setCaseSensitiveStopWords(value: Boolean): TextFeaturizer.this.type

  126. final def setDefault(paramPairs: ParamPair[_]*): TextFeaturizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  127. final def setDefault[T](param: Param[T], value: T): TextFeaturizer.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  128. def setDefaultStopWordLanguage(value: String): TextFeaturizer.this.type

  129. def setInputCol(value: String): TextFeaturizer.this.type

    Definition Classes
    HasInputCol
  130. def setMinDocFreq(value: Int): TextFeaturizer.this.type

  131. def setMinTokenLength(value: Int): TextFeaturizer.this.type

  132. def setNGramLength(value: Int): TextFeaturizer.this.type

  133. def setNumFeatures(value: Int): TextFeaturizer.this.type

  134. def setOutputCol(value: String): TextFeaturizer.this.type

    Definition Classes
    HasOutputCol
  135. def setStopWords(value: String): TextFeaturizer.this.type

  136. def setToLowercase(value: Boolean): TextFeaturizer.this.type

  137. def setTokenizerGaps(value: Boolean): TextFeaturizer.this.type

  138. def setTokenizerPattern(value: String): TextFeaturizer.this.type

  139. def setUseIDF(value: Boolean): TextFeaturizer.this.type

  140. def setUseNGram(value: Boolean): TextFeaturizer.this.type

  141. def setUseStopWordsRemover(value: Boolean): TextFeaturizer.this.type

  142. def setUseTokenizer(value: Boolean): TextFeaturizer.this.type
  143. val stopWords: Param[String]

    The words to be filtered out.

    The words to be filtered out. This is a comma separated list of words, encoded as a single string. For example, "a, the, and"

    Definition Classes
    TextFeaturizerParams
  144. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  145. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  146. val toLowercase: BooleanParam

    Indicates whether to convert all characters to lowercase before tokenizing.

    Indicates whether to convert all characters to lowercase before tokenizing.

    Definition Classes
    TextFeaturizerParams
  147. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  148. val tokenizerGaps: BooleanParam

    Indicates whether the regex splits on gaps (true) or matches tokens (false)

    Indicates whether the regex splits on gaps (true) or matches tokens (false)

    Definition Classes
    TextFeaturizerParams
  149. val tokenizerPattern: Param[String]

    Regex pattern used to match delimiters if gaps (true) or tokens (false)

    Regex pattern used to match delimiters if gaps (true) or tokens (false)

    Definition Classes
    TextFeaturizerParams
  150. def transformSchema(schema: StructType): StructType
    Definition Classes
    TextFeaturizer → PipelineStage
  151. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  152. val uid: String
    Definition Classes
    TextFeaturizerSynapseMLLogging → Identifiable
  153. val useIDF: BooleanParam

    Scale the Term Frequencies by IDF when set to true

    Scale the Term Frequencies by IDF when set to true

    Definition Classes
    TextFeaturizerParams
  154. val useNGram: BooleanParam

    Enumerate N grams when set

    Enumerate N grams when set

    Definition Classes
    TextFeaturizerParams
  155. val useStopWordsRemover: BooleanParam

    Indicates whether to remove stop words from tokenized data.

    Indicates whether to remove stop words from tokenized data.

    Definition Classes
    TextFeaturizerParams
  156. val useTokenizer: BooleanParam

    Tokenize the input when set to true

    Tokenize the input when set to true

    Definition Classes
    TextFeaturizerParams
  157. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  158. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  159. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  160. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from SynapseMLLogging

Inherited from HasOutputCol

Inherited from HasInputCol

Inherited from TextFeaturizerParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Estimator[PipelineModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped