nlp_graph_finisher: Spark NLP GraphFinisher

View source: R/graph-finisher.R

nlp_graph_finisherR Documentation

Spark NLP GraphFinisher

Description

Helper class to convert the knowledge graph from GraphExtraction into a generic format, such as RDF. See https://nlp.johnsnowlabs.com/docs/en/annotators#graphfinisher

Usage

nlp_graph_finisher(
  x,
  input_col,
  output_col,
  clean_annotations = NULL,
  include_metadata = NULL,
  output_as_array = NULL,
  uid = random_string("graph_finisher_")
)

Arguments

x

A spark_connection, ml_pipeline, or a tbl_spark.

input_col

Input column. String.

output_col

Output column. String.

clean_annotations

Whether to remove annotation columns (Default: true)

include_metadata

Annotation metadata format (Default: false)

output_as_array

Finisher generates an Array with the results instead of string (Default: true)

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.