SentimentDetector

Instance Constructors

new SentimentDetector()
new SentimentDetector(uid: String)

uid
internal uid needed for saving annotator to disk

Type Members

type AnnotatorType = String

Definition Classes
HasOutputAnnotatorType

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): SentimentDetectorModel

Attributes
protected
Definition Classes
AnnotatorApproach
final def asInstanceOf[T0]: T0

Definition Classes
Any
def beforeTraining(spark: SparkSession): Unit

Definition Classes
AnnotatorApproach
final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

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

Definition Classes
Params
def clone(): AnyRef

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

Definition Classes
AnnotatorApproach → Estimator → PipelineStage → Params
def copyValues[T <: Params](to: T, extra: ParamMap): T

Attributes
protected
Definition Classes
Params
val decrementMultiplier: DoubleParam

multiplier for decrement sentiments.
multiplier for decrement sentiments. Defaults -2.0
final def defaultCopy[T <: Params](extra: ParamMap): T

Attributes
protected
Definition Classes
Params
val description: String

Rule based sentiment detector
Rule based sentiment detector

Definition Classes
SentimentDetector → AnnotatorApproach
val dictionary: ExternalResourceParam

delimited file with a list sentiment tags per word.
delimited file with a list sentiment tags per word. Requires 'delimiter' in options
val enableScore: BooleanParam

if true, score will show as the double value, else will output string \"positive\" or \"negative\".
if true, score will show as the double value, else will output string \"positive\" or \"negative\". Defaults false
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
final def extractParamMap(): ParamMap

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Definition Classes
Params
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def fit(dataset: Dataset[_]): SentimentDetectorModel

Definition Classes
AnnotatorApproach → Estimator
def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SentimentDetectorModel]

Definition Classes
Estimator
Annotations
@Since( "2.0.0" )
def fit(dataset: Dataset[_], paramMap: ParamMap): SentimentDetectorModel

Definition Classes
Estimator
Annotations
@Since( "2.0.0" )
def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SentimentDetectorModel

Definition Classes
Estimator
Annotations
@Since( "2.0.0" ) @varargs()
final def get[T](param: Param[T]): Option[T]

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

Definition Classes
AnyRef → Any
final def getDefault[T](param: Param[T]): Option[T]

Definition Classes
Params
def getInputCols: Array[String]

returns
input annotations columns currently used

Definition Classes
HasInputAnnotationCols
def getLazyAnnotator: Boolean

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

Definition Classes
Params
final def getOutputCol: String

Gets annotation column name going to generate
Gets annotation column name going to generate

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

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

Definition Classes
Params
def hasParam(paramName: String): Boolean

Definition Classes
Params
def hashCode(): Int

Definition Classes
AnyRef → Any
val incrementMultiplier: DoubleParam

multiplier for increment sentiments.
multiplier for increment sentiments. Defaults 2.0
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

Input annotation type : TOKEN, DOCUMENT
Input annotation type : TOKEN, DOCUMENT

Definition Classes
SentimentDetector → HasInputAnnotationCols
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
final def isDefined(param: Param[_]): Boolean

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
val lazyAnnotator: BooleanParam

Definition Classes
CanBeLazy
def log: Logger

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

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

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

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

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

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

Attributes
protected
Definition Classes
Logging
def logName: String

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

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

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

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

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

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

Definition Classes
AnyRef
val negativeMultiplier: DoubleParam

"multiplier for negative sentiments.
"multiplier for negative sentiments. Defaults -1.0
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onTrained(model: SentimentDetectorModel, spark: SparkSession): Unit

Definition Classes
AnnotatorApproach
val outputAnnotatorType: AnnotatorType

Output annotation type : SENTIMENT
Output annotation type : SENTIMENT

Definition Classes
SentimentDetector → HasOutputAnnotatorType
final val outputCol: Param[String]

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

Definition Classes
Params
val positiveMultiplier: DoubleParam

multiplier for positive sentiments.
multiplier for positive sentiments. Defaults 1.0
val reverseMultiplier: DoubleParam

multiplier for revert sentiments.
multiplier for revert sentiments. Defaults -1.0
def save(path: String): Unit

Definition Classes
MLWritable
Annotations
@Since( "1.6.0" ) @throws( ... )
final def set(paramPair: ParamPair[_]): SentimentDetector.this.type

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

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

