Class/Object

com.johnsnowlabs.nlp.annotators

Tokenizer

Related Docs: object Tokenizer | package annotators

Permalink

class Tokenizer extends AnnotatorApproach[TokenizerModel]

Linear Supertypes
AnnotatorApproach[TokenizerModel], DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[TokenizerModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tokenizer
  2. AnnotatorApproach
  3. DefaultParamsWritable
  4. MLWritable
  5. HasOutputAnnotatorType
  6. HasOutputAnnotationCol
  7. HasInputAnnotationCols
  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 Tokenizer()

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

    Permalink
  6. def addException(value: String): Tokenizer.this.type

    Permalink
  7. def addInfixPattern(value: String): Tokenizer.this.type

    Permalink
  8. def addSplitChars(v: String): Tokenizer.this.type

    Permalink
  9. final def asInstanceOf[T0]: T0

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

    Permalink
    Definition Classes
    AnnotatorApproach
  11. def buildRuleFactory: RuleFactory

    Permalink
  12. val caseSensitiveExceptions: BooleanParam

    Permalink
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

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

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

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

    Permalink
  17. final def copy(extra: ParamMap): Estimator[TokenizerModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → 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. val description: String

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

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

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

    Permalink
  24. val exceptionsPath: ExternalResourceParam

    Permalink
  25. def explainParam(param: Param[_]): String

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  38. final def getDefault[T](param: Param[T]): Option[T]

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

    Permalink
  40. def getInfixPatterns: Array[String]

    Permalink
  41. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  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 getPrefixPattern: String

    Permalink
  46. def getSplitChars: Array[String]

    Permalink
  47. def getSuffixPattern: String

    Permalink
  48. def getTargetPattern: String

    Permalink
  49. final def hasDefault[T](param: Param[T]): Boolean

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

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

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

    Permalink
  53. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. 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
    TokenizerHasInputAnnotationCols
  56. 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
  57. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  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. 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. def onTrained(model: TokenizerModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  77. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    TokenizerHasOutputAnnotatorType
  78. final val outputCol: Param[String]

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

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

    Permalink
  81. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  85. def setCaseSensitiveExceptions(value: Boolean): Tokenizer.this.type

    Permalink
  86. def setContextChars(v: Array[String]): Tokenizer.this.type

    Permalink
  87. final def setDefault(paramPairs: ParamPair[_]*): Tokenizer.this.type

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

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

    Permalink
  90. def setExceptionsPath(path: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): Tokenizer.this.type

    Permalink
  91. def setInfixPatterns(value: Array[String]): Tokenizer.this.type

    Permalink
  92. final def setInputCols(value: String*): Tokenizer.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  94. final def setOutputCol(value: String): Tokenizer.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  95. def setPrefixPattern(value: String): Tokenizer.this.type

    Permalink
  96. def setSplitChars(v: Array[String]): Tokenizer.this.type

    Permalink
  97. def setSuffixPattern(value: String): Tokenizer.this.type

    Permalink
  98. def setTargetPattern(value: String): Tokenizer.this.type

    Permalink
  99. val splitChars: StringArrayParam

    Permalink
  100. val suffixPattern: Param[String]

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

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

    Permalink
  103. def toString(): String

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

    Permalink
    Definition Classes
    TokenizerAnnotatorApproach
  105. 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
  106. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    Tokenizer → Identifiable
  108. 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
  109. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

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