Packages

class ChunkMergeModel extends AnnotatorModel[ChunkMergeModel] with CheckLicense with HasSimpleAnnotate[ChunkMergeModel]

Merges entities coming from different CHUNK annotations

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

Instance Constructors

  1. new ChunkMergeModel()
  2. new ChunkMergeModel(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]

    Merges columns of chunk Annotations while considering false positives and replacements.

    Merges columns of chunk Annotations while considering false positives and replacements.

    annotations

    a Sequence of chunks to merge

    returns

    a Sequence of Merged CHUNK Annotations

    Definition Classes
    ChunkMergeModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    ChunkMergeModel → AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkValidEnvironment(spark: Option[SparkContext]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkContext], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  18. val chunkPrecedence: Param[String]

    Select what is the priorization when one chunk has the same start and end chunk.Possibles values [entity|identifier|field]

  19. final def clear(param: Param[_]): ChunkMergeModel.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): ChunkMergeModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  22. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  28. def explainParams(): String
    Definition Classes
    Params
  29. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  32. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  33. val falsePositives: ArrayFeature[(String, String, String)]

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

  34. lazy val falsePositivesArray: Array[(String, String, String)]
  35. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getFalsePositives: Array[(String, String, String)]

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

  45. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  46. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  47. def getMergeOverlapping: Boolean

    whether to merge overlapping matched chunks.

  48. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  49. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  50. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  51. def getReplaceDict: Map[String, String]

    Mapping of replacement strings for entities.

  52. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  53. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  54. def hasParent: Boolean
    Definition Classes
    Model
  55. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  57. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. val inputAnnotatorTypes: Array[AnnotatorType]

    Output annotator types: CHUNK, CHUNK

    Output annotator types: CHUNK, CHUNK

    Definition Classes
    ChunkMergeModel → HasInputAnnotationCols
  59. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  60. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. def isLp(): Boolean
    Definition Classes
    CheckLicense
  63. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  64. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  65. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  66. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  67. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  74. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. val mergeOverlapping: BooleanParam

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks. Defaults to true

  79. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  80. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  81. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  84. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  85. val outputAnnotatorType: AnnotatorType

    Input annotator types: CHUNK

    Input annotator types: CHUNK

    Definition Classes
    ChunkMergeModel → HasOutputAnnotatorType
  86. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  87. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  88. var parent: Estimator[ChunkMergeModel]
    Definition Classes
    Model
  89. val possibleEntityFields: Array[String]
  90. val replaceDict: MapFeature[String, String]

    Mapping of replacement strings for entities.

  91. lazy val replaceDictMap: Map[String, String]
  92. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  93. def set[T](feature: StructFeature[T], value: T): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def set[T](feature: SetFeature[T], value: Set[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def set[T](feature: ArrayFeature[T], value: Array[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. final def set(paramPair: ParamPair[_]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  98. final def set(param: String, value: Any): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  99. final def set[T](param: Param[T], value: T): ChunkMergeModel.this.type
    Definition Classes
    Params
  100. def setChunkPrecedence(m: String): ChunkMergeModel.this.type

    Select what is the priorization when two chunks have the same start and end indices.Possibles values [entity|identifier|field]

  101. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. final def setDefault(paramPairs: ParamPair[_]*): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  106. final def setDefault[T](param: Param[T], value: T): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  107. def setFalsePositives(value: Array[(String, String, String)]): ChunkMergeModel.this.type

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

  108. final def setInputCols(value: String*): ChunkMergeModel.this.type
    Definition Classes
    HasInputAnnotationCols
  109. final def setInputCols(value: Array[String]): ChunkMergeModel.this.type
    Definition Classes
    HasInputAnnotationCols
  110. def setLazyAnnotator(value: Boolean): ChunkMergeModel.this.type
    Definition Classes
    CanBeLazy
  111. def setMergeOverlapping(v: Boolean): ChunkMergeModel.this.type

    whether to merge overlapping matched chunks.

  112. final def setOutputCol(value: String): ChunkMergeModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  113. def setParent(parent: Estimator[ChunkMergeModel]): ChunkMergeModel
    Definition Classes
    Model
  114. def setReplaceDict(value: Map[String, String]): ChunkMergeModel.this.type

    Mapping of replacement strings for entities.

  115. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  116. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  117. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  118. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  119. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  120. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  121. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  122. val uid: String
    Definition Classes
    ChunkMergeModel → Identifiable
  123. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  124. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  127. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  128. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[ChunkMergeModel]

Inherited from CheckLicense

Inherited from AnnotatorModel[ChunkMergeModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[ChunkMergeModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ChunkMergeModel]

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

Parameter getters