nlp_regex_matcher: Spark NLP RegexMatcher

View source: R/regex_matcher.R

nlp_regex_matcherR Documentation

Spark NLP RegexMatcher

Description

Spark ML estimator that See https://nlp.johnsnowlabs.com/docs/en/annotators#regexmatcher

Usage

nlp_regex_matcher(
  x,
  input_cols,
  output_col,
  strategy = NULL,
  rules_path,
  rules_path_delimiter,
  rules_path_read_as = "TEXT",
  rules_path_options = list(format = "text"),
  uid = random_string("regex_matcher_")
)

Arguments

x

A spark_connection, ml_pipeline, or a tbl_spark.

input_cols

Input columns. String array.

output_col

Output column. String.

strategy

Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

rules_path

Path to file containing a set of regex,key pair

rules_path_delimiter

delimiter between regex and key in the file

rules_path_read_as

TEXT or SPARK_DATASET

rules_path_options

options passed to Spark reader if read_as is SPARK_DATASET

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.