nlp_relation_extraction_dl: Spark NLP RelationExtractionDLModel

View source: R/relation_extraction_dl.R

nlp_relation_extraction_dlR Documentation

Spark NLP RelationExtractionDLModel

Description

Spark ML transformer that extracts and classifies instances of relations between named entities. In contrast with RelationExtractionModel, RelationExtractionDLModel is based on BERT. For pretrained models please see the Models Hub for available models.

Usage

nlp_relation_extraction_dl(
  x,
  input_cols,
  output_col,
  category_names = NULL,
  max_sentence_length = NULL,
  prediction_threshold = NULL,
  uid = random_string("relation_extraction_dl_")
)

Arguments

x

A spark_connection, ml_pipeline, or a tbl_spark.

input_cols

Input columns. String array.

output_col

Output column. String.

category_names

list of relation names

max_sentence_length

Max sentence length to process (Default: 128)

prediction_threshold

Minimal activation of the target unit to encode a new relation instance (Default: 0.5f)

uid

A character string used to uniquely identify the ML estimator.

Details

See https://nlp.johnsnowlabs.com/licensed/api/com/johnsnowlabs/nlp/annotators/re/RelationExtractionDLModel.html

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.