Class/Object

com.johnsnowlabs.nlp.annotators.classifier.dl

ClassifierDLModel

Related Docs: object ClassifierDLModel | package dl

Permalink

class ClassifierDLModel extends AnnotatorModel[ClassifierDLModel] with WriteTensorflowModel with HasStorageRef with ParamsAndFeaturesWritable

Linear Supertypes
HasStorageRef, WriteTensorflowModel, AnnotatorModel[ClassifierDLModel], CanBeLazy, RawAnnotator[ClassifierDLModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[ClassifierDLModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClassifierDLModel
  2. HasStorageRef
  3. WriteTensorflowModel
  4. AnnotatorModel
  5. CanBeLazy
  6. RawAnnotator
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. HasOutputAnnotatorType
  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 ClassifierDLModel()

    Permalink
  2. new ClassifierDLModel(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    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

    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
    ClassifierDLModelAnnotatorModel
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    ClassifierDLModelAnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): ClassifierDLModel.this.type

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

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

    Permalink
  18. def copy(extra: ParamMap): ClassifierDLModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

    Permalink
    Definition Classes
    HasStorageRef
  21. val datasetParams: StructFeature[ClassifierDatasetEncoderParams]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  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. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  40. def getConfigProtoBytes: Option[Array[Byte]]

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

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  43. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  44. def getModelIfNotSet: TensorflowClassifier

    Permalink
  45. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  46. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  48. def getStorageRef: String

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

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

    Permalink
    Definition Classes
    Params
  51. def hasParent: Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Annotator reference id.

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

    Definition Classes
    ClassifierDLModelHasInputAnnotationCols
  56. 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
  57. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  62. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def msgHelper(schema: StructType): String

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

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

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

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

    Permalink
  79. val outputAnnotatorType: String

    Permalink
  80. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  82. var parent: Estimator[ClassifierDLModel]

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  91. def setConfigProtoBytes(bytes: Array[Int]): ClassifierDLModel.this.type

    Permalink
  92. def setDatasetParams(params: ClassifierDatasetEncoderParams): ClassifierDLModel.this.type

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. final def setInputCols(value: String*): ClassifierDLModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  101. def setLazyAnnotator(value: Boolean): ClassifierDLModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  102. def setModelIfNotSet(spark: SparkSession, tf: TensorflowWrapper): ClassifierDLModel.this.type

    Permalink
  103. final def setOutputCol(value: String): ClassifierDLModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

    Permalink
    Definition Classes
    Model
  105. def setStorageRef(value: String): ClassifierDLModel.this.type

    Permalink
    Definition Classes
    HasStorageRef
  106. val storageRef: Param[String]

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  109. 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
  110. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  112. 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
  113. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    ClassifierDLModel → Identifiable
  115. 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
    RawAnnotator
  116. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from HasStorageRef

Inherited from WriteTensorflowModel

Inherited from CanBeLazy

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ClassifierDLModel]

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