Packages

class Chunk2Token extends AnnotatorModel[Chunk2Token] with HasSimpleAnnotate[Chunk2Token]

A feature transformer that converts the input array of strings (annotatorType CHUNK) into an array of chunk-based tokens (annotatorType TOKEN).

When the input is empty, an empty array is returned.

This Annotator is specially convenient when using NGramGenerator annotations as inputs to WordEmbeddingsModels

Example

Define a pipeline for generating n-grams

val data = Seq(("A 63-year-old man presents to the hospital ...")).toDF("text")
val document = new DocumentAssembler().setInputCol("text").setOutputCol("document")
val sentenceDetector = new SentenceDetector().setInputCols("document").setOutputCol("sentence")
val token = new Tokenizer().setInputCols("sentence").setOutputCol("token")
val ngrammer = new NGramGenerator()
 .setN(2)
 .setEnableCumulative(false)
 .setInputCols("token")
 .setOutputCol("ngrams")
 .setDelimiter("_")

Stage to convert n-gram CHUNKS to TOKEN type

val chunk2Token = new Chunk2Token().setInputCols("ngrams").setOutputCol("ngram_tokens")
val trainingPipeline = new Pipeline().setStages(Array(document, sentenceDetector, token, ngrammer, chunk2Token)).fit(data)

val result = trainingPipeline.transform(data).cache()
result.selectExpr("explode(ngram_tokens)").show(5, false)
  +----------------------------------------------------------------+
  |col                                                             |
  +----------------------------------------------------------------+
  |{token, 3, 15, A_63-year-old, {sentence -> 0, chunk -> 0}, []}  |
  |{token, 5, 19, 63-year-old_man, {sentence -> 0, chunk -> 1}, []}|
  |{token, 17, 28, man_presents, {sentence -> 0, chunk -> 2}, []}  |
  |{token, 21, 31, presents_to, {sentence -> 0, chunk -> 3}, []}   |
  |{token, 30, 35, to_the, {sentence -> 0, chunk -> 4}, []}        |
  +----------------------------------------------------------------+
See also

NGramGenerator

Linear Supertypes
HasSimpleAnnotate[Chunk2Token], AnnotatorModel[Chunk2Token], CanBeLazy, RawAnnotator[Chunk2Token], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[Chunk2Token], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Chunk2Token
  2. HasSimpleAnnotate
  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 Chunk2Token()
  2. new Chunk2Token(uid: String)

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotationContent = Seq[Row]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. 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 _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    Chunk2Token → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): Chunk2Token.this.type
    Definition Classes
    Params
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def copy(extra: ParamMap): Chunk2Token
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  24. def explainParams(): String
    Definition Classes
    Params
  25. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  26. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  27. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  28. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  29. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  30. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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]
    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
    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 hasParent: Boolean
    Definition Classes
    Model
  46. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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[AnnotatorType]

    Input annotator type: CHUNK

    Input annotator type: CHUNK

    Definition Classes
    Chunk2Token → HasInputAnnotationCols
  50. final val inputCols: StringArrayParam
    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 onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  73. val outputAnnotatorType: AnnotatorType

    Output annotator types: TOKEN

    Output annotator types: TOKEN

    Definition Classes
    Chunk2Token → HasOutputAnnotatorType
  74. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  75. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  76. var parent: Estimator[Chunk2Token]
    Definition Classes
    Model
  77. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  78. def set[T](feature: StructFeature[T], value: T): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  79. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  80. def set[T](feature: SetFeature[T], value: Set[T]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  81. def set[T](feature: ArrayFeature[T], value: Array[T]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  82. final def set(paramPair: ParamPair[_]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    Params
  83. final def set(param: String, value: Any): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    Params
  84. final def set[T](param: Param[T], value: T): Chunk2Token.this.type
    Definition Classes
    Params
  85. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. final def setDefault(paramPairs: ParamPair[_]*): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    Params
  90. final def setDefault[T](param: Param[T], value: T): Chunk2Token.this.type
    Attributes
    protected
    Definition Classes
    Params
  91. final def setInputCols(value: String*): Chunk2Token.this.type
    Definition Classes
    HasInputAnnotationCols
  92. final def setInputCols(value: Array[String]): Chunk2Token.this.type
    Definition Classes
    HasInputAnnotationCols
  93. def setLazyAnnotator(value: Boolean): Chunk2Token.this.type
    Definition Classes
    CanBeLazy
  94. final def setOutputCol(value: String): Chunk2Token.this.type
    Definition Classes
    HasOutputAnnotationCol
  95. def setParent(parent: Estimator[Chunk2Token]): Chunk2Token
    Definition Classes
    Model
  96. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  97. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  98. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  99. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  100. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  101. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  102. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  103. val uid: String
    Definition Classes
    Chunk2Token → Identifiable
  104. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  105. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  108. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  109. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[Chunk2Token]

Inherited from AnnotatorModel[Chunk2Token]

Inherited from CanBeLazy

Inherited from RawAnnotator[Chunk2Token]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[Chunk2Token]

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

Annotator types

Required input and expected output annotator types

Ungrouped