nlp_finisher: Spark NLP Finisher

In r-spark/sparknlp: R Interface to John Snow Labs Spark NLP

Spark NLP Finisher

Description

Spark ML transformer that outputs annotation(s) values into string. See https://nlp.johnsnowlabs.com/docs/en/annotators#finisher

Usage

nlp_finisher(
  x,
  input_cols,
  output_cols = NULL,
  clean_annotations = NULL,
  value_split_symbol = NULL,
  annotation_split_symbol = NULL,
  include_metadata = NULL,
  output_as_array = NULL,
  uid = random_string("finisher_")
)

Arguments

x	A spark_connection, ml_pipeline, or a tbl_spark.
input_cols	Input columns. String array.
output_cols	Output columns. String array.
clean_annotations	Boolean. Whether to remove intermediate annotations
value_split_symbol	String. Optional. Split values within an annotation character
annotation_split_symbol	String. Optional. Split values between annotations character
include_metadata	Boolean. Optional. Whether to include metadata keys. Sometimes useful in some annotations
output_as_array	Boolean. Optional. Whether to output as Array. Useful as input for other Spark transformers
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.