Class/Object

com.johnsnowlabs.nlp.annotators

ChunkTokenizerModel

Related Docs: object ChunkTokenizerModel | package annotators

Permalink

class ChunkTokenizerModel extends TokenizerModel

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

Instance Constructors

  1. new ChunkTokenizerModel()

    Permalink
  2. new ChunkTokenizerModel(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 addSplitChars(v: String): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  11. def afterAnnotate(dataset: DataFrame): DataFrame

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

    Permalink

    one to many annotation

    one to many annotation

    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
    ChunkTokenizerModelTokenizerModelAnnotatorModel
  13. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. val caseSensitiveExceptions: BooleanParam

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

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

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. 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
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    TokenizerModel
  40. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    TokenizerModel
  43. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  44. def getLazyAnnotator: Boolean

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

    Permalink
    Definition Classes
    TokenizerModel
  46. def getMinLength(value: Int): Int

    Permalink
    Definition Classes
    TokenizerModel
  47. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  48. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

    Permalink
    Definition Classes
    TokenizerModel
  51. def getSplitPattern: String

    Permalink
    Definition Classes
    TokenizerModel
  52. def getTargetPattern: String

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

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

    Permalink
    Definition Classes
    Params
  55. def hasParent: Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. 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
    ChunkTokenizerModelTokenizerModelHasInputAnnotationCols
  60. 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
  61. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  66. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    TokenizerModel
  79. val minLength: IntParam

    Permalink
    Definition Classes
    TokenizerModel
  80. def msgHelper(schema: StructType): String

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

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

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

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

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

    Permalink
  86. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  88. var parent: Estimator[TokenizerModel]

    Permalink
    Definition Classes
    Model
  89. val rules: StructFeature[RuleFactory]

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  98. def setCaseSensitiveExceptions(value: Boolean): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  99. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ChunkTokenizerModel.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    TokenizerModel
  106. final def setInputCols(value: String*): ChunkTokenizerModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  108. def setLazyAnnotator(value: Boolean): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  109. def setMaxLength(value: Int): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  110. def setMinLength(value: Int): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  111. final def setOutputCol(value: String): ChunkTokenizerModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  112. def setParent(parent: Estimator[TokenizerModel]): TokenizerModel

    Permalink
    Definition Classes
    Model
  113. def setRules(ruleFactory: RuleFactory): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  114. def setSplitChars(v: Array[String]): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  115. def setSplitPattern(value: String): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  116. def setTargetPattern(value: String): ChunkTokenizerModel.this.type

    Permalink
    Definition Classes
    TokenizerModel
  117. val splitChars: StringArrayParam

    Permalink
    Definition Classes
    TokenizerModel
  118. val splitPattern: Param[String]

    Permalink
    Definition Classes
    TokenizerModel
  119. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    TokenizerModel
  121. val targetPattern: Param[String]

    Permalink
    Definition Classes
    TokenizerModel
  122. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  123. 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
  124. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  126. 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
  127. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    ChunkTokenizerModelTokenizerModel → Identifiable
  129. 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
  130. final def wait(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from TokenizerModel

Inherited from AnnotatorModel[TokenizerModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[TokenizerModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[TokenizerModel]

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

Ungrouped