Class/Object

com.johnsnowlabs.nlp.annotators

ChunkTokenizer

Related Docs: object ChunkTokenizer | package annotators

Permalink

class ChunkTokenizer extends Tokenizer

Linear Supertypes
Tokenizer, AnnotatorApproach[TokenizerModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[TokenizerModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChunkTokenizer
  2. Tokenizer
  3. AnnotatorApproach
  4. CanBeLazy
  5. DefaultParamsWritable
  6. MLWritable
  7. HasOutputAnnotatorType
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChunkTokenizer()

    Permalink
  2. new ChunkTokenizer(uid: String)

    Permalink

Type Members

  1. 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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): TokenizerModel

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. def addContextChars(v: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  7. def addException(value: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  8. def addInfixPattern(value: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  9. def addSplitChars(v: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  12. def buildRuleFactory: RuleFactory

    Permalink
    Definition Classes
    Tokenizer
  13. val caseSensitiveExceptions: BooleanParam

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. val contextChars: StringArrayParam

    Permalink
    Definition Classes
    Tokenizer
  18. final def copy(extra: ParamMap): Estimator[TokenizerModel]

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. val description: String

    Permalink
    Definition Classes
    TokenizerAnnotatorApproach
  22. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. val exceptions: StringArrayParam

    Permalink
    Definition Classes
    Tokenizer
  25. val exceptionsPath: ExternalResourceParam

    Permalink
    Definition Classes
    Tokenizer
  26. def explainParam(param: Param[_]): String

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

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

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

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

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

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  32. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[TokenizerModel]

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

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

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

    Permalink
    Definition Classes
    Params
  36. def getCaseSensitiveExceptions(value: Boolean): Boolean

    Permalink
    Definition Classes
    Tokenizer
  37. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  38. def getContextChars: Array[String]

    Permalink
    Definition Classes
    Tokenizer
  39. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  40. def getExceptions: Array[String]

    Permalink
    Definition Classes
    Tokenizer
  41. def getInfixPatterns: Array[String]

    Permalink
    Definition Classes
    Tokenizer
  42. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  43. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  44. def getMaxLength(value: Int): Int

    Permalink
    Definition Classes
    Tokenizer
  45. def getMinLength(value: Int): Int

    Permalink
    Definition Classes
    Tokenizer
  46. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  47. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  49. def getPrefixPattern: String

    Permalink
    Definition Classes
    Tokenizer
  50. def getSplitChars: Array[String]

    Permalink
    Definition Classes
    Tokenizer
  51. def getSplitPattern: String

    Permalink
    Definition Classes
    Tokenizer
  52. def getSuffixPattern: String

    Permalink
    Definition Classes
    Tokenizer
  53. def getTargetPattern: String

    Permalink
    Definition Classes
    Tokenizer
  54. final def hasDefault[T](param: Param[T]): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  57. val infixPatterns: StringArrayParam

    Permalink
    Definition Classes
    Tokenizer
  58. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

    Permalink

    A Tokenizer could require only for now a SentenceDetector annotator

    A Tokenizer could require only for now a SentenceDetector annotator

    Definition Classes
    ChunkTokenizerTokenizerHasInputAnnotationCols
  61. 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
  62. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  67. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Tokenizer
  80. val minLength: IntParam

    Permalink
    Definition Classes
    Tokenizer
  81. def msgHelper(schema: StructType): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
  85. def onTrained(model: TokenizerModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  86. val outputAnnotatorType: AnnotatorType

    Permalink
  87. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  89. val prefixPattern: Param[String]

    Permalink
    Definition Classes
    Tokenizer
  90. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  94. def setCaseSensitiveExceptions(value: Boolean): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  95. def setContextChars(v: Array[String]): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  96. final def setDefault(paramPairs: ParamPair[_]*): ChunkTokenizer.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  98. def setExceptions(value: Array[String]): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  99. def setExceptionsPath(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("format" -> "text")): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  100. def setInfixPatterns(value: Array[String]): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  101. final def setInputCols(value: String*): ChunkTokenizer.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  103. def setLazyAnnotator(value: Boolean): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    CanBeLazy
  104. def setMaxLength(value: Int): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  105. def setMinLength(value: Int): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  106. final def setOutputCol(value: String): ChunkTokenizer.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  107. def setPrefixPattern(value: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  108. def setSplitChars(v: Array[String]): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  109. def setSplitPattern(value: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  110. def setSuffixPattern(value: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  111. def setTargetPattern(value: String): ChunkTokenizer.this.type

    Permalink
    Definition Classes
    Tokenizer
  112. val splitChars: StringArrayParam

    Permalink
    Definition Classes
    Tokenizer
  113. val splitPattern: Param[String]

    Permalink
    Definition Classes
    Tokenizer
  114. val suffixPattern: Param[String]

    Permalink
    Definition Classes
    Tokenizer
  115. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  116. val targetPattern: Param[String]

    Permalink
    Definition Classes
    Tokenizer
  117. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  118. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): TokenizerModel

    Permalink
    Definition Classes
    ChunkTokenizerTokenizerAnnotatorApproach
  119. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage
  120. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    ChunkTokenizerTokenizer → Identifiable
  122. 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
    AnnotatorApproach
  123. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from Tokenizer

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[TokenizerModel]

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