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], 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. AutoCloseable
  4. AnnotatorApproach
  5. DefaultParamsWritable
  6. MLWritable
  7. HasAnnotatorType
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. 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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val annotatorType: AnnotatorType

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

    Permalink
    Definition Classes
    Any
  7. val batchSize: IntParam

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

    Permalink
  9. val classes: IntParam

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AssertionDLApproachAnnotatorApproach
  17. val dropout: FloatParam

    Permalink
  18. def embeddings: Option[WordEmbeddings]

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  19. val embeddingsFormat: IntParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  20. val embeddingsNDims: IntParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  21. val endCol: Param[String]

    Permalink
  22. val epochs: IntParam

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

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

    Permalink
    Definition Classes
    Params
  31. def extractTextUdf: UserDefinedFunction

    Permalink
    Attributes
    protected
  32. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  37. final def get[T](param: Param[T]): Option[T]

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

    Permalink
    Definition Classes
    AnyRef → Any
  39. final def getDefault[T](param: Param[T]): Option[T]

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

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  42. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  47. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. 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
  50. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
  55. val learningRate: FloatParam

    Permalink
  56. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  72. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  74. 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
  75. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  76. final def set(paramPair: ParamPair[_]): AssertionDLApproach.this.type

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

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

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

    Permalink
  80. def setClasses(k: Int): AssertionDLApproach.this.type

    Permalink
  81. final def setDefault(paramPairs: ParamPair[_]*): AssertionDLApproach.this.type

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

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

    Permalink
  84. def setEmbeddingsSource(path: String, nDims: Int, format: String): AssertionDLApproach

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

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

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

    Permalink
  88. final def setInputCols(value: String*): AssertionDLApproach.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  89. 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
  90. def setLabelCol(label: String): AssertionDLApproach.this.type

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

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

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

    Permalink
  95. def setUseNormalizedTokensForEmbeddings(value: Boolean): AssertionDLApproach.this.type

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  96. val sourceEmbeddingsPath: Param[String]

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

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

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

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

    Permalink
    Definition Classes
    AssertionDLApproachAnnotatorApproach
  101. 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
  102. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    AssertionDLApproach → Identifiable
  104. val useNormalizedTokensForEmbeddings: BooleanParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  105. 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
  106. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

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