Class/Object

com.johnsnowlabs.nlp.annotators.sda.pragmatic

SentimentDetectorModel

Related Docs: object SentimentDetectorModel | package pragmatic

Permalink

class SentimentDetectorModel extends AnnotatorModel[SentimentDetectorModel]

Gives a good or bad score to a sentence based on the approach used

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

Instance Constructors

  1. new SentimentDetectorModel()

    Permalink
  2. new SentimentDetectorModel(uid: String)

    Permalink

    uid

    internal uid needed for saving annotator to disk

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

    Tokens are needed to identify each word in a sentence boundary POS tags are optionally submitted to the model in case they are needed Lemmas are another optional annotator for some models Bounds of sentiment are hardcoded to 0 as they render useless

    Tokens are needed to identify each word in a sentence boundary POS tags are optionally submitted to the model in case they are needed Lemmas are another optional annotator for some models Bounds of sentiment are hardcoded to 0 as they render useless

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def copy(extra: ParamMap): SentimentDetectorModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  19. val decrementMultiplier: DoubleParam

    Permalink

    multiplier for decrement sentiments.

    multiplier for decrement sentiments. Defaults -2.0

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. 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
  22. val enableScore: BooleanParam

    Permalink

    if true, score will show as a string type containing a double value, else will output string \"positive\" or \"negative\".

    if true, score will show as a string type containing a double value, else will output string \"positive\" or \"negative\". Defaults false

  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
    RawAnnotator
  28. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  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. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  41. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  42. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  43. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

    Permalink
    Definition Classes
    Params
  47. def hasParent: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  49. val incrementMultiplier: DoubleParam

    Permalink

    multiplier for increment sentiments.

    multiplier for increment sentiments. Defaults 2.0

  50. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

    Permalink

    Input annotation type : TOKEN, DOCUMENT

    Input annotation type : TOKEN, DOCUMENT

    Definition Classes
    SentimentDetectorModelHasInputAnnotationCols
  53. 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
  54. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  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. lazy val model: PragmaticScorer

    Permalink

  72. def msgHelper(schema: StructType): String

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

    Permalink
    Definition Classes
    AnyRef
  74. val negativeMultiplier: DoubleParam

    Permalink

    multiplier for negative sentiments.

    multiplier for negative sentiments. Defaults -1.0

  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
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  78. val outputAnnotatorType: AnnotatorType

    Permalink

    Output annotation type : SENTIMENT

    Output annotation type : SENTIMENT

    Definition Classes
    SentimentDetectorModelHasOutputAnnotatorType
  79. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  81. var parent: Estimator[SentimentDetectorModel]

    Permalink
    Definition Classes
    Model
  82. val positiveMultiplier: DoubleParam

    Permalink

    multiplier for positive sentiments.

    multiplier for positive sentiments. Defaults 1.0

  83. val reverseMultiplier: DoubleParam

    Permalink

    multiplier for revert sentiments.

    multiplier for revert sentiments. Defaults -1.0

  84. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  85. val sentimentDict: MapFeature[String, String]

    Permalink

    Sentiment dict

  86. def set[T](feature: StructFeature[T], value: T): SentimentDetectorModel.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  93. def setDecrementMultipler(v: Double): SentimentDetectorModel.this.type

    Permalink

    Multiplier for decrement sentiments.

    Multiplier for decrement sentiments. Defaults -2.0

  94. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): SentimentDetectorModel.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  100. def setEnableScore(v: Boolean): SentimentDetectorModel.this.type

    Permalink

    If true, score will show as a string type containing a double value, else will output string "positive" or "negative".

    If true, score will show as a string type containing a double value, else will output string "positive" or "negative". Defaults false

  101. def setIncrementMultipler(v: Double): SentimentDetectorModel.this.type

    Permalink

    Multiplier for increment sentiments.

    Multiplier for increment sentiments. Defaults 2.0

  102. final def setInputCols(value: String*): SentimentDetectorModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  104. def setLazyAnnotator(value: Boolean): SentimentDetectorModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  105. def setNegativeMultipler(v: Double): SentimentDetectorModel.this.type

    Permalink

    Multiplier for negative sentiments.

    Multiplier for negative sentiments. Defaults -1.0

  106. final def setOutputCol(value: String): SentimentDetectorModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  107. def setParent(parent: Estimator[SentimentDetectorModel]): SentimentDetectorModel

    Permalink
    Definition Classes
    Model
  108. def setPositiveMultipler(v: Double): SentimentDetectorModel.this.type

    Permalink

    Multiplier for positive sentiments.

    Multiplier for positive sentiments. Defaults 1.0

  109. def setReverseMultipler(v: Double): SentimentDetectorModel.this.type

    Permalink

    Multiplier for revert sentiments.

    Multiplier for revert sentiments. Defaults -1.0

  110. def setSentimentDict(value: Map[String, String]): SentimentDetectorModel.this.type

    Permalink

    Path to file with list of inputs and their content, with such delimiter, readAs LINE_BY_LINE or as SPARK_DATASET.

    Path to file with list of inputs and their content, with such delimiter, readAs LINE_BY_LINE or as SPARK_DATASET. If latter is set, options is passed to spark reader.

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

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

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

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

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

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

    Permalink

    internal uid needed for saving annotator to disk

    internal uid needed for saving annotator to disk

    Definition Classes
    SentimentDetectorModel → Identifiable
  119. 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
  120. final def wait(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

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[SentimentDetectorModel]

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

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters