Class

com.johnsnowlabs.nlp.annotators

RegexTokenizer

Related Doc: package annotators

Permalink

class RegexTokenizer extends AnnotatorModel[RegexTokenizer]

A tokenizer that splits text by regex pattern.

See also

RegexTokenizer

Linear Supertypes
AnnotatorModel[RegexTokenizer], CanBeLazy, RawAnnotator[RegexTokenizer], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[RegexTokenizer], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RegexTokenizer
  2. AnnotatorModel
  3. CanBeLazy
  4. RawAnnotator
  5. HasOutputAnnotationCol
  6. HasInputAnnotationCols
  7. HasOutputAnnotatorType
  8. ParamsAndFeaturesWritable
  9. HasFeatures
  10. DefaultParamsWritable
  11. MLWritable
  12. Model
  13. Transformer
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RegexTokenizer()

    Permalink
  2. new RegexTokenizer(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

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. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    RegexTokenizerAnnotatorModel
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): RegexTokenizer.this.type

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  20. def dfAnnotate: UserDefinedFunction

    Permalink

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  21. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    Params
  25. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  26. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  27. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  29. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  32. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  33. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  36. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  38. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  39. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  40. def getMaxLength: Int

    Permalink

  41. def getMinLength: Int

    Permalink

  42. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  43. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  44. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  45. def getPattern: String

    Permalink

  46. def getPositionalMask: Boolean

    Permalink

  47. def getToLowercase: Boolean

    Permalink

  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 hasParent: Boolean

    Permalink
    Definition Classes
    Model
  51. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Input annotator type: TOKEN

    Input annotator type: TOKEN

    Definition Classes
    RegexTokenizerHasInputAnnotationCols
  55. final val inputCols: StringArrayParam

    Permalink

    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
  56. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  61. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. val maxLength: IntParam

    Permalink

    Maximum token length, greater than or equal to 1.

  74. val minLength: IntParam

    Permalink

    Minimum token length, greater than or equal to 0.

    Minimum token length, greater than or equal to 0. Default: 1, to avoid returning empty strings

  75. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  76. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  79. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  80. val outputAnnotatorType: AnnotatorType

    Permalink

    Output annotator type: TOKEN

    Output annotator type: TOKEN

    Definition Classes
    RegexTokenizerHasOutputAnnotatorType
  81. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  82. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  83. var parent: Estimator[RegexTokenizer]

    Permalink
    Definition Classes
    Model
  84. val pattern: Param[String]

    Permalink

    Regex pattern used to match delimiters Default: "\\s+"

  85. val positionalMask: BooleanParam

    Permalink

    Indicates whether to apply the regex tokenization using a positional mask to guarantee the incremental progression Default: false

  86. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  87. def set[T](feature: StructFeature[T], value: T): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[T](feature: SetFeature[T], value: Set[T]): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[T](feature: ArrayFeature[T], value: Array[T]): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. final def set(paramPair: ParamPair[_]): RegexTokenizer.this.type

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

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

    Permalink
    Definition Classes
    Params
  94. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RegexTokenizer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. final def setDefault(paramPairs: ParamPair[_]*): RegexTokenizer.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  100. final def setInputCols(value: String*): RegexTokenizer.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  101. final def setInputCols(value: Array[String]): RegexTokenizer.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  102. def setLazyAnnotator(value: Boolean): RegexTokenizer.this.type

    Permalink
    Definition Classes
    CanBeLazy
  103. def setMaxLength(value: Int): RegexTokenizer.this.type

    Permalink

  104. def setMinLength(value: Int): RegexTokenizer.this.type

    Permalink

  105. final def setOutputCol(value: String): RegexTokenizer.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  106. def setParent(parent: Estimator[RegexTokenizer]): RegexTokenizer

    Permalink
    Definition Classes
    Model
  107. def setPattern(value: String): RegexTokenizer.this.type

    Permalink

  108. def setPositionalMask(value: Boolean): RegexTokenizer.this.type

    Permalink

  109. def setToLowercase(value: Boolean): RegexTokenizer.this.type

    Permalink

  110. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  111. def tag(sentences: Seq[Sentence]): Seq[TokenizedSentence]

    Permalink

    This func generates a Seq of TokenizedSentences from a Seq of Sentences.

    This func generates a Seq of TokenizedSentences from a Seq of Sentences.

    sentences

    to tag

    returns

    Seq of TokenizedSentence objects

  112. def tagWithPositionalMask(sentences: Seq[Sentence]): Seq[TokenizedSentence]

    Permalink

    This func generates a Seq of TokenizedSentences from a Seq of Sentences preserving positional progression

    This func generates a Seq of TokenizedSentences from a Seq of Sentences preserving positional progression

    sentences

    to tag

    returns

    Seq of TokenizedSentence objects

  113. val toLowercase: BooleanParam

    Permalink

    Indicates whether to convert all characters to lowercase before tokenizing.

    Indicates whether to convert all characters to lowercase before tokenizing. Default: true

  114. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  115. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    dataset

    Dataset[Row]

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

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  118. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  119. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    RegexTokenizer → Identifiable
  121. def validate(schema: StructType): Boolean

    Permalink

    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
    RawAnnotator
  122. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  126. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from AnnotatorModel[RegexTokenizer]

Inherited from CanBeLazy

Inherited from RawAnnotator[RegexTokenizer]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[RegexTokenizer]

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

anno

getParam

param

setParam

Ungrouped