Packages

class RelationExtractionDLModel extends nlp.annotators.re.RelationExtractionDLModel

Extracts and classifies instances of relations between named entities. In contrast with RelationExtractionModel, RelationExtractionDLModel is based on BERT. For pretrained models please see the Models Hub for available models.

Example

Relation Extraction between body parts

This is a continuation of the RENerChunksFilter example. See that class on how to extract the relation chunks. Define the extraction model

val re_ner_chunk_filter = new RENerChunksFilter()
 .setInputCols("ner_chunks", "dependencies")
 .setOutputCol("re_ner_chunks")
 .setMaxSyntacticDistance(4)
 .setRelationPairs(Array("internal_organ_or_component-direction"))

val re_model = RelationExtractionDLModel.pretrained("redl_bodypart_direction_biobert", "en", "clinical/models")
  .setPredictionThreshold(0.5f)
  .setInputCols("re_ner_chunks", "sentences")
  .setOutputCol("relations")

val trained_pipeline = new Pipeline().setStages(Array(
  documenter,
  sentencer,
  tokenizer,
  words_embedder,
  pos_tagger,
  clinical_ner_tagger,
  ner_chunker,
  dependency_parser,
  re_ner_chunk_filter,
  re_model
))

val data = Seq("MRI demonstrated infarction in the upper brain stem , left cerebellum and  right basil ganglia").toDF("text")
val result = trained_pipeline.fit(data).transform(data)

Show results

result.selectExpr("explode(relations) as relations")
 .select(
   "relations.metadata.chunk1",
   "relations.metadata.entity1",
   "relations.metadata.chunk2",
   "relations.metadata.entity2",
   "relations.result"
 )
 .where("result != 0")
 .show(truncate=false)
+------+---------+-------------+---------------------------+------+
|chunk1|entity1  |chunk2       |entity2                    |result|
+------+---------+-------------+---------------------------+------+
|upper |Direction|brain stem   |Internal_organ_or_component|1     |
|left  |Direction|cerebellum   |Internal_organ_or_component|1     |
|right |Direction|basil ganglia|Internal_organ_or_component|1     |
+------+---------+-------------+---------------------------+------+
See also

RelationExtractionModel for ML based extraction

RENerChunksFilter on how to create inputs

