Class/Object

com.microsoft.ml.spark.featurize.text

TextFeaturizer

Related Docs: object TextFeaturizer | package text

Permalink

class TextFeaturizer extends Estimator[TextFeaturizerModel] with TextFeaturizerParams with HasInputCol with HasOutputCol

Featurize text.

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

Instance Constructors

  1. new TextFeaturizer()

    Permalink
  2. new TextFeaturizer(uid: String)

    Permalink

    uid

    The id of the module

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. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    Wrappable
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val binary: BooleanParam

    Permalink

    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
  8. val caseSensitiveStopWords: BooleanParam

    Permalink

    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
  9. final def clear(param: Param[_]): TextFeaturizer.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy(extra: ParamMap): Estimator[TextFeaturizerModel]

    Permalink
    Definition Classes
    TextFeaturizer → Estimator → PipelineStage → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. val defaultStopWordLanguage: Param[String]

    Permalink

    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
  15. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def fit(dataset: Dataset[_]): TextFeaturizerModel

    Permalink
    Definition Classes
    TextFeaturizer → Estimator
  23. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[TextFeaturizerModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], paramMap: ParamMap): TextFeaturizerModel

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  26. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  27. final def getBinary: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  28. final def getCaseSensitiveStopWords: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  29. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  31. final def getDefaultStopWordLanguage: String

    Permalink

    Definition Classes
    TextFeaturizerParams
  32. def getInputCol: String

    Permalink

    Definition Classes
    HasInputCol
  33. final def getMinDocFreq: Int

    Permalink

    Definition Classes
    TextFeaturizerParams
  34. final def getMinTokenLength: Int

    Permalink

    Definition Classes
    TextFeaturizerParams
  35. final def getNGramLength: Int

    Permalink

    Definition Classes
    TextFeaturizerParams
  36. final def getNumFeatures: Int

    Permalink

    Definition Classes
    TextFeaturizerParams
  37. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  38. def getOutputCol: String

    Permalink

    Definition Classes
    HasOutputCol
  39. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  40. final def getStopWords: String

    Permalink

    Definition Classes
    TextFeaturizerParams
  41. final def getToLowercase: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  42. final def getTokenizerGaps: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  43. final def getTokenizerPattern: String

    Permalink

    Definition Classes
    TextFeaturizerParams
  44. final def getUseIDF: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  45. final def getUseNGram: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  46. final def getUseStopWordsRemover: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  47. final def getUseTokenizer: Boolean

    Permalink

    Definition Classes
    TextFeaturizerParams
  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. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. val inputCol: Param[String]

    Permalink

    The name of the input column

    The name of the input column

    Definition Classes
    HasInputCol
  54. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. val minDocFreq: IntParam

    Permalink

    Minimum number of documents in which a term should appear.

    Minimum number of documents in which a term should appear.

    Definition Classes
    TextFeaturizerParams
  71. val minTokenLength: IntParam

    Permalink

    Minumum token length; must be 0 or greater.

    Minumum token length; must be 0 or greater.

    Definition Classes
    TextFeaturizerParams
  72. val nGramLength: IntParam

    Permalink

    The size of the Ngrams

    The size of the Ngrams

    Definition Classes
    TextFeaturizerParams
  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. val numFeatures: IntParam

    Permalink

    Set the number of features to hash each document to

    Set the number of features to hash each document to

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

    Permalink

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol
  78. lazy val params: Array[Param[_]]

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

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

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

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

    Permalink
    Definition Classes
    Params
  83. def setBinary(value: Boolean): TextFeaturizer.this.type

    Permalink

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

    Permalink

  85. final def setDefault(paramPairs: ParamPair[_]*): TextFeaturizer.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  87. def setDefaultStopWordLanguage(value: String): TextFeaturizer.this.type

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

  101. def setUseTokenizer(value: Boolean): TextFeaturizer.this.type

    Permalink
  102. val stopWords: Param[String]

    Permalink

    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
  103. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  104. 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
    TextFeaturizerParams
  105. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  106. val tokenizerGaps: BooleanParam

    Permalink

    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
  107. val tokenizerPattern: Param[String]

    Permalink

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

    Permalink
    Definition Classes
    TextFeaturizer → PipelineStage
  109. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  110. val uid: String

    Permalink

    The id of the module

    The id of the module

    Definition Classes
    TextFeaturizer → Identifiable
  111. val useIDF: BooleanParam

    Permalink

    Scale the Term Frequencies by IDF when set to true

    Scale the Term Frequencies by IDF when set to true

    Definition Classes
    TextFeaturizerParams
  112. val useNGram: BooleanParam

    Permalink

    Enumerate N grams when set

    Enumerate N grams when set

    Definition Classes
    TextFeaturizerParams
  113. val useStopWordsRemover: BooleanParam

    Permalink

    Indicates whether to remove stop words from tokenized data.

    Indicates whether to remove stop words from tokenized data.

    Definition Classes
    TextFeaturizerParams
  114. val useTokenizer: BooleanParam

    Permalink

    Tokenize the input when set to true

    Tokenize the input when set to true

    Definition Classes
    TextFeaturizerParams
  115. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from HasOutputCol

Inherited from HasInputCol

Inherited from TextFeaturizerParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Estimator[TextFeaturizerModel]

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