nlp_yake_model: Spark NLP YakeModel

View source: R/yake_model.R

nlp_yake_modelR Documentation

Spark NLP YakeModel

Description

Spark ML estimator that See https://nlp.johnsnowlabs.com/docs/en/annotators#yakemodel-keywords-extraction

Usage

nlp_yake_model(
  x,
  input_cols,
  output_col,
  min_ngrams = NULL,
  max_ngrams = NULL,
  n_keywords = NULL,
  stop_words = NULL,
  threshold = NULL,
  window_size = NULL,
  uid = random_string("yake_model_")
)

Arguments

x

A spark_connection, ml_pipeline, or a tbl_spark.

input_cols

Input columns. String array.

output_col

Output column. String.

min_ngrams

select the minimum length of an extracted keyword

max_ngrams

select the maximum length of an extracted keyword

n_keywords

extract the top N keywords

stop_words

set the list of stop words

threshold

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.

window_size

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.

uid

A character string used to uniquely identify the ML estimator.

Value

The object returned depends on the class of x.

  • spark_connection: When x is a spark_connection, the function returns an instance of a ml_estimator object. The object contains a pointer to a Spark Estimator object and can be used to compose Pipeline objects.

  • ml_pipeline: When x is a ml_pipeline, the function returns a ml_pipeline with the NLP estimator appended to the pipeline.

  • tbl_spark: When x is a tbl_spark, an estimator is constructed then immediately fit with the input tbl_spark, returning an NLP model.


r-spark/sparknlp documentation built on Oct. 15, 2022, 10:50 a.m.