Packages

class DocumentAssembler extends Transformer with DefaultParamsWritable with HasOutputAnnotatorType with HasOutputAnnotationCol

Prepares data into a format that is processable by Spark NLP. This is the entry point for every Spark NLP pipeline. The DocumentAssembler reads String columns. Additionally, setCleanupMode can be used to pre-process the text (Default: disabled). For possible options please refer to the parameters section.

For more extended examples on document pre-processing see the Examples.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.DocumentAssembler

val data = Seq("Spark NLP is an open-source text processing library.").toDF("text")
val documentAssembler = new DocumentAssembler().setInputCol("text").setOutputCol("document")

val result = documentAssembler.transform(data)

result.select("document").show(false)
+----------------------------------------------------------------------------------------------+
|document                                                                                      |
+----------------------------------------------------------------------------------------------+
|[[document, 0, 51, Spark NLP is an open-source text processing library., [sentence -> 0], []]]|
+----------------------------------------------------------------------------------------------+

result.select("document").printSchema
root
 |-- document: array (nullable = true)
 |    |-- element: struct (containsNull = true)
 |    |    |-- annotatorType: string (nullable = true)
 |    |    |-- begin: integer (nullable = false)
 |    |    |-- end: integer (nullable = false)
 |    |    |-- result: string (nullable = true)
 |    |    |-- metadata: map (nullable = true)
 |    |    |    |-- key: string
 |    |    |    |-- value: string (valueContainsNull = true)
 |    |    |-- embeddings: array (nullable = true)
 |    |    |    |-- element: float (containsNull = false)
Linear Supertypes
HasOutputAnnotationCol, HasOutputAnnotatorType, DefaultParamsWritable, MLWritable, Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DocumentAssembler
  2. HasOutputAnnotationCol
  3. HasOutputAnnotatorType
  4. DefaultParamsWritable
  5. MLWritable
  6. Transformer
  7. PipelineStage
  8. Logging
  9. Params
  10. Serializable
  11. Identifiable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DocumentAssembler()
  2. new DocumentAssembler(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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val EMPTY_STR: String
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val cleanupMode: Param[String]

    cleanupMode can take the following values:

    cleanupMode can take the following values:

    • disabled: keep original. Useful if need to head back to source later
    • inplace: newlines and tabs into whitespaces, not stringified ones, don't trim
    • inplace_full: newlines and tabs into whitespaces, including stringified, don't trim
    • shrink: all whitespaces, newlines and tabs to a single whitespace, but not stringified, do trim
    • shrink_full: all whitespaces, newlines and tabs to a single whitespace, stringified ones too, trim all
    • each: newlines and tabs to one whitespace each
    • each_full: newlines and tabs, stringified ones too, to one whitespace each
    • delete_full: remove stringified newlines and tabs (replace with nothing)
  8. final def clear(param: Param[_]): DocumentAssembler.this.type
    Definition Classes
    Params
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def copy(extra: ParamMap): Transformer
    Definition Classes
    DocumentAssembler → Transformer → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  12. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  16. def explainParams(): String
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  19. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def getCleanupMode: String

    cleanupMode to pre-process text

  22. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  23. def getIdCol: String

    Id column for row reference

  24. def getInputCol: String

    Input text column for processing

  25. def getMetadataCol: String

    Metadata for document column

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

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  28. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  29. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  30. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. val idCol: Param[String]

    Id column for row reference

  33. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  34. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. val inputCol: Param[String]

    Input text column for processing

  36. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  39. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  40. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  41. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  48. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. val metadataCol: Param[String]

    Metadata for document column

  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  56. val outputAnnotatorType: AnnotatorType

    Output Annotator Type: DOCUMENT

    Output Annotator Type: DOCUMENT

    Definition Classes
    DocumentAssembler → HasOutputAnnotatorType
  57. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  58. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  59. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @throws("If the input path already exists but overwrite is not enabled.") @Since("1.6.0")
  60. final def set(paramPair: ParamPair[_]): DocumentAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  61. final def set(param: String, value: Any): DocumentAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  62. final def set[T](param: Param[T], value: T): DocumentAssembler.this.type
    Definition Classes
    Params
  63. def setCleanupMode(v: String): DocumentAssembler.this.type

    cleanupMode to pre-process text

  64. final def setDefault(paramPairs: ParamPair[_]*): DocumentAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  65. final def setDefault[T](param: Param[T], value: T): DocumentAssembler.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  66. def setIdCol(value: String): DocumentAssembler.this.type

    Id column for row reference

  67. def setInputCol(value: String): DocumentAssembler.this.type

    Input text column for processing

  68. def setMetadataCol(value: String): DocumentAssembler.this.type

    Metadata for document column

  69. final def setOutputCol(value: String): DocumentAssembler.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  70. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  71. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  72. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    DocumentAssembler → Transformer
  73. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since("2.0.0")
  74. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @varargs() @Since("2.0.0")
  75. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    DocumentAssembler → PipelineStage
  76. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  77. val uid: String
    Definition Classes
    DocumentAssembler → Identifiable
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  80. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  81. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from HasOutputAnnotationCol

Inherited from HasOutputAnnotatorType

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

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