com.johnsnowlabs.nlp.annotators
NGramGenerator
Related Docs:
object NGramGenerator
| package annotators
com.johnsnowlabs.nlp.annotators
internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI
internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI
takes a document and annotations and produces new annotations of this annotator's annotation type
takes a document and annotations and produces new annotations of this annotator's annotation type
Annotations that correspond to inputAnnotationCols generated by previous annotators if any
any number of annotations processed for every input annotation. Not necessary one to one relationship
requirement for annotators copies
requirement for annotators copies
Glue character used to join the tokens
Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column
Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column
udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation
whether to calculate just the actual n-grams or all n-grams from 1 through n
Override for additional custom schema checks
Override for additional custom schema checks
Glue character used to join the tokens
Whether to calculate just the actual n-grams or all n-grams from 1 through n
input annotations columns currently used
Number elements per n-gram (>=1)
Gets annotation column name going to generate
Gets annotation column name going to generate
Input annotator type : TOKEN
Input annotator type : TOKEN
columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified
columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified
Minimum n-gram length, greater than or equal to 1.
Minimum n-gram length, greater than or equal to 1. Default: 2, bigram features
Output annotator type : CHUNK
Output annotator type : CHUNK
Glue character used to join the tokens
Whether to calculate just the actual n-grams or all n-grams from 1 through n
Overrides required annotators column if different than default
Overrides required annotators column if different than default
Number elements per n-gram (>=1)
Overrides annotation column name when transforming
Overrides annotation column name when transforming
Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content
Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content
Dataset[Row]
requirement for pipeline transformation validation.
requirement for pipeline transformation validation. It is called on fit()
takes a Dataset and checks to see if all the required annotation types are present.
takes a Dataset and checks to see if all the required annotation types are present.
to be validated
True if all the required types are present, else false
Required input and expected output annotator types
A feature transformer that converts the input array of strings (annotatorType TOKEN) into an array of n-grams (annotatorType CHUNK). Null values in the input array are ignored. It returns an array of n-grams where each n-gram is represented by a space-separated string of words.
When the input is empty, an empty array is returned. When the input array length is less than n (number of elements per n-gram), no n-grams are returned.
See https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/NGramGeneratorTestSpec.scala for reference on how to use this API.