Packages

class AssertionDLApproach extends AnnotatorApproach[AssertionDLModel] with Logging with CheckLicense

Contains all the methods for training an AssertionDLModel. For pretrained models please use AssertionDLModel and see the Models Hub for available models.

Example

First, pipeline stages for pre-processing the dataset (containing columns for text and label) are defined.

val document = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")
val chunk = new Doc2Chunk()
  .setInputCols("document")
  .setOutputCol("chunk")
val token = new Tokenizer()
  .setInputCols("document")
  .setOutputCol("token")
val embeddings = WordEmbeddingsModel.pretrained("embeddings_clinical", "en", "clinical/models")
  .setInputCols("document", "token")
  .setOutputCol("embeddings")

Define AssertionDLApproach with parameters and start training

val assertionStatus = new AssertionDLApproach()
  .setLabelCol("label")
  .setInputCols("document", "chunk", "embeddings")
  .setOutputCol("assertion")
  .setBatchSize(128)
  .setDropout(0.012f)
  .setLearningRate(0.015f)
  .setEpochs(1)
  .setStartCol("start")
  .setEndCol("end")
  .setMaxSentLen(250)

val trainingPipeline = new Pipeline().setStages(Array(
  document,
  chunk,
  token,
  embeddings,
  assertionStatus
))

val assertionModel = trainingPipeline.fit(data)
val assertionResults = assertionModel.transform(data).cache()
See also

AssertionDLModel for using pretrained models

AssertionLogRegModel for non deep learning based extraction

