Class/Object

com.johnsnowlabs.nlp.annotators.assertion.dl

AssertionDLApproach

Related Docs: object AssertionDLApproach | package dl

Permalink

class AssertionDLApproach extends ApproachWithWordEmbeddings[AssertionDLApproach, AssertionDLModel]

Created by jose on 14/03/18.

Linear Supertypes
ApproachWithWordEmbeddings[AssertionDLApproach, AssertionDLModel], HasEmbeddings, ParamsAndFeaturesWritable, HasFeatures, AutoCloseable, AnnotatorApproach[AssertionDLModel], DefaultParamsWritable, MLWritable, HasAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[AssertionDLModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AssertionDLApproach
  2. ApproachWithWordEmbeddings
  3. HasEmbeddings
  4. ParamsAndFeaturesWritable
  5. HasFeatures
  6. AutoCloseable
  7. AnnotatorApproach
  8. DefaultParamsWritable
  9. MLWritable
  10. HasAnnotatorType
  11. HasOutputAnnotationCol
  12. HasInputAnnotationCols
  13. Estimator
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AssertionDLApproach()

    Permalink
  2. new AssertionDLApproach(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasAnnotatorType

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. val annotatorType: AnnotatorType

    Permalink
    Definition Classes
    AssertionDLApproachHasAnnotatorType
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. val batchSize: IntParam

    Permalink
  12. def beforeTraining(spark: SparkSession): Unit

    Permalink
  13. val caseSensitiveEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasEmbeddings
  14. val classes: IntParam

    Permalink
  15. final def clear(param: Param[_]): AssertionDLApproach.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def close(): Unit

    Permalink
    Definition Classes
    HasEmbeddings → AutoCloseable
  18. final def copy(extra: ParamMap): Estimator[AssertionDLModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  20. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. val description: String

    Permalink
    Definition Classes
    AssertionDLApproachAnnotatorApproach
  22. val dropout: FloatParam

    Permalink
  23. val embeddingsDim: IntParam

    Permalink
    Definition Classes
    HasEmbeddings
  24. val embeddingsFormat: IntParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  25. val embeddingsRef: Param[String]

    Permalink
    Definition Classes
    HasEmbeddings
  26. val endCol: Param[String]

    Permalink
  27. val epochs: IntParam

    Permalink
  28. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  33. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  34. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  36. def extractTextUdf: UserDefinedFunction

    Permalink
    Attributes
    protected
  37. val features: ArrayBuffer[Feature[_, _, _]]

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. final def fit(dataset: Dataset[_]): AssertionDLModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  40. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[AssertionDLModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  41. def fit(dataset: Dataset[_], paramMap: ParamMap): AssertionDLModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  42. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): AssertionDLModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  43. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  49. def getClusterEmbeddings: ClusterWordEmbeddings

    Permalink
    Definition Classes
    HasEmbeddings
  50. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  51. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  52. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  53. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

    Permalink
    Definition Classes
    Params
  57. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  58. val includeEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasEmbeddings
  59. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. final val inputCols: StringArrayParam

    Permalink

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. val labelCol: Param[String]

    Permalink
  67. val learningRate: FloatParam

    Permalink
  68. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  80. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  83. def onTrained(model: AssertionDLModel, spark: SparkSession): Unit

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable
  85. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  87. val requiredAnnotatorTypes: Array[String]

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    AssertionDLApproachHasInputAnnotationCols
  88. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  96. def setBatchSize(size: Int): AssertionDLApproach.this.type

    Permalink
  97. def setCaseSensitiveEmbeddings(value: Boolean): AssertionDLApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  98. def setClasses(k: Int): AssertionDLApproach.this.type

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  105. def setDropout(factor: Float): AssertionDLApproach.this.type

    Permalink
  106. def setEmbeddingsDim(value: Int): AssertionDLApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  107. def setEmbeddingsRef(value: String): AssertionDLApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  108. def setEmbeddingsSource(path: String, nDims: Int, format: String): AssertionDLApproach

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  109. def setEmbeddingsSource(path: String, nDims: Int, format: Format): AssertionDLApproach

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  110. def setEndCol(e: String): AssertionDLApproach.this.type

    Permalink
  111. def setEpochs(number: Int): AssertionDLApproach.this.type

    Permalink
  112. def setIncludeEmbeddings(value: Boolean): AssertionDLApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  113. final def setInputCols(value: String*): AssertionDLApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  115. def setLabelCol(label: String): AssertionDLApproach.this.type

    Permalink
  116. def setLearningRate(rate: Float): AssertionDLApproach.this.type

    Permalink
  117. final def setOutputCol(value: String): AssertionDLApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  118. def setStartCol(s: String): AssertionDLApproach.this.type

    Permalink
  119. def setTargetCol(target: String): AssertionDLApproach.this.type

    Permalink
  120. val sourceEmbeddingsPath: Param[String]

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  121. val startCol: Param[String]

    Permalink
  122. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  123. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  124. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): AssertionDLModel

    Permalink
    Definition Classes
    AssertionDLApproachAnnotatorApproach
  125. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  126. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    AssertionDLApproach → Identifiable
  128. def validate(schema: StructType): Boolean

    Permalink

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  129. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasEmbeddings

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AutoCloseable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

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

Ungrouped