Class/Object

com.johnsnowlabs.nlp.annotators.classifier.dl

SentimentDLModel

Related Docs: object SentimentDLModel | package dl

Permalink

class SentimentDLModel extends AnnotatorModel[SentimentDLModel] with HasSimpleAnnotate[SentimentDLModel] with WriteTensorflowModel with HasStorageRef with ParamsAndFeaturesWritable

Linear Supertypes
HasStorageRef, WriteTensorflowModel, HasSimpleAnnotate[SentimentDLModel], AnnotatorModel[SentimentDLModel], CanBeLazy, RawAnnotator[SentimentDLModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[SentimentDLModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. SentimentDLModel
  2. HasStorageRef
  3. WriteTensorflowModel
  4. HasSimpleAnnotate
  5. AnnotatorModel
  6. CanBeLazy
  7. RawAnnotator
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. HasOutputAnnotatorType
  11. ParamsAndFeaturesWritable
  12. HasFeatures
  13. DefaultParamsWritable
  14. MLWritable
  15. Model
  16. Transformer
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SentimentDLModel()

    Permalink
  2. new SentimentDLModel(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
    SentimentDLModelHasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. val classes: StringArrayParam

    Permalink
  16. final def clear(param: Param[_]): SentimentDLModel.this.type

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

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

    Permalink
  19. def copy(extra: ParamMap): SentimentDLModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  24. 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

    Definition Classes
    HasSimpleAnnotate
  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. def getClasses: Array[String]

    Permalink

    get the tags used to trained this NerDLModel

  42. def getConfigProtoBytes: Option[Array[Byte]]

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

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  45. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  46. def getModelIfNotSet: TensorflowSentiment

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

    Permalink
    Definition Classes
    Params
  48. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  50. def getStorageRef: String

    Permalink
    Definition Classes
    HasStorageRef
  51. def getThreshold: Float

    Permalink
  52. def getThresholdLabel: String

    Permalink
  53. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  55. def hasParent: Boolean

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  66. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  83. val outputAnnotatorType: String

    Permalink
  84. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  86. var parent: Estimator[SentimentDLModel]

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

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

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

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

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

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

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

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

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

    Permalink
  96. def setDatasetParams(params: ClassifierDatasetEncoderParams): SentimentDLModel.this.type

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

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

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

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

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

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

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

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  105. def setLazyAnnotator(value: Boolean): SentimentDLModel.this.type

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

    Permalink
  107. final def setOutputCol(value: String): SentimentDLModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  108. def setParent(parent: Estimator[SentimentDLModel]): SentimentDLModel

    Permalink
    Definition Classes
    Model
  109. def setStorageRef(value: String): SentimentDLModel.this.type

    Permalink
    Definition Classes
    HasStorageRef
  110. def setThreshold(threshold: Float): SentimentDLModel.this.type

    Permalink
  111. def setThresholdLabel(label: String): SentimentDLModel.this.type

    Permalink
  112. val storageRef: Param[String]

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

    Permalink
    Definition Classes
    AnyRef
  114. val threshold: FloatParam

    Permalink
  115. val thresholdLabel: Param[String]

    Permalink
  116. def toString(): String

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    WriteTensorflowModel
  132. def writeTensorflowModelV2(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 RawAnnotator[SentimentDLModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[SentimentDLModel]

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

getParam

Ungrouped