Packages

c

com.johnsnowlabs.nlp.annotators

RecursiveTokenizer

class RecursiveTokenizer extends AnnotatorApproach[RecursiveTokenizerModel] with ParamsAndFeaturesWritable

Tokenizes raw text recursively based on a handful of definable rules.

Unlike the Tokenizer, the RecursiveTokenizer operates based on these array string parameters only:

  • prefixes: Strings that will be split when found at the beginning of token.
  • suffixes: Strings that will be split when found at the end of token.
  • infixes: Strings that will be split when found at the middle of token.
  • whitelist: Whitelist of strings not to split

For extended examples of usage, see the Examples and the TokenizerTestSpec.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.base.DocumentAssembler
import com.johnsnowlabs.nlp.annotators.RecursiveTokenizer
import org.apache.spark.ml.Pipeline

val documentAssembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")

val tokenizer = new RecursiveTokenizer()
  .setInputCols("document")
  .setOutputCol("token")

val pipeline = new Pipeline().setStages(Array(
  documentAssembler,
  tokenizer
))

val data = Seq("One, after the Other, (and) again. PO, QAM,").toDF("text")
val result = pipeline.fit(data).transform(data)

result.select("token.result").show(false)
+------------------------------------------------------------------+
|result                                                            |
+------------------------------------------------------------------+
|[One, ,, after, the, Other, ,, (, and, ), again, ., PO, ,, QAM, ,]|
+------------------------------------------------------------------+
Linear Supertypes
ParamsAndFeaturesWritable, HasFeatures, AnnotatorApproach[RecursiveTokenizerModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[RecursiveTokenizerModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RecursiveTokenizer
  2. ParamsAndFeaturesWritable
  3. HasFeatures
  4. AnnotatorApproach
  5. CanBeLazy
  6. DefaultParamsWritable
  7. MLWritable
  8. HasOutputAnnotatorType
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    required uid for storing annotator to disk

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

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. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): RecursiveTokenizerModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  12. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  13. final def clear(param: Param[_]): RecursiveTokenizer.this.type
    Definition Classes
    Params
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. final def copy(extra: ParamMap): Estimator[RecursiveTokenizerModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  16. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  18. val description: String

    Simplest possible tokenizer

    Simplest possible tokenizer

    Definition Classes
    RecursiveTokenizer → AnnotatorApproach
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  22. def explainParams(): String
    Definition Classes
    Params
  23. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  24. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  25. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def fit(dataset: Dataset[_]): RecursiveTokenizerModel
    Definition Classes
    AnnotatorApproach → Estimator
  28. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[RecursiveTokenizerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  29. def fit(dataset: Dataset[_], paramMap: ParamMap): RecursiveTokenizerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  30. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): RecursiveTokenizerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  31. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  32. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  33. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  38. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  39. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  40. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  41. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  42. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  43. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  44. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  45. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  46. val infixes: StringArrayParam

    Strings that will be split when found at the middle of token (Default: Array("\n", "(", ")")).

  47. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  48. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. val inputAnnotatorTypes: Array[String]

    Input Annotator Type : DOCUMENT

    Input Annotator Type : DOCUMENT

    Definition Classes
    RecursiveTokenizer → HasInputAnnotationCols
  50. final val inputCols: StringArrayParam

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  51. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  54. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  55. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  56. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  57. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. def onTrained(model: RecursiveTokenizerModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  73. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  74. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  75. val outputAnnotatorType: AnnotatorType

    Output Annotator Type : TOKEN

    Output Annotator Type : TOKEN

    Definition Classes
    RecursiveTokenizer → HasOutputAnnotatorType
  76. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  77. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  78. val prefixes: StringArrayParam

    Strings that will be split when found at the beginning of token (Default: Array("'", "\"", "(", "[", "\n")).

  79. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  80. def set[T](feature: StructFeature[T], value: T): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  81. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  82. def set[T](feature: SetFeature[T], value: Set[T]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  83. def set[T](feature: ArrayFeature[T], value: Array[T]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. final def set(paramPair: ParamPair[_]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  85. final def set(param: String, value: Any): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  86. final def set[T](param: Param[T], value: T): RecursiveTokenizer.this.type
    Definition Classes
    Params
  87. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. final def setDefault(paramPairs: ParamPair[_]*): RecursiveTokenizer.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def setDefault[T](param: Param[T], value: T): RecursiveTokenizer.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  93. def setInfixes(p: Array[String]): RecursiveTokenizer.this.type

    Strings that will be split when found at the middle of token.

  94. final def setInputCols(value: String*): RecursiveTokenizer.this.type
    Definition Classes
    HasInputAnnotationCols
  95. def setInputCols(value: Array[String]): RecursiveTokenizer.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  96. def setLazyAnnotator(value: Boolean): RecursiveTokenizer.this.type
    Definition Classes
    CanBeLazy
  97. final def setOutputCol(value: String): RecursiveTokenizer.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  98. def setPrefixes(p: Array[String]): RecursiveTokenizer.this.type

    Strings that will be split when found at the beginning of token.

  99. def setSuffixes(s: Array[String]): RecursiveTokenizer.this.type

    Strings that will be split when found at the end of token.

  100. def setWhitelist(w: Array[String]): RecursiveTokenizer.this.type

    Whitelist.

  101. val suffixes: StringArrayParam

    Strings that will be split when found at the end of token (Default: Array(".", ":", "%", ",", ";", "?", "'", "\"", ")", "]", "\n", "!", "'s")).

  102. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  103. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  104. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): RecursiveTokenizerModel
    Definition Classes
    RecursiveTokenizer → AnnotatorApproach
  105. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  106. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  107. val uid: String
    Definition Classes
    RecursiveTokenizer → Identifiable
  108. def validate(schema: StructType): Boolean

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  109. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  111. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  112. val whitelist: StringArrayParam

    Whitelist (Default: Array("it's", "that's", "there's", "he's", "she's", "what's", "let's", "who's", "It's", "That's", "There's", "He's", "She's", "What's", "Let's", "Who's")).

  113. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AnnotatorApproach[RecursiveTokenizerModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[RecursiveTokenizerModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Annotator types

Required input and expected output annotator types

Members

Parameter setters