Definition Classes
Params
def setDecrementMultiplier(v: Double): SentimentDetector.this.type

Multiplier for decrement sentiments.
Multiplier for decrement sentiments. Defaults -2.0
final def setDefault(paramPairs: ParamPair[_]*): SentimentDetector.this.type

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

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

delimited file with a list sentiment tags per word.
delimited file with a list sentiment tags per word. Requires 'delimiter' in options. Dictionary needs 'delimiter' in order to separate words from sentiment tags
def setDictionary(value: ExternalResource): SentimentDetector.this.type

delimited file with a list sentiment tags per word.
delimited file with a list sentiment tags per word. Requires 'delimiter' in options. Dictionary needs 'delimiter' in order to separate words from sentiment tags
def setEnableScore(v: Boolean): SentimentDetector.this.type

if true, score will show as the double value, else will output string \"positive\" or \"negative\".
if true, score will show as the double value, else will output string \"positive\" or \"negative\". Defaults false
def setIncrementMultiplier(v: Double): SentimentDetector.this.type

Multiplier for increment sentiments.
Multiplier for increment sentiments. Defaults 2.0
final def setInputCols(value: String*): SentimentDetector.this.type

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

Overrides required annotators column if different than default
Overrides required annotators column if different than default

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

Definition Classes
CanBeLazy
def setNegativeMultiplier(v: Double): SentimentDetector.this.type

Multiplier for negative sentiments.
Multiplier for negative sentiments. Defaults -1.0
final def setOutputCol(value: String): SentimentDetector.this.type

Overrides annotation column name when transforming
Overrides annotation column name when transforming

Definition Classes
HasOutputAnnotationCol
def setPositiveMultiplier(v: Double): SentimentDetector.this.type

Multiplier for positive sentiments.
Multiplier for positive sentiments. Defaults 1.0
def setReverseMultiplier(v: Double): SentimentDetector.this.type

Multiplier for revert sentiments.
Multiplier for revert sentiments. Defaults -1.0
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): SentimentDetectorModel

Definition Classes
SentimentDetector → AnnotatorApproach
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
def transformSchema(schema: StructType, logging: Boolean): StructType

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

internal uid needed for saving annotator to disk
internal uid needed for saving annotator to disk

Definition Classes
SentimentDetector → Identifiable
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
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def write: MLWriter

Definition Classes
DefaultParamsWritable → MLWritable

Related Docs: object SentimentDetector | package pragmatic

class SentimentDetector extends AnnotatorApproach[SentimentDetectorModel]

Instance Constructors

new SentimentDetector()

new SentimentDetector(uid: String)

Type Members

type AnnotatorType = String

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def $[T](param: Param[T]): T

final def ==(arg0: Any): Boolean

def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): SentimentDetectorModel

final def asInstanceOf[T0]: T0

def beforeTraining(spark: SparkSession): Unit

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

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

def clone(): AnyRef

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

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

val decrementMultiplier: DoubleParam

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

val description: String

val dictionary: ExternalResourceParam

val enableScore: BooleanParam

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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

def explainParams(): String

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

def finalize(): Unit

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

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

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

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

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

final def getClass(): Class[_]

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

def getInputCols: Array[String]

def getLazyAnnotator: Boolean

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

final def getOutputCol: String

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

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

def hasParam(paramName: String): Boolean

def hashCode(): Int

val incrementMultiplier: DoubleParam

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

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

val inputAnnotatorTypes: Array[AnnotatorType]

final val inputCols: StringArrayParam

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

final def isInstanceOf[T0]: Boolean

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

def isTraceEnabled(): Boolean

val lazyAnnotator: BooleanParam

def log: Logger

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

def logDebug(msg: ⇒ String): Unit

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

def logError(msg: ⇒ String): Unit

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

def logInfo(msg: ⇒ String): Unit

def logName: String

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

def logTrace(msg: ⇒ String): Unit

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

def logWarning(msg: ⇒ String): Unit

def msgHelper(schema: StructType): String

final def ne(arg0: AnyRef): Boolean

val negativeMultiplier: DoubleParam

final def notify(): Unit

final def notifyAll(): Unit

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

val outputAnnotatorType: AnnotatorType

final val outputCol: Param[String]

lazy val params: Array[Param[_]]

val positiveMultiplier: DoubleParam