Class/Object

com.johnsnowlabs.nlp.annotators.keyword.yake

YakeModel

Related Docs: object YakeModel | package yake

Permalink

class YakeModel extends AnnotatorModel[YakeModel] with YakeParams

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

Instance Constructors

  1. new YakeModel()

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

  2. new YakeModel(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink
    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
    Definition Classes
    YakeModel → AnnotatorModel
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def assignTags(resultFlattenIndexed: Array[(String, Int)]): Array[(String, Int, Int, String)]

    Permalink
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. def calculateTokenScores(basicStats: Array[(String, Int)], coOccurLeftAggregate: Map[String, Map[String, Int]], coOccurRightAggregate: Map[String, Map[String, Int]]): Iterable[Token]

    Permalink

    Calculate token scores given statistics

    Calculate token scores given statistics

    Refer YAKE Paper

    T Position = ln ( ln ( 3 + Median(Sentence Index)) T Case = max(TF(U(t)) , TF(A(t))) / ln(TF(t)) TF Norm =TF(t) / (MeanTF + 1 ∗ σ) T Rel = 1 + ( DL + DR ) * TF(t)/MaxTF T Sentence = SF(t)/# Sentences TS = ( TPos ∗ TRel ) / ( TCase + (( TFNorm + TSent ) / TRel ))

    basicStats

    Basic stats

    coOccurLeftAggregate

    Left Co Occurrence

    coOccurRightAggregate

    Right Co Occurrence

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. def dfAnnotate: UserDefinedFunction

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  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
    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. def getBasicStats(result: Array[Annotation]): Array[(String, Int)]

    Permalink

    Calculates basic statistics like total Sentences in the document and assign a tag for each token

    Calculates basic statistics like total Sentences in the document and assign a tag for each token

    result

    Document to annotate as array of tokens with sentence metadata

    returns

    Dataframe with columns SentenceID, token, totalSentences, tag

  39. def getCandidateKeywords(sentences: Array[(String, Int, Int, String)]): Map[String, Int]

    Permalink

    Generate candidate keywords

    Generate candidate keywords

    sentences

    sentences as a list

    returns

    candidate keywords

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

    Permalink
    Definition Classes
    AnyRef → Any
  41. def getCoOccurrence(sentences: ListBuffer[ListBuffer[String]], left: Boolean): Map[String, Map[String, Int]]

    Permalink

    Calculate Co Occurrence for left to right given a window size

    Calculate Co Occurrence for left to right given a window size

    sentences

    DataFrame with tokens

    returns

    Co Occurrence for token x from left to right as a Map

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

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  44. def getKeywords(candidate: Map[String, Int], tokens: Iterable[Token]): ListMap[String, Double]

    Permalink

    Extract keywords

    Extract keywords

    candidate

    candidate keywords

    tokens

    tokens with scores

    returns

    keywords

  45. def getLazyAnnotator: Boolean

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

    Permalink
    Definition Classes
    Params
  47. final def getOutputCol: String

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

    Permalink
    Definition Classes
    Params
  49. def getSentences(tokenizedArray: Array[Annotation]): ListBuffer[ListBuffer[String]]

    Permalink

    Separate sentences given tokens with sentence metadata

    Separate sentences given tokens with sentence metadata

    tokenizedArray

    Tokens with sentence metadata

    returns

    separated sentences

  50. def getStopWords: Array[String]

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

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

    Permalink
    Definition Classes
    Params
  53. def hasParent: Boolean

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

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

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

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

    Permalink
    Definition Classes
    YakeModel → HasInputAnnotationCols
  58. final val inputCols: StringArrayParam

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  59. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  64. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. val maxNGrams: IntParam

    Permalink
    Definition Classes
    YakeParams
  77. val minNGrams: IntParam

    Permalink
    Definition Classes
    YakeParams
  78. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  79. val nKeywords: IntParam

    Permalink
    Definition Classes
    YakeParams
  80. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  84. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    YakeModel → HasOutputAnnotatorType
  85. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  87. var parent: Estimator[YakeModel]

    Permalink
    Definition Classes
    Model
  88. def processSentences(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    Execute the YAKE algorithm for each sentence

    Execute the YAKE algorithm for each sentence

    annotations

    token array to annotate

    returns

    annotated token array

  89. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  97. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): YakeModel.this.type

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  106. def setMaxNGrams(value: Int): YakeModel.this.type

    Permalink
    Definition Classes
    YakeParams
  107. def setMinNGrams(value: Int): YakeModel.this.type

    Permalink
    Definition Classes
    YakeParams
  108. def setNKeywords(value: Int): YakeModel.this.type

    Permalink
    Definition Classes
    YakeParams
  109. final def setOutputCol(value: String): YakeModel.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  110. def setParent(parent: Estimator[YakeModel]): YakeModel

    Permalink
    Definition Classes
    Model
  111. def setStopWords(value: Array[String]): YakeModel.this.type

    Permalink
    Definition Classes
    YakeParams
  112. def setThreshold(value: Float): YakeModel.this.type

    Permalink
    Definition Classes
    YakeParams
  113. def setWindowSize(value: Int): YakeModel.this.type

    Permalink
    Definition Classes
    YakeParams
  114. val stopWords: StringArrayParam

    Permalink
    Definition Classes
    YakeParams
  115. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  116. val threshold: FloatParam

    Permalink
    Definition Classes
    YakeParams
  117. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  118. final def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    AnnotatorModel → Transformer
  119. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  121. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage
  122. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    YakeModel → Identifiable
  124. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  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. val windowSize: IntParam

    Permalink
    Definition Classes
    YakeParams
  129. def wrapColumnMetadata(col: Column): Column

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from YakeParams

Inherited from AnnotatorModel[YakeModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[YakeModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[YakeModel]

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

Ungrouped