Linear Supertypes
nlp.annotators.re.RelationExtractionDLModel, CheckLicense, HasSafeAnnotate[nlp.annotators.re.RelationExtractionDLModel], HandleExceptionParams, HasEngine, RelationEncoding, HasSimpleAnnotate[nlp.annotators.re.RelationExtractionDLModel], HasCaseSensitiveProperties, HasStorageRef, WriteTensorflowModel, AnnotatorModel[nlp.annotators.re.RelationExtractionDLModel], CanBeLazy, RawAnnotator[nlp.annotators.re.RelationExtractionDLModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[nlp.annotators.re.RelationExtractionDLModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RelationExtractionDLModel
  2. RelationExtractionDLModel
  3. CheckLicense
  4. HasSafeAnnotate
  5. HandleExceptionParams
  6. HasEngine
  7. RelationEncoding
  8. HasSimpleAnnotate
  9. HasCaseSensitiveProperties
  10. HasStorageRef
  11. WriteTensorflowModel
  12. AnnotatorModel
  13. CanBeLazy
  14. RawAnnotator
  15. HasOutputAnnotationCol
  16. HasInputAnnotationCols
  17. HasOutputAnnotatorType
  18. ParamsAndFeaturesWritable
  19. HasFeatures
  20. DefaultParamsWritable
  21. MLWritable
  22. Model
  23. Transformer
  24. PipelineStage
  25. Logging
  26. Params
  27. Serializable
  28. Serializable
  29. Identifiable
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    RelationExtractionDLModelRelationExtractionDLModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. var batchSize: IntParam

    Size of the batches to process.

    Size of the batches to process.

    Definition Classes
    RelationExtractionDLModel
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    RelationExtractionDLModelRelationExtractionDLModel → AnnotatorModel
  15. var bertREConfig: BertREConfig
    Definition Classes
    RelationExtractionDLModel
  16. val caseSensitive: BooleanParam
    Definition Classes
    HasCaseSensitiveProperties
  17. def categorizeRelations(relations: Seq[DLRelationInstance]): Seq[(Int, Int, Float)]
    Attributes
    protected
    Definition Classes
    RelationExtractionDLModel
  18. var categoryNames: StringArrayParam

    List of relation names.

    List of relation names.

    Definition Classes
    RelationExtractionDLModel
  19. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  20. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  21. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  22. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  23. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  24. val classes: StringArrayParam

    Categorization classes

    Categorization classes

    Definition Classes
    RelationExtractionDLModel
  25. final def clear(param: Param[_]): RelationExtractionDLModel.this.type
    Definition Classes
    Params
  26. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. val configProtoBytes: IntArrayParam

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

    Definition Classes
    RelationExtractionDLModel
  28. def copy(extra: ParamMap): nlp.annotators.re.RelationExtractionDLModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  29. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  30. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  31. var customLabels: MapFeature[String, String]

    Custom relation labels

    Custom relation labels

    Definition Classes
    RelationExtractionDLModel
  32. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  33. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  34. val doExceptionHandling: BooleanParam

    If true, exceptions are handled.

    If true, exceptions are handled. If exception causing data is passed to the model, a error annotation is emitted which has the exception message. Processing continues with the next one. This comes with a performance penalty.

    Definition Classes
    HandleExceptionParams
  35. def encodeRelations(nerChunkAnnotations: Seq[Annotation], sentenceAnnotations: Seq[Annotation]): Seq[DLRelationInstance]
    Definition Classes
    RelationEncoding
  36. val engine: Param[String]
    Definition Classes
    HasEngine
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  40. def explainParams(): String
    Definition Classes
    Params
  41. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  42. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  43. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  44. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  45. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  46. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  47. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  48. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  49. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  50. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  51. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  52. def getBatchSize: Int

    Number of relations to process in a batch

    Number of relations to process in a batch

    Definition Classes
    RelationExtractionDLModel
  53. def getCaseSensitive: Boolean
    Definition Classes
    HasCaseSensitiveProperties
  54. def getCategories(): Array[String]

    Get all categories

    Get all categories

    Definition Classes
    RelationExtractionDLModel
  55. def getCategoryName(id: Int): String

    List of relation names

    List of relation names

    Definition Classes
    RelationExtractionDLModel
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. def getClasses: Array[String]

    Proxy to getCategories

    Proxy to getCategories

    Definition Classes
    RelationExtractionDLModel
  58. def getConfigProtoBytes: Option[Array[Byte]]

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

    Definition Classes
    RelationExtractionDLModel
  59. def getCustomLabel(label: String): String

    Gets the custom relation label for a given label.

    Gets the custom relation label for a given label.

    Definition Classes
    RelationExtractionDLModel
  60. def getCustomLabels: Map[String, String]

    Gets all custom relation labels.

    Gets all custom relation labels.

    Definition Classes
    RelationExtractionDLModel
  61. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  62. def getEngine: String
    Definition Classes
    HasEngine
  63. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  64. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  65. def getMaxSentenceLength: Int

    Max sentence length to process (Default : 128)

    Max sentence length to process (Default : 128)

    Definition Classes
    RelationExtractionDLModel
  66. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  67. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  68. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  69. def getPredictionThreshold: Float

    Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

    Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

    Definition Classes
    RelationExtractionDLModel
  70. def getRelationPairsCaseSensitive: Boolean

    Gets the case sensitivity of relation pairs

    Gets the case sensitivity of relation pairs

    Definition Classes
    RelationExtractionDLModel
  71. def getRelationTypePerPair: Map[String, Array[String]]

    Get the lists of entity pairs allowed for a given relation

    Get the lists of entity pairs allowed for a given relation

    Definition Classes
    RelationExtractionDLModel
  72. def getRelationTypePerPairStr: String

    Get a string representation of the lists of entity pairs allowed for a given relation

    Get a string representation of the lists of entity pairs allowed for a given relation

    Definition Classes
    RelationExtractionDLModel
  73. def getStorageRef: String
    Definition Classes
    HasStorageRef
  74. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  75. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  76. def hasParent: Boolean
    Definition Classes
    Model
  77. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  78. val inExceptionMode: Boolean
    Attributes
    protected
    Definition Classes
    HasSafeAnnotate
  79. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  80. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator types : CHUNK, DOCUMENT

    Input annotator types : CHUNK, DOCUMENT

    Definition Classes
    RelationExtractionDLModel → HasInputAnnotationCols
  82. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  83. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  84. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  85. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  86. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  87. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  88. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  89. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  96. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  99. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. val maxSentenceLength: IntParam

    Max sentence length to process (Default : 128)

    Max sentence length to process (Default : 128)

    Definition Classes
    RelationExtractionDLModel
  101. def model: TensorflowBertRE
    Definition Classes
    RelationExtractionDLModel
  102. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  103. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  104. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  105. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  106. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    RelationExtractionDLModel → ParamsAndFeaturesWritable
  107. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  108. val outputAnnotatorType: String

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

    Definition Classes
    RelationExtractionDLModel → HasOutputAnnotatorType
  109. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  110. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  111. var parent: Estimator[nlp.annotators.re.RelationExtractionDLModel]
    Definition Classes
    Model
  112. var predictionThreshold: FloatParam

    Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

    Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

    Definition Classes
    RelationExtractionDLModel
  113. var relationPairsCaseSensitive: BooleanParam

    Determines whether relation pairs are case sensitive

    Determines whether relation pairs are case sensitive

    Definition Classes
    RelationExtractionDLModel
  114. def safeAnnotate(annotations: Seq[Annotation]): Seq[Annotation]

    A protected method designed to safely annotate a sequence of Annotation objects by handling exceptions.

    A protected method designed to safely annotate a sequence of Annotation objects by handling exceptions.

    annotations

    A sequence of Annotation.

    returns

    A sequence of Annotation objects after processing, potentially containing error annotations.

    Attributes
    protected
    Definition Classes
    HasSafeAnnotate
  115. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  116. def set[T](feature: StructFeature[T], value: T): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  117. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  118. def set[T](feature: SetFeature[T], value: Set[T]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  119. def set[T](feature: ArrayFeature[T], value: Array[T]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  120. final def set(paramPair: ParamPair[_]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  121. final def set(param: String, value: Any): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  122. final def set[T](param: Param[T], value: T): RelationExtractionDLModel.this.type
    Definition Classes
    Params
  123. def setBatchSize(size: Int): RelationExtractionDLModel.this.type

    Set the number of relations to process in a batch.

    Set the number of relations to process in a batch. Using a larger value speeds up processing but requires more memory.

    Definition Classes
    RelationExtractionDLModel
  124. def setCaseSensitive(value: Boolean): RelationExtractionDLModel.this.type
    Definition Classes
    HasCaseSensitiveProperties
  125. def setCategoryNames(categoryNames: Array[String]): RelationExtractionDLModel.this.type

    List of relation names

    List of relation names

    Definition Classes
    RelationExtractionDLModel
  126. def setConfigProtoBytes(bytes: Array[Int]): RelationExtractionDLModel.this.type

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

    Definition Classes
    RelationExtractionDLModel
  127. def setCustomLabels(labels: HashMap[String, String]): RelationExtractionDLModel.this.type

    Definition Classes
    RelationExtractionDLModel
  128. def setCustomLabels(labels: Map[String, String]): RelationExtractionDLModel.this.type

    Set custom relation labels

    Set custom relation labels

    Definition Classes
    RelationExtractionDLModel
  129. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  130. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  131. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  132. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  133. final def setDefault(paramPairs: ParamPair[_]*): RelationExtractionDLModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  134. final def setDefault[T](param: Param[T], value: T): RelationExtractionDLModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  135. def setDoExceptionHandling(value: Boolean): RelationExtractionDLModel.this.type

    If true, exceptions are handled.

    If true, exceptions are handled. If exception causing data is passed to the model, a error annotation is emitted which has the exception message. Processing continues with the next one. This comes with a performance penalty.

    Definition Classes
    HandleExceptionParams
  136. final def setInputCols(value: String*): RelationExtractionDLModel.this.type
    Definition Classes
    HasInputAnnotationCols
  137. def setInputCols(value: Array[String]): RelationExtractionDLModel.this.type
    Definition Classes
    HasInputAnnotationCols
  138. def setLazyAnnotator(value: Boolean): RelationExtractionDLModel.this.type
    Definition Classes
    CanBeLazy
  139. def setMaxSentenceLength(value: Int): RelationExtractionDLModel.this.type

    Max sentence length to process (Default : 128)

    Max sentence length to process (Default : 128)

    Definition Classes
    RelationExtractionDLModel
  140. final def setOutputCol(value: String): RelationExtractionDLModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  141. def setParent(parent: Estimator[nlp.annotators.re.RelationExtractionDLModel]): nlp.annotators.re.RelationExtractionDLModel
    Definition Classes
    Model
  142. def setPredictionThreshold(predictionThreshold: Float): RelationExtractionDLModel.this.type

    Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

    Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

    Definition Classes
    RelationExtractionDLModel
  143. def setRelationPairsCaseSensitive(value: Boolean): RelationExtractionDLModel.this.type

    Sets the case sensitivity of relation pairs

    Sets the case sensitivity of relation pairs

    Definition Classes
    RelationExtractionDLModel
  144. def setRelationTypePerPair(categories: HashMap[String, List[String]]): RelationExtractionDLModel.this.type

    Set the lists of entity pairs allowed for a given relation

    Set the lists of entity pairs allowed for a given relation

    Definition Classes
    RelationExtractionDLModel
  145. def setRelationTypePerPair(categories: Map[String, Array[String]]): RelationExtractionDLModel.this.type

    Set the lists of entity pairs allowed for a given relation

    Set the lists of entity pairs allowed for a given relation

    Definition Classes
    RelationExtractionDLModel
  146. def setStorageRef(value: String): RelationExtractionDLModel.this.type
    Definition Classes
    HasStorageRef
  147. def setTensorflowModel(spark: SparkSession, tf: TensorflowWrapper): RelationExtractionDLModel.this.type
    Definition Classes
    RelationExtractionDLModel
  148. def setVocabulary(value: Map[String, Int]): RelationExtractionDLModel.this.type

    Vocabulary used to encode words to ids with WordPieceEncoder

    Vocabulary used to encode words to ids with WordPieceEncoder

    Definition Classes
    RelationExtractionDLModel
  149. val storageRef: Param[String]
    Definition Classes
    HasStorageRef
  150. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  151. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  152. def tokenizeSentence(sentence: Sentence): WordpieceTokenizedSentence
    Definition Classes
    RelationExtractionDLModel
  153. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  154. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  155. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  156. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  157. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  158. val uid: String
    Definition Classes
    RelationExtractionDLModelRelationExtractionDLModel → Identifiable
  159. def updateBertConfig: Unit
    Definition Classes
    RelationExtractionDLModel
  160. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  161. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  162. val vocabulary: MapFeature[String, Int]

    Vocabulary used to encode words to ids with WordPieceEncoder

    Vocabulary used to encode words to ids with WordPieceEncoder

    Definition Classes
    RelationExtractionDLModel
  163. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  164. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  165. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  166. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  167. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  168. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String): Unit
    Definition Classes
    WriteTensorflowModel
  169. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit
    Definition Classes
    WriteTensorflowModel
  170. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]], savedSignatures: Option[Map[String, String]]): Unit
    Definition Classes
    WriteTensorflowModel

Inherited from CheckLicense

Inherited from HandleExceptionParams

Inherited from HasEngine

Inherited from RelationEncoding

Inherited from HasSimpleAnnotate[nlp.annotators.re.RelationExtractionDLModel]

Inherited from HasCaseSensitiveProperties

Inherited from HasStorageRef

Inherited from WriteTensorflowModel

Inherited from AnnotatorModel[nlp.annotators.re.RelationExtractionDLModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[nlp.annotators.re.RelationExtractionDLModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

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

Parameter getters