Class/Object

com.johnsnowlabs.nlp.annotators.sda.pragmatic

SentimentDetector

Related Docs: object SentimentDetector | package pragmatic

Permalink

class SentimentDetector extends AnnotatorApproach[SentimentDetectorModel]

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

Instance Constructors

  1. new SentimentDetector()

    Permalink

  2. new SentimentDetector(uid: String)

    Permalink

Type Members

  1. 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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach

  7. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  8. final def clear(param: Param[_]): SentimentDetector.this.type

    Permalink
    Definition Classes
    Params

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. final def copy(extra: ParamMap): Estimator[SentimentDetectorModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params

  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  12. val decrementMultiplier: DoubleParam

    Permalink

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  14. val description: String

    Permalink
    Definition Classes
    SentimentDetector → AnnotatorApproach

  15. val dictionary: ExternalResourceParam

    Permalink

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  18. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  19. def explainParams(): String

    Permalink
    Definition Classes
    Params

  20. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  21. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  23. final def fit(dataset: Dataset[_]): SentimentDetectorModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator

  24. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SentimentDetectorModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  25. def fit(dataset: Dataset[_], paramMap: ParamMap): SentimentDetectorModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  26. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SentimentDetectorModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()

  27. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  30. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols

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

    Permalink
    Definition Classes
    Params

  32. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol

  33. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  35. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  36. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  37. val incrementMultiplier: DoubleParam

    Permalink

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  39. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  40. 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
    SentimentDetector → HasInputAnnotationCols

  41. 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

  42. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  44. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  45. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  46. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  47. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  53. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  54. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  55. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  56. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  57. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  58. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  59. val negativeMultiplier: DoubleParam

    Permalink

  60. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  61. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  62. def onTrained(model: SentimentDetectorModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach

  63. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    SentimentDetector → HasOutputAnnotatorType

  64. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol

  65. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  66. val positiveMultiplier: DoubleParam

    Permalink

  67. val reverseMultiplier: DoubleParam

    Permalink

  68. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  69. final def set(paramPair: ParamPair[_]): SentimentDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  70. final def set(param: String, value: Any): SentimentDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  71. final def set[T](param: Param[T], value: T): SentimentDetector.this.type

    Permalink
    Definition Classes
    Params

  72. def setDecrementMultiplier(v: Double): SentimentDetector.this.type

    Permalink

  73. final def setDefault(paramPairs: ParamPair[_]*): SentimentDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  74. final def setDefault[T](param: Param[T], value: T): SentimentDetector.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  75. def setDictionary(path: String, delimiter: String, readAs: Format, options: Map[String, String] = Map("format" -> "text")): SentimentDetector.this.type

    Permalink

  76. def setDictionary(value: ExternalResource): SentimentDetector.this.type

    Permalink

  77. def setIncrementMultiplier(v: Double): SentimentDetector.this.type

    Permalink

  78. final def setInputCols(value: String*): SentimentDetector.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols

  79. final def setInputCols(value: Array[String]): SentimentDetector.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols

  80. def setNegativeMultiplier(v: Double): SentimentDetector.this.type

    Permalink

  81. final def setOutputCol(value: String): SentimentDetector.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol

  82. def setPositiveMultiplier(v: Double): SentimentDetector.this.type

    Permalink

  83. def setReverseMultiplier(v: Double): SentimentDetector.this.type

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  85. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  86. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): SentimentDetectorModel

    Permalink
    Definition Classes
    SentimentDetector → AnnotatorApproach

  87. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage

  88. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  89. val uid: String

    Permalink
    Definition Classes
    SentimentDetector → Identifiable

  90. 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
    AnnotatorApproach

  91. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  92. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  93. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  94. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from AnnotatorApproach[SentimentDetectorModel]

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[SentimentDetectorModel]

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