Class/Object

com.johnsnowlabs.nlp.annotators.assertion.dl

AssertionDLModel

Related Docs: object AssertionDLModel | package dl

Permalink

class AssertionDLModel extends AnnotatorModel[AssertionDLModel] with HasWordEmbeddings with WriteTensorflowModel with ParamsAndFeaturesWritable

Created by jose on 14/03/18.

Linear Supertypes
WriteTensorflowModel, HasWordEmbeddings, AutoCloseable, AnnotatorModel[AssertionDLModel], RawAnnotator[AssertionDLModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasAnnotatorType, 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. WriteTensorflowModel
  3. HasWordEmbeddings
  4. AutoCloseable
  5. AnnotatorModel
  6. RawAnnotator
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. HasAnnotatorType
  10. ParamsAndFeaturesWritable
  11. HasFeatures
  12. DefaultParamsWritable
  13. MLWritable
  14. Model
  15. Transformer
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AssertionDLModel()

    Permalink
  2. new AssertionDLModel(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. def afterAnnotate(dataset: DataFrame): DataFrame

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

    Permalink

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

    Permalink
    Definition Classes
    AssertionDLModelHasAnnotatorType
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. val batchSize: IntParam

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. final def clear(param: Param[_]): AssertionDLModel.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
    HasWordEmbeddings → AutoCloseable
  18. def copy(extra: ParamMap): AssertionDLModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  20. val datasetParams: StructFeature[DatasetEncoderParams]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. def deserializeEmbeddings(path: String, spark: SparkContext): Unit

    Permalink
    Definition Classes
    HasWordEmbeddings
  23. def dfAnnotate: UserDefinedFunction

    Permalink

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  24. def embeddings: Option[WordEmbeddings]

    Permalink
    Definition Classes
    HasWordEmbeddings
  25. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  42. def getEmbeddingsSerializedPath(path: String): Path

    Permalink
    Definition Classes
    HasWordEmbeddings
  43. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  45. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

    Permalink
    Definition Classes
    Params
  49. def hasParent: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  51. val indexPath: Param[String]

    Permalink
    Definition Classes
    HasWordEmbeddings
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def model: TensorflowAssertion

    Permalink
  72. def moveFolderFiles(folderSrc: String, folderDst: String): Unit

    Permalink
    Definition Classes
    HasWordEmbeddings
  73. val nDims: IntParam

    Permalink
    Definition Classes
    HasWordEmbeddings
  74. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
  78. final val outputCol: Param[String]

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

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

    Permalink
    Definition Classes
    Model
  81. 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
    AssertionDLModelHasInputAnnotationCols
  82. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  83. def serializeEmbeddings(path: String, spark: SparkContext): Unit

    Permalink
    Definition Classes
    HasWordEmbeddings
  84. def set[T](feature: StructFeature[T], value: T): AssertionDLModel.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. def setDims(nDims: Int): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasWordEmbeddings
  100. def setIndexPath(path: String): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasWordEmbeddings
  101. final def setInputCols(value: String*): AssertionDLModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  103. final def setOutputCol(value: String): AssertionDLModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

    Permalink
    Definition Classes
    Model
  105. def setTensorflow(tf: TensorflowWrapper): AssertionDLModel

    Permalink
  106. def setUseNormalizedTokensForEmbeddings(value: Boolean): AssertionDLModel.this.type

    Permalink
    Definition Classes
    HasWordEmbeddings
  107. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  108. var tensorflow: TensorflowWrapper

    Permalink
  109. def toString(): String

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

    Permalink

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    dataset

    Dataset[Row]

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

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

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

    Permalink

    requirement for pipeline transformation validation.

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

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

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

    Permalink
    Definition Classes
    AssertionDLModel → Identifiable
  116. val useNormalizedTokensForEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasWordEmbeddings
  117. 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
  118. final def wait(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  123. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from WriteTensorflowModel

Inherited from HasWordEmbeddings

Inherited from AutoCloseable

Inherited from RawAnnotator[AssertionDLModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasAnnotatorType

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

Ungrouped