com.johnsnowlabs.nlp.annotators.spell.symmetric
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
Minimum frequency of corrections a word needs to have to be considered from training.
Minimum frequency of corrections a word needs to have to be considered from training. Increase if training set is LARGE (Default: 0
).
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
Maximum duplicate of characters in a word to consider (Default: 2
).
Maximum duplicate of characters in a word to consider (Default: 2
).
Override for additional custom schema checks
Override for additional custom schema checks
Minimum frequency of words to be considered from training.
Minimum frequency of words to be considered from training. Increase if training set is LARGE (Default: 0
).
Minimum frequency of corrections a word needs to have to be considered from training.
Minimum frequency of corrections a word needs to have to be considered from training. Increase if training set is LARGE (Default: 0
).
Maximum duplicate of characters in a word to consider (Default: 2
).
Maximum duplicate of characters in a word to consider (Default: 2
).
Minimum frequency of words to be considered from training.
Minimum frequency of words to be considered from training. Increase if training set is LARGE (Default: 0
).
input annotations columns currently used
Max edit distance characters to derive strings from a word
Max edit distance characters to derive strings from a word
Gets annotation column name going to generate
Gets annotation column name going to generate
Return list of suggested corrections for potentially incorrectly spelled word
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
Length of longest word in corpus
Length of longest word in corpus
Max edit distance characters to derive strings from a word (Default: 3
)
Max edit distance characters to derive strings from a word (Default: 3
)
Maximum frequency of a word in the corpus
Maximum frequency of a word in the corpus
Minimum frequency of a word in the corpus
Minimum frequency of a word in the corpus
Output annotator type: TOKEN
Output annotator type: TOKEN
Minimum frequency of corrections a word needs to have to be considered from training.
Minimum frequency of corrections a word needs to have to be considered from training. Increase if training set is LARGE (Default: 0
).
Maximum duplicate of characters in a word to consider (Default: 2
)
Maximum duplicate of characters in a word to consider (Default: 2
)
Minimum frequency of words to be considered from training.
Minimum frequency of words to be considered from training. Increase if training set is LARGE (Default: 0
)
Overrides required annotators column if different than default
Overrides required annotators column if different than default
Length of longest word in corpus
Length of longest word in corpus
Max edit distance characters to derive strings from a word
Max edit distance characters to derive strings from a word
Maximum frequency of a word in the corpus
Maximum frequency of a word in the corpus
Minimum frequency of a word in the corpus
Minimum frequency of a word in the corpus
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
A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.
Required input and expected output annotator types
Symmetric Delete spelling correction algorithm.
The Symmetric Delete spelling correction algorithm reduces the complexity of edit candidate generation and dictionary lookup for a given Damerau-Levenshtein distance. It is six orders of magnitude faster (than the standard approach with deletes + transposes + replaces + inserts) and language independent.
Inspired by SymSpell.
Pretrained models can be loaded with
pretrained
of the companion object:The default model is
"spellcheck_sd"
, if no name is provided. For available pretrained models please see the Models Hub.See SymmetricDeleteModelTestSpec for further reference.
Example
ContextSpellCheckerModel for a DL based approach
NorvigSweetingModel for an alternative approach to spell checking