Linear Supertypes
CheckLicense, Logging, AnnotatorApproach[AssertionDLModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[AssertionDLModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AssertionDLApproach
  2. CheckLicense
  3. Logging
  4. AnnotatorApproach
  5. CanBeLazy
  6. DefaultParamsWritable
  7. MLWritable
  8. HasOutputAnnotatorType
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. Estimator
  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 AssertionDLApproach()
  2. new AssertionDLApproach(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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): AssertionDLModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val batchSize: IntParam

    Size for each batch in the optimization process (Default: 64)

  8. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  9. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  10. def checkValidEnvironment(spark: Option[SparkContext]): Unit
    Definition Classes
    CheckLicense
  11. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  12. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkContext], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  13. val chunkCol: Param[String]

    Column with extracted NER chunks

  14. final def clear(param: Param[_]): AssertionDLApproach.this.type
    Definition Classes
    Params
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. val configProtoBytes: IntArrayParam

    ConfigProto from tensorflow, serialized into byte array.

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

  17. final def copy(extra: ParamMap): Estimator[AssertionDLModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. val description: String
    Definition Classes
    AssertionDLApproach → AnnotatorApproach
  21. val dropout: FloatParam

    Dropout at the output of each layer (Default: 0.05f)

  22. val enableOutputLogs: BooleanParam

    Whether to output to annotators log folder (Default: false)

  23. val endCol: Param[String]

    Column with token number for last target token

  24. val epochs: IntParam

    Number of epochs for the optimization process (Default: 5)

  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. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  30. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. final def fit(dataset: Dataset[_]): AssertionDLModel
    Definition Classes
    AnnotatorApproach → Estimator
  33. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[AssertionDLModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  34. def fit(dataset: Dataset[_], paramMap: ParamMap): AssertionDLModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  35. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): AssertionDLModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  36. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. def getConfigProtoBytes: Option[Array[Byte]]

    ConfigProto from tensorflow, serialized into byte array.

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

  39. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  40. def getEnableOutputLogs: Boolean

    Whether to output to annotators log folder

  41. def getIncludeConfidence: Boolean

    whether to include confidence scores in annotation metadata

  42. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  43. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  44. def getLogName: String
    Definition Classes
    Logging
  45. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  46. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  47. def getOutputLogsPath: String

    Folder path to save training logs

  48. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  49. val graphFolder: Param[String]

    Folder path that contain external graph files

  50. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  51. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  52. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. val includeConfidence: BooleanParam

    Whether to include confidence scores in annotation metadata

  54. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  55. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. val inputAnnotatorTypes: Array[String]

    Input Annotator Types: DOCUMENT, CHUNK, WORD_EMBEDDINGS

    Input Annotator Types: DOCUMENT, CHUNK, WORD_EMBEDDINGS

    Definition Classes
    AssertionDLApproach → HasInputAnnotationCols
  57. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  58. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. def isLp(): Boolean
    Definition Classes
    CheckLicense
  61. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  62. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  63. val labelCol: Param[String]

    Column with one label per document.

    Column with one label per document. Example of possible values: “present”, “absent”, “hypothetical”, “conditional”, “associated_with_other_person”, etc.

  64. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  65. val learningRate: FloatParam

    Learning rate for the optimization process (Default: 0.0012f)

  66. def log(value: ⇒ String, minLevel: Level): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  68. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  75. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. val logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  80. val maxSentLen: IntParam

    Max possible length of a sentence, must match graph model (Default: 250)

  81. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. def onTrained(model: AssertionDLModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  86. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  87. val outputAnnotatorType: AnnotatorType

    Output annotator type: ASSERTION

    Output annotator type: ASSERTION

    Definition Classes
    AssertionDLApproach → HasOutputAnnotatorType
  88. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  89. def outputLog(value: ⇒ String, uuid: String, shouldLog: Boolean, outputLogsPath: String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. val outputLogsPath: Param[String]

    Folder path to save training logs

  91. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  92. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  93. final def set(paramPair: ParamPair[_]): AssertionDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. final def set(param: String, value: Any): AssertionDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def set[T](param: Param[T], value: T): AssertionDLApproach.this.type
    Definition Classes
    Params
  96. def setBatchSize(size: Int): AssertionDLApproach.this.type

    Size for each batch in the optimization process

  97. def setChunkCol(c: String): AssertionDLApproach.this.type

    Column with extracted NER chunks

  98. def setConfigProtoBytes(bytes: Array[Int]): AssertionDLApproach.this.type

    ConfigProto from tensorflow, serialized into byte array.

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

  99. final def setDefault(paramPairs: ParamPair[_]*): AssertionDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def setDefault[T](param: Param[T], value: T): AssertionDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. def setDropout(factor: Float): AssertionDLApproach.this.type

    Dropout at the output of each layer

  102. def setEnableOutputLogs(v: Boolean): AssertionDLApproach.this.type

    Whether to output to annotators log folder

  103. def setEndCol(e: String): AssertionDLApproach.this.type

    Column with token number for last target token

  104. def setEpochs(number: Int): AssertionDLApproach.this.type

    Number of epochs for the optimization process

  105. def setGraphFolder(path: String): AssertionDLApproach.this.type

    Folder path that contain external graph files

  106. def setIncludeConfidence(value: Boolean): AssertionDLApproach.this.type

    Whether to include confidence scores in annotation metadata

  107. final def setInputCols(value: String*): AssertionDLApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  108. final def setInputCols(value: Array[String]): AssertionDLApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  109. def setLabelCol(label: String): AssertionDLApproach.this.type

    Column with one label per document

  110. def setLazyAnnotator(value: Boolean): AssertionDLApproach.this.type
    Definition Classes
    CanBeLazy
  111. def setLearningRate(rate: Float): AssertionDLApproach.this.type

    Learning rate for the optimization process

  112. def setMaxSentLen(len: Int): AssertionDLApproach.this.type

    Max possible length of a sentence, must match graph model

  113. final def setOutputCol(value: String): AssertionDLApproach.this.type
    Definition Classes
    HasOutputAnnotationCol
  114. def setOutputLogsPath(v: String): AssertionDLApproach.this.type

    Folder path to save training logs

  115. def setStartCol(s: String): AssertionDLApproach.this.type

    Column with token number for first target token

  116. def setValidationSplit(validationSplit: Float): AssertionDLApproach.this.type

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  117. def setVerbose(verbose: Level): AssertionDLApproach.this.type

    Level of verbosity during training

  118. val startCol: Param[String]

    Column with token number for first target token

  119. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  120. val testDataset: ExternalResourceParam

    Path to test dataset.

    Path to test dataset. If set used to calculate statistic on it during training

  121. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  122. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): AssertionDLModel

    Trains the dataset with recursive pipeline and uses methods trainWithChunk() and trainwithStartEnd() The choice of training happens based on the startCol value of the DL Approach

    Trains the dataset with recursive pipeline and uses methods trainWithChunk() and trainwithStartEnd() The choice of training happens based on the startCol value of the DL Approach

    dataset

    a collection of inputs to train

    recursivePipeline

    an instance of PipelineModel

    returns

    an instance of trained AssertionDLModel

    Definition Classes
    AssertionDLApproach → AnnotatorApproach
  123. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AnnotatorApproach → PipelineStage
  124. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  125. val uid: String
    Definition Classes
    AssertionDLApproach → Identifiable
  126. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  127. val validationSplit: FloatParam

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  128. val verbose: IntParam

    Level of verbosity during training

  129. val verboseLevel: Level
    Definition Classes
    AssertionDLApproach → Logging
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  133. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from Logging

Inherited from AnnotatorApproach[AssertionDLModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[AssertionDLModel]

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