class ClassifierDLApproach extends AnnotatorApproach[ClassifierDLModel] with ParamsAndFeaturesWritable

ClassifierDL is a generic Multi-class Text Classification. ClassifierDL uses the state-of-the-art Universal Sentence Encoder as an input for text classifications. The ClassifierDL annotator uses a deep learning model (DNNs) we have built inside TensorFlow and supports up to 100 classes

NOTE: This annotator accepts a label column of a single item in either type of String, Int, Float, or Double.

NOTE: UniversalSentenceEncoder, BertSentenceEmbeddings, or SentenceEmbeddings can be used for the inputCol

See https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/classifier/dl/ClassifierDLTestSpec.scala for further reference on how to use this API

Linear Supertypes
ParamsAndFeaturesWritable, HasFeatures, AnnotatorApproach[ClassifierDLModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[ClassifierDLModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ClassifierDLApproach
  2. ParamsAndFeaturesWritable
  3. HasFeatures
  4. AnnotatorApproach
  5. CanBeLazy
  6. DefaultParamsWritable
  7. MLWritable
  8. HasOutputAnnotatorType
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClassifierDLApproach()
  2. new ClassifierDLApproach(uid: String)

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): ClassifierDLModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. val batchSize: IntParam

    Batch size

  12. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    ClassifierDLApproach → AnnotatorApproach
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  14. final def clear(param: Param[_]): ClassifierDLApproach.this.type
    Definition Classes
    Params
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. val configProtoBytes: IntArrayParam

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  17. final def copy(extra: ParamMap): Estimator[ClassifierDLModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. val description: String

    Trains TensorFlow model for multi-class text classification

    Trains TensorFlow model for multi-class text classification

    Definition Classes
    ClassifierDLApproach → AnnotatorApproach
  21. val dropout: FloatParam

    Dropout coefficient

  22. val enableOutputLogs: BooleanParam

    Whether to output to annotators log folder

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  26. def explainParams(): String
    Definition Classes
    Params
  27. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  28. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  29. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  30. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def fit(dataset: Dataset[_]): ClassifierDLModel
    Definition Classes
    AnnotatorApproach → Estimator
  32. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[ClassifierDLModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  33. def fit(dataset: Dataset[_], paramMap: ParamMap): ClassifierDLModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  34. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ClassifierDLModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  35. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  40. def getBatchSize: Int

    Batch size

  41. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. def getConfigProtoBytes: Option[Array[Byte]]

    Tensorflow config Protobytes passed to the TF session

  43. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getDropout: Float

    Dropout coefficient

  45. def getEnableOutputLogs: Boolean

    Whether to output to annotators log folder

  46. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  47. def getLabelColumn: String

    Column with label per each document

  48. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  49. def getLr: Float

    Learning Rate

  50. def getMaxEpochs: Int

    Maximum number of epochs to train

  51. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  52. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  53. def getOutputLogsPath: String
  54. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  55. def getValidationSplit: Float

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  56. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  57. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  60. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type : SENTENCE_EMBEDDINGS

    Input annotator type : SENTENCE_EMBEDDINGS

    Definition Classes
    ClassifierDLApproach → HasInputAnnotationCols
  62. final val inputCols: StringArrayParam

    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
  63. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  64. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  65. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  66. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  67. val labelColumn: Param[String]

    Column with label per each document

  68. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  69. def loadSavedModel(): TensorflowWrapper
  70. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. val lr: FloatParam

    Learning Rate

  83. val maxEpochs: IntParam

    Maximum number of epochs to train

  84. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  85. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  88. def onTrained(model: ClassifierDLModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  89. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  90. val outputAnnotatorType: String

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

    Definition Classes
    ClassifierDLApproach → HasOutputAnnotatorType
  91. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  92. val outputLogsPath: Param[String]
  93. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  94. val randomSeed: IntParam

    Random seed

  95. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  96. def set[T](feature: StructFeature[T], value: T): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: SetFeature[T], value: Set[T]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def set[T](feature: ArrayFeature[T], value: Array[T]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def set(paramPair: ParamPair[_]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set(param: String, value: Any): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  102. final def set[T](param: Param[T], value: T): ClassifierDLApproach.this.type
    Definition Classes
    Params
  103. def setBatchSize(batch: Int): ClassifierDLApproach.this.type

    Batch size

  104. def setConfigProtoBytes(bytes: Array[Int]): ClassifierDLApproach.this.type

    Tensorflow config Protobytes passed to the TF session

  105. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  109. final def setDefault(paramPairs: ParamPair[_]*): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  110. final def setDefault[T](param: Param[T], value: T): ClassifierDLApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  111. def setDropout(dropout: Float): ClassifierDLApproach.this.type

    Dropout coefficient

  112. def setEnableOutputLogs(enableOutputLogs: Boolean): ClassifierDLApproach.this.type

    Whether to output to annotators log folder

  113. final def setInputCols(value: String*): ClassifierDLApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  114. final def setInputCols(value: Array[String]): ClassifierDLApproach.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  115. def setLabelColumn(column: String): ClassifierDLApproach.this.type

    Column with label per each document

  116. def setLazyAnnotator(value: Boolean): ClassifierDLApproach.this.type
    Definition Classes
    CanBeLazy
  117. def setLr(lr: Float): ClassifierDLApproach.this.type

    Learning Rate

  118. def setMaxEpochs(epochs: Int): ClassifierDLApproach.this.type

    Maximum number of epochs to train

  119. final def setOutputCol(value: String): ClassifierDLApproach.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  120. def setOutputLogsPath(path: String): ClassifierDLApproach.this.type
  121. def setValidationSplit(validationSplit: Float): ClassifierDLApproach.this.type

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  122. def setVerbose(verbose: Level): ClassifierDLApproach.this.type

    Level of verbosity during training

  123. def setVerbose(verbose: Int): ClassifierDLApproach.this.type

    Level of verbosity during training

  124. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  125. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  126. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): ClassifierDLModel
    Definition Classes
    ClassifierDLApproach → AnnotatorApproach
  127. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage
  128. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  129. val uid: String
    Definition Classes
    ClassifierDLApproach → Identifiable
  130. def validate(schema: StructType): Boolean

    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
    AnnotatorApproach
  131. val validationSplit: FloatParam

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  132. val verbose: IntParam

    Level of verbosity during training

  133. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  136. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AnnotatorApproach[ClassifierDLModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[ClassifierDLModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters