class Doc2Chunk extends Model[Doc2Chunk] with RawAnnotator[Doc2Chunk]

Converts DOCUMENT type annotations into CHUNK type with the contents of a chunkCol. Chunk text must be contained within input DOCUMENT. May be either StringType or ArrayType[StringType] (using setIsArray). Useful for annotators that require a CHUNK type input.

For more extended examples on document pre-processing see the Spark NLP Workshop.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.{Doc2Chunk, DocumentAssembler}
import org.apache.spark.ml.Pipeline

val documentAssembler = new DocumentAssembler().setInputCol("text").setOutputCol("document")
val chunkAssembler = new Doc2Chunk()
  .setInputCols("document")
  .setChunkCol("target")
  .setOutputCol("chunk")
  .setIsArray(true)

val data = Seq(
  ("Spark NLP is an open-source text processing library for advanced natural language processing.",
    Seq("Spark NLP", "text processing library", "natural language processing"))
).toDF("text", "target")

val pipeline = new Pipeline().setStages(Array(documentAssembler, chunkAssembler)).fit(data)
val result = pipeline.transform(data)

result.selectExpr("chunk.result", "chunk.annotatorType").show(false)
+-----------------------------------------------------------------+---------------------+
|result                                                           |annotatorType        |
+-----------------------------------------------------------------+---------------------+
|[Spark NLP, text processing library, natural language processing]|[chunk, chunk, chunk]|
+-----------------------------------------------------------------+---------------------+
See also

Chunk2Doc for converting CHUNK annotations to DOCUMENT

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

Instance Constructors

  1. new Doc2Chunk()
  2. new Doc2Chunk(uid: String)

    uid

    required uid for storing annotator to disk

Type Members

  1. 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  11. val chunkCol: Param[String]

    Column that contains string.

    Column that contains string. Must be part of DOCUMENT

  12. final def clear(param: Param[_]): Doc2Chunk.this.type
    Definition Classes
    Params
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def copy(extra: ParamMap): Doc2Chunk

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  15. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  20. def explainParams(): String
    Definition Classes
    Params
  21. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    Doc2ChunkRawAnnotator
  22. def extraValidateMsg: AnnotatorType

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    Doc2ChunkRawAnnotator
  23. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  24. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  25. val failOnMissing: BooleanParam

    Whether to fail the job if a chunk is not found within document, return empty otherwise (Default: false)

  26. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  29. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  30. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  31. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  32. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  33. def getChunkCol: String

    Column that contains string.

    Column that contains string. Must be part of DOCUMENT

  34. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  36. def getFailOnMissing: Boolean

    Whether to fail the job if a chunk is not found within document, return empty otherwise (Default: false)

  37. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  38. def getIsArray: Boolean

    Whether the chunkCol is an array of strings (Default: false)

  39. def getLowerCase: Boolean

    Whether to lower case for matching case (Default: true)

  40. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  41. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  42. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  43. def getStartCol: String

    Column that has a reference of where the chunk begins

  44. def getStartColByTokenIndex: Boolean

    Whether start col is by whitespace tokens (Default: false)

  45. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  46. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  47. def hasParent: Boolean
    Definition Classes
    Model
  48. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  50. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. val inputAnnotatorTypes: Array[String]

    Input annotator types: DOCUMENT

    Input annotator types: DOCUMENT

    Definition Classes
    Doc2ChunkHasInputAnnotationCols
  52. final val inputCols: StringArrayParam

    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
  53. val isArray: BooleanParam

    Whether the chunkCol is an array of strings (Default: false)

  54. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  57. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  58. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  59. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  66. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. val lowerCase: BooleanParam

    Whether to lower case for matching case (Default: true)

  71. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  75. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  76. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  77. val outputAnnotatorType: AnnotatorType

    Output annotator types: CHUNK

    Output annotator types: CHUNK

    Definition Classes
    Doc2ChunkHasOutputAnnotatorType
  78. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  79. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  80. var parent: Estimator[Doc2Chunk]
    Definition Classes
    Model
  81. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  82. def set[T](feature: StructFeature[T], value: T): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  83. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def set[T](feature: SetFeature[T], value: Set[T]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def set[T](feature: ArrayFeature[T], value: Array[T]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. final def set(paramPair: ParamPair[_]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    Params
  87. final def set(param: String, value: Any): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    Params
  88. final def set[T](param: Param[T], value: T): Doc2Chunk.this.type
    Definition Classes
    Params
  89. def setChunkCol(value: String): Doc2Chunk.this.type

    Column that contains string.

    Column that contains string. Must be part of DOCUMENT

  90. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. final def setDefault(paramPairs: ParamPair[_]*): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def setDefault[T](param: Param[T], value: T): Doc2Chunk.this.type
    Attributes
    protected
    Definition Classes
    Params
  96. def setFailOnMissing(value: Boolean): Doc2Chunk.this.type

    Whether to fail the job if a chunk is not found within document, return empty otherwise (Default: false)

  97. final def setInputCols(value: String*): Doc2Chunk.this.type
    Definition Classes
    HasInputAnnotationCols
  98. final def setInputCols(value: Array[String]): Doc2Chunk.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  99. def setIsArray(value: Boolean): Doc2Chunk.this.type

    Whether the chunkCol is an array of strings (Default: false)

  100. def setLowerCase(value: Boolean): Doc2Chunk.this.type

    Whether to lower case for matching case (Default: true)

  101. final def setOutputCol(value: String): Doc2Chunk.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  102. def setParent(parent: Estimator[Doc2Chunk]): Doc2Chunk
    Definition Classes
    Model
  103. def setStartCol(value: String): Doc2Chunk.this.type

    Column that has a reference of where the chunk begins

  104. def setStartColByTokenIndex(value: Boolean): Doc2Chunk.this.type

    Whether start col is by whitespace tokens (Default: false)

  105. val startCol: Param[String]

    Column that has a reference of where the chunk begins

  106. val startColByTokenIndex: BooleanParam

    Whether start col is by whitespace tokens (Default: false)

  107. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  108. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  109. def tokenIndexToCharIndex(text: String, tokenIndex: Int): Int
  110. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    Doc2Chunk → Transformer
  111. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  112. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  113. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  114. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  115. val uid: String
    Definition Classes
    Doc2Chunk → Identifiable
  116. def validate(schema: StructType): Boolean

    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
  117. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  120. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  121. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from RawAnnotator[Doc2Chunk]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[Doc2Chunk]

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

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters