Packages

class AssertionChunkConverter extends Transformer with DefaultParamsWritable with HasInputAnnotationCols with HasOutputAnnotationCol with HasOutputAnnotatorType with HasFeatures with CheckLicense

Creates a chunk column with metadata for training assertion status detection models.

In some cases, there may be issues while creating the chunk column when using token indices that can lead to loss of data to train assertion status models. The AssertionChunkConverter annotator uses both begin and end indices of the tokens as input to add a more robust metadata to the chunk column in a way that improves the reliability of the indices and avoid loss of data.

Notes

Chunk begin and end indices in the assertion status model training dataframe can be populated using the new version of ALAB module.

Example

Define the stages of the pipeline

val document = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")
val sentenceDetector = new SentenceDetector()
  .setInputCols("document")
  .setOutputCol("sentence")
val tokenizer = new Tokenizer()
  .setInputCols("sentence")
  .setOutputCol("token")
val converter  = new AssertionChunkConverter()
  .setInputCols("tokens")
  .setChunkTextCol("target")
  .setChunkBeginCol("char_begin")
  .setChunkEndCol("char_end")
  .setOutputTokenBeginCol("token_begin")
  .setOutputTokenEndCol("token_end")
  .setOutputCol("chunk")

Define the pipeline and obtain the results

val pipeline = new Pipeline().setStages(Array(
  document,
  sentenceDetector,
  tokenizer,
  converter
))

results = pipeline.fit(data).transform(data)
Linear Supertypes
CheckLicense, HasFeatures, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, DefaultParamsWritable, MLWritable, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AssertionChunkConverter
  2. CheckLicense
  3. HasFeatures
  4. HasOutputAnnotatorType
  5. HasOutputAnnotationCol
  6. HasInputAnnotationCols
  7. DefaultParamsWritable
  8. MLWritable
  9. Transformer
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    a unique identifier for the instantiated AnnotatorModel

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. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  12. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  13. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  14. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  15. val chunkBeginCol: Param[String]

    Name of the column containing the start index of the chunk

  16. val chunkEndCol: Param[String]

    Name of the column containing the end index of the chunk

  17. val chunkTextCol: Param[String]

    Name of the column containing the text chunk

  18. final def clear(param: Param[_]): AssertionChunkConverter.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def copy(extra: ParamMap): AssertionChunkConverter
    Definition Classes
    AssertionChunkConverter → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  26. def explainParams(): String
    Definition Classes
    Params
  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. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  40. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  41. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  42. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  43. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  44. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. val inputAnnotatorTypes: Array[String]

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Definition Classes
    AssertionChunkConverter → HasInputAnnotationCols
  48. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  49. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  50. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  51. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  52. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  53. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. val metadataFields: MapFeature[String, String]

    Add the specified data to the metadata fields of the chunk outputs in the appropriate columns.

    Add the specified data to the metadata fields of the chunk outputs in the appropriate columns. First element of the tuple is the column name to read the data from, and the second element is the name of the metadata field. The given column names must be present in the DataFrame and must be of StringType. Default: Map.empty

  66. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  67. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  71. val outputAnnotatorType: AnnotatorType

    Output Annotator Type : CHUNK

    Output Annotator Type : CHUNK

    Definition Classes
    AssertionChunkConverter → HasOutputAnnotatorType
  72. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  73. val outputTokenBeginCol: Param[String]

    Name of the column containing selected token start

  74. val outputTokenEndCol: Param[String]

    Name of the column containing selected token end index

  75. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  76. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  77. def set[T](feature: StructFeature[T], value: T): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  78. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  79. def set[T](feature: SetFeature[T], value: Set[T]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  80. def set[T](feature: ArrayFeature[T], value: Array[T]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  81. final def set(paramPair: ParamPair[_]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  82. final def set(param: String, value: Any): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  83. final def set[T](param: Param[T], value: T): AssertionChunkConverter.this.type
    Definition Classes
    Params
  84. def setChunkBeginCol(col: String): AssertionChunkConverter.this.type

    Sets the name of the column containing the start of the chunk

  85. def setChunkEndCol(col: String): AssertionChunkConverter.this.type

    Sets the name of the column containing the end of the chunk

  86. def setChunkTextCol(col: String): AssertionChunkConverter.this.type

    Sets the name of the column containing the text chunk

  87. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. final def setDefault(paramPairs: ParamPair[_]*): AssertionChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def setDefault[T](param: Param[T], value: T): AssertionChunkConverter.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  93. final def setInputCols(value: String*): AssertionChunkConverter.this.type
    Definition Classes
    HasInputAnnotationCols
  94. def setInputCols(value: Array[String]): AssertionChunkConverter.this.type
    Definition Classes
    HasInputAnnotationCols
  95. def setMetadataFields(value: HashMap[String, String]): AssertionChunkConverter.this.type
  96. def setMetadataFields(value: Map[String, String]): AssertionChunkConverter.this.type

    Sets the value of metadataFields.

    Sets the value of metadataFields. Add the specified data to the metadata fields of the chunk outputs in the appropriate columns. First element of the tuple is the column name to read the data from, and the second element is the name of the metadata field. The given column names must be present in the DataFrame and must be of StringType. Default: Map.empty

  97. final def setOutputCol(value: String): AssertionChunkConverter.this.type
    Definition Classes
    HasOutputAnnotationCol
  98. def setOutputTokenBeginCol(col: String): AssertionChunkConverter.this.type

    Sets the name of the column containing selected token start

  99. def setOutputTokenEndCol(col: String): AssertionChunkConverter.this.type

    Sets the name of the column containing selected token end

  100. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  101. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  102. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AssertionChunkConverter → Transformer
  103. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  104. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  105. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AssertionChunkConverter → PipelineStage
  106. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  107. val uid: String
    Definition Classes
    AssertionChunkConverter → Identifiable
  108. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  111. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from HasFeatures

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from DefaultParamsWritable

Inherited from MLWritable

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

Annotator types

Required input and expected output annotator types

Members

Parameter setters