Class/Object

com.johnsnowlabs.nlp.annotators.assertion.dl

AssertionDLModel

Related Docs: object AssertionDLModel | package dl

Permalink

class AssertionDLModel extends AnnotatorModel[AssertionDLModel] with WriteTensorflowModel with HasStorageRef with ParamsAndFeaturesWritable with Licensed

This is a main class in AssertionDL family. It contains all the parameters and main point of interest method annotate() which applies functionality from AssertionAnnotationWithLabel This class extends the AnnotatorModel by overriding method annotate()

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

Instance Constructors

  1. new AssertionDLModel()

    Permalink
  2. new AssertionDLModel(uid: String)

    Permalink

    uid

    a unique identifier for the instanced AnnotatorModel

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    This is main point of interest.

    This is main point of interest. It annotates the input dataset applying properties of the class above This method utilises chunk groups, word piece embeddings and conversion to chunk indexes

    annotations

    a sequence of Annotations

    returns

    a sequence of projected Annotations

    Definition Classes
    AssertionDLModel → AnnotatorModel
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. val batchSize: IntParam

    Permalink

    Parameter, which regulates the size of the batch

  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink

    This method validates the dataset before annotation

    This method validates the dataset before annotation

    dataset

    a collection of inputs to validate

    returns

    a Dataset after validation

    Attributes
    protected
    Definition Classes
    AssertionDLModel → AnnotatorModel
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. val classes: StringArrayParam

    Permalink

    List of classes used to train the model

  17. final def clear(param: Param[_]): AssertionDLModel.this.type

    Permalink
    Definition Classes
    Params
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. val configProtoBytes: IntArrayParam

    Permalink

    This is a collection of parameters to use with protobuff protocol

  20. def copy(extra: ParamMap): AssertionDLModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    AssertionDLModel → RawAnnotator → Model → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef
  23. val datasetParams: StructFeature[DatasetEncoderParams]

    Permalink

    Collection of Parameters, which are used by method annotate()

  24. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  25. def dfAnnotate: UserDefinedFunction

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  26. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  28. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  29. def explainParams(): String

    Permalink
    Definition Classes
    Params
  30. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. def extraValidateMsg: String

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  33. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  34. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. def getClasses: Array[String]

    Permalink

    get the tags used to trained this NerDLModel

  43. def getConfigProtoBytes: Option[Array[Byte]]

    Permalink
  44. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  45. def getIncludeConfidence: Boolean

    Permalink

    whether to include confidence scores in annotation metadata

  46. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  47. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  48. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  49. final def getOutputCol: String

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  50. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  51. def getStorageRef: String

    Permalink
    Definition Classes
    HasStorageRef
  52. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  53. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  54. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  55. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  56. val includeConfidence: BooleanParam

    Permalink
  57. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. val inputAnnotatorTypes: Array[String]

    Permalink
    Definition Classes
    AssertionDLModel → HasInputAnnotationCols
  60. final val inputCols: StringArrayParam

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  61. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  62. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  63. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  64. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  66. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  77. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  78. val maxSentLen: IntParam

    Permalink

    Parameter, which regulates the length of the longest sentence

  79. def model: TensorflowAssertion

    Permalink
  80. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  81. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  82. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  83. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  84. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AssertionDLModel → ParamsAndFeaturesWritable
  85. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    AssertionDLModel → HasOutputAnnotatorType
  86. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  87. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  88. var parent: Estimator[AssertionDLModel]

    Permalink
    Definition Classes
    Model
  89. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  90. def set[T](feature: StructFeature[T], value: T): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def set[T](feature: SetFeature[T], value: Set[T]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def set[T](feature: ArrayFeature[T], value: Array[T]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. final def set(paramPair: ParamPair[_]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  95. final def set(param: String, value: Any): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  96. final def set[T](param: Param[T], value: T): AssertionDLModel.this.type

    Permalink
    Definition Classes
    Params
  97. def setBatchSize(size: Int): AssertionDLModel.this.type

    Permalink
  98. def setConfigProtoBytes(bytes: Array[Int]): AssertionDLModel

    Permalink
  99. def setDatasetParams(params: DatasetEncoderParams): AssertionDLModel

    Permalink
  100. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. final def setDefault(paramPairs: ParamPair[_]*): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  105. final def setDefault[T](param: Param[T], value: T): AssertionDLModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  106. def setIncludeConfidence(value: Boolean): AssertionDLModel.this.type

    Permalink

    whether to include confidence scores in annotation metadata

  107. final def setInputCols(value: String*): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  108. final def setInputCols(value: Array[String]): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  109. def setLazyAnnotator(value: Boolean): AssertionDLModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  110. def setMaxSentLen(len: Int): AssertionDLModel.this.type

    Permalink
  111. final def setOutputCol(value: String): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  112. def setParent(parent: Estimator[AssertionDLModel]): AssertionDLModel

    Permalink
    Definition Classes
    Model
  113. def setStorageRef(value: String): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasStorageRef
  114. def setTensorflow(tf: TensorflowWrapper): AssertionDLModel

    Permalink
  115. val storageRef: Param[String]

    Permalink
    Definition Classes
    HasStorageRef
  116. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  117. var tensorflow: TensorflowWrapper

    Permalink
  118. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  119. final def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    AnnotatorModel → Transformer
  120. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  121. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  122. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage
  123. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  124. val uid: String

    Permalink

    a unique identifier for the instanced AnnotatorModel

    a unique identifier for the instanced AnnotatorModel

    Definition Classes
    AssertionDLModel → Identifiable
  125. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  126. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

    Permalink
    Definition Classes
    HasStorageRef
  127. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  128. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  129. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  131. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  132. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  133. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  134. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from Licensed

Inherited from HasStorageRef

Inherited from WriteTensorflowModel

Inherited from AnnotatorModel[AssertionDLModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[AssertionDLModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[AssertionDLModel]

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

getParam

setParam

Ungrouped