Class

com.johnsnowlabs.nlp.annotators.sda.vivekn

ViveknSentimentApproach

Related Doc: package vivekn

Permalink

class ViveknSentimentApproach extends AnnotatorApproach[ViveknSentimentModel] with ViveknSentimentUtils

Inspired on vivekn sentiment analysis algorithm https://github.com/vivekn/sentiment/

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

Instance Constructors

  1. new ViveknSentimentApproach()

    Permalink
  2. new ViveknSentimentApproach(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. def ViveknWordCount(er: ExternalResource, prune: Int, f: (List[String]) ⇒ Set[String], left: Map[String, Long] = ..., right: Map[String, Long] = ...): (Map[String, Long], Map[String, Long])

    Permalink
    Definition Classes
    ViveknSentimentUtils
  6. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): ViveknSentimentModel

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

    Permalink
    Definition Classes
    Any
  8. def beforeTraining(spark: SparkSession): Unit

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  15. val description: String

    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. val featureLimit: IntParam

    Permalink
    Attributes
    protected
  23. def finalize(): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  31. def getFeatureLimit(v: Int): Int

    Permalink
  32. def getImportantFeatureRatio(v: Double): Double

    Permalink
  33. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  34. def getLazyAnnotator: Boolean

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

    Permalink
    Definition Classes
    Params
  36. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  38. def getUnimportantFeatureStep(v: Double): Double

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

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

    Permalink
    Definition Classes
    Params
  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  42. val importantFeatureRatio: DoubleParam

    Permalink
    Attributes
    protected
  43. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. 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
    ViveknSentimentApproachHasInputAnnotationCols
  46. 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
  47. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  52. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  66. def negateSequence(words: Array[String]): Set[String]

    Permalink

    Detects negations and transforms them into not_ form

    Detects negations and transforms them into not_ form

    Definition Classes
    ViveknSentimentUtils
  67. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  69. def onTrained(model: ViveknSentimentModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  70. val outputAnnotatorType: AnnotatorType

    Permalink
  71. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  73. val pruneCorpus: IntParam

    Permalink
  74. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  75. val sentimentCol: Param[String]

    Permalink

    Requires sentence boundaries to give score in context Tokenization to make sure tokens are within bounds Transitivity requirements are also required

  76. final def set(paramPair: ParamPair[_]): ViveknSentimentApproach.this.type

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

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

    Permalink
    Definition Classes
    Params
  79. def setCorpusPrune(value: Int): ViveknSentimentApproach.this.type

    Permalink
  80. final def setDefault(paramPairs: ParamPair[_]*): ViveknSentimentApproach.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  82. def setFeatureLimit(v: Int): ViveknSentimentApproach.this.type

    Permalink
  83. def setImportantFeatureRatio(v: Double): ViveknSentimentApproach.this.type

    Permalink
  84. final def setInputCols(value: String*): ViveknSentimentApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

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

    Permalink
    Definition Classes
    CanBeLazy
  87. final def setOutputCol(value: String): ViveknSentimentApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  88. def setSentimentCol(value: String): ViveknSentimentApproach.this.type

    Permalink
  89. def setUnimportantFeatureStep(v: Double): ViveknSentimentApproach.this.type

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

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

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

    Permalink
  93. 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
  94. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    ViveknSentimentApproach → Identifiable
  96. val unimportantFeatureStep: DoubleParam

    Permalink
    Attributes
    protected
  97. 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
  98. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from ViveknSentimentUtils

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[ViveknSentimentModel]

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