Packages

class YakeModel extends AnnotatorModel[YakeModel] with HasSimpleAnnotate[YakeModel] with YakeParams

Yake is an Unsupervised, Corpus-Independent, Domain and Language-Independent and Single-Document keyword extraction algorithm. Extracting keywords from texts has become a challenge for individuals and organizations as the information grows in complexity and size. The need to automate this task so that text can be processed in a timely and adequate manner has led to the emergence of automatic keyword extraction tools. Yake is a novel feature-based system for multi-lingual keyword extraction, which supports texts of different sizes, domain or languages. Unlike other approaches, Yake does not rely on dictionaries nor thesauri, neither is trained against any corpora. Instead, it follows an unsupervised approach which builds upon features extracted from the text, making it thus applicable to documents written in different languages without the need for further knowledge. This can be beneficial for a large number of tasks and a plethora of situations where access to training corpora is either limited or restricted. The algorithm makes use of the position of a sentence and token. Therefore, to use the annotator, the text should be first sent through a Sentence Boundary Detector and then a tokenizer. You can tweak the following parameters to get the best result from the annotator.

setMinNGrams(int) Select the minimum length of a extracted keyword setMaxNGrams(int) Select the maximum length of a extracted keyword setNKeywords(int) Extract the top N keywords setStopWords(list) Set the list of stop words setThreshold(float) Each keyword will be given a keyword score greater than 0. (Lower the score better the keyword) Set an upper bound for the keyword score from this method. setWindowSize(int) Yake will construct a co-occurence matrix. You can set the window size for the cooccurence matrix construction from this method. ex: windowSize=2 will look at two words to both left and right of a candidate word.

See Campos, R., Mangaravite, V., Pasquali, A., Jatowt, A., Jorge, A., Nunes, C. and Jatowt, A. (2020). YAKE! Keyword Extraction from Single Documents using Multiple Local Features. In Information Sciences Journal. Elsevier, Vol 509, pp 257-289. https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/keyword/yake/YakeTestSpec.scala for further reference on how to use this API. Sources:

Sources :

https://www.sciencedirect.com/science/article/pii/S0020025519308588

Paper abstract As the amount of generated information grows, reading and summarizing texts of large collections turns into a challenging task. Many documents do not come with descriptive terms, thus requiring humans to generate keywords on-the-fly. The need to automate this kind of task demands the development of keyword extraction systems with the ability to automatically identify keywords within the text. One approach is to resort to machine-learning algorithms. These, however, depend on large annotated text corpora, which are not always available. An alternative solution is to consider an unsupervised approach. In this article, we describe YAKE!, a light-weight unsupervised automatic keyword extraction method which rests on statistical text features extracted from single documents to select the most relevant keywords of a text. Our system does not need to be trained on a particular set of documents, nor does it depend on dictionaries, external corpora, text size, language, or domain. To demonstrate the merits and significance of YAKE!, we compare it against ten state-of-the-art unsupervised approaches and one supervised method. Experimental results carried out on top of twenty datasets show that YAKE! significantly outperforms other unsupervised methods on texts of different sizes, languages, and domains.

Linear Supertypes
YakeParams, HasSimpleAnnotate[YakeModel], 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. HasSimpleAnnotate
  4. AnnotatorModel
  5. CanBeLazy
  6. RawAnnotator
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. HasOutputAnnotatorType
  10. ParamsAndFeaturesWritable
  11. HasFeatures
  12. DefaultParamsWritable
  13. MLWritable
  14. Model
  15. Transformer
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new YakeModel()

    Annotator reference id.

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

  2. new YakeModel(uid: String)

Type Members

  1. type AnnotationContent = Seq[Row]

    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
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    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
    YakeModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def assignTags(resultFlattenIndexed: Array[(String, Int)]): Array[(String, Int, Int, String)]
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    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]

    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
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  17. final def clear(param: Param[_]): YakeModel.this.type
    Definition Classes
    Params
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def copy(extra: ParamMap): YakeModel

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  20. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  21. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. def dfAnnotate: UserDefinedFunction

    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

    Definition Classes
    HasSimpleAnnotate
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  26. def explainParams(): String
    Definition Classes
    Params
  27. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  28. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  29. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  30. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  31. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  38. def getBasicStats(result: Array[Annotation]): Array[(String, Int)]

    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]

    Generate candidate keywords

    Generate candidate keywords

    sentences

    sentences as a list

    returns

    candidate keywords

  40. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def getCoOccurrence(sentences: ListBuffer[ListBuffer[String]], left: Boolean): Map[String, Map[String, Int]]

    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]
    Definition Classes
    Params
  43. def getInputCols: Array[String]

    returns

    input annotations columns currently used

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

    Extract keywords

    Extract keywords

    candidate

    candidate keywords

    tokens

    tokens with scores

    returns

    keywords

  45. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  46. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  47. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  48. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  49. def getSentences(tokenizedArray: Array[Annotation]): ListBuffer[ListBuffer[String]]

    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]
    Definition Classes
    YakeParams
  51. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  52. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  53. def hasParent: Boolean
    Definition Classes
    Model
  54. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  55. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  56. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. val inputAnnotatorTypes: Array[AnnotatorType]

    Annotator reference id.

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

    Definition Classes
    YakeModel → HasInputAnnotationCols
  58. 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
  59. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  60. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  61. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  62. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  63. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  64. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. val maxNGrams: IntParam
    Definition Classes
    YakeParams
  77. val minNGrams: IntParam
    Definition Classes
    YakeParams
  78. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  79. val nKeywords: IntParam
    Definition Classes
    YakeParams
  80. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  81. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  84. val outputAnnotatorType: AnnotatorType
    Definition Classes
    YakeModel → HasOutputAnnotatorType
  85. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  86. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  87. var parent: Estimator[YakeModel]
    Definition Classes
    Model
  88. def processSentences(annotations: Seq[Annotation]): Seq[Annotation]

    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
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  90. def set[T](feature: StructFeature[T], value: T): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def set[T](feature: SetFeature[T], value: Set[T]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def set[T](feature: ArrayFeature[T], value: Array[T]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. final def set(paramPair: ParamPair[_]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def set(param: String, value: Any): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  96. final def set[T](param: Param[T], value: T): YakeModel.this.type
    Definition Classes
    Params
  97. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. final def setDefault(paramPairs: ParamPair[_]*): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  102. final def setDefault[T](param: Param[T], value: T): YakeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  103. final def setInputCols(value: String*): YakeModel.this.type
    Definition Classes
    HasInputAnnotationCols
  104. final def setInputCols(value: Array[String]): YakeModel.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  105. def setLazyAnnotator(value: Boolean): YakeModel.this.type
    Definition Classes
    CanBeLazy
  106. def setMaxNGrams(value: Int): YakeModel.this.type
    Definition Classes
    YakeParams
  107. def setMinNGrams(value: Int): YakeModel.this.type
    Definition Classes
    YakeParams
  108. def setNKeywords(value: Int): YakeModel.this.type
    Definition Classes
    YakeParams
  109. final def setOutputCol(value: String): YakeModel.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  110. def setParent(parent: Estimator[YakeModel]): YakeModel
    Definition Classes
    Model
  111. def setStopWords(value: Array[String]): YakeModel.this.type
    Definition Classes
    YakeParams
  112. def setThreshold(value: Float): YakeModel.this.type
    Definition Classes
    YakeParams
  113. def setWindowSize(value: Int): YakeModel.this.type
    Definition Classes
    YakeParams
  114. val stopWords: StringArrayParam
    Definition Classes
    YakeParams
  115. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  116. val threshold: FloatParam
    Definition Classes
    YakeParams
  117. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  118. final def transform(dataset: Dataset[_]): DataFrame

    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
  119. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  120. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  121. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  122. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  123. val uid: String
    Definition Classes
    YakeModel → Identifiable
  124. 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
    RawAnnotator
  125. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  128. val windowSize: IntParam
    Definition Classes
    YakeParams
  129. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  130. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from YakeParams

Inherited from HasSimpleAnnotate[YakeModel]

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

Members