Class/Object

com.johnsnowlabs.nlp.annotators.spell.symmetric

SymmetricDeleteApproach

Related Docs: object SymmetricDeleteApproach | package symmetric

Permalink

class SymmetricDeleteApproach extends AnnotatorApproach[SymmetricDeleteModel] with SymmetricDeleteParams

Created by danilo 16/04/2018, Symmetric Delete spelling correction algorithm. It retrieves tokens and utilizes distance metrics to compute possible derived words.

Inspired by https://github.com/wolfgarbe/SymSpell

See https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/spell/symmetric/SymmetricDeleteModelTestSpec.scala for further reference.

Linear Supertypes
SymmetricDeleteParams, AnnotatorApproach[SymmetricDeleteModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[SymmetricDeleteModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. SymmetricDeleteApproach
  2. SymmetricDeleteParams
  3. AnnotatorApproach
  4. CanBeLazy
  5. DefaultParamsWritable
  6. MLWritable
  7. HasOutputAnnotatorType
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SymmetricDeleteApproach()

    Permalink
  2. new SymmetricDeleteApproach(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): SymmetricDeleteModel

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  8. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  9. final def clear(param: Param[_]): SymmetricDeleteApproach.this.type

    Permalink
    Definition Classes
    Params
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def copy(extra: ParamMap): Estimator[SymmetricDeleteModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. val deletesThreshold: IntParam

    Permalink

    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. Defaults to 0

    Definition Classes
    SymmetricDeleteParams
  15. def derivedWordDistances(wordFrequencies: List[(String, Long)], maxEditDistance: Int): Map[String, (List[String], Long)]

    Permalink

    Created by danilo 26/04/2018 Computes derived words from a frequency of words

  16. val description: String

    Permalink

    Spell checking algorithm inspired on Symmetric Delete algorith

    Spell checking algorithm inspired on Symmetric Delete algorith

    Definition Classes
    SymmetricDeleteApproachAnnotatorApproach
  17. val dictionary: ExternalResourceParam

    Permalink

    file with a list of correct words

  18. val dupsLimit: IntParam

    Permalink

    maximum duplicate of characters in a word to consider.

    maximum duplicate of characters in a word to consider. Defaults to 2

    Definition Classes
    SymmetricDeleteParams
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  22. def explainParams(): String

    Permalink
    Definition Classes
    Params
  23. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  24. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def fit(dataset: Dataset[_]): SymmetricDeleteModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  27. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SymmetricDeleteModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  28. def fit(dataset: Dataset[_], paramMap: ParamMap): SymmetricDeleteModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  29. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SymmetricDeleteModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  30. val frequencyThreshold: IntParam

    Permalink

    minimum frequency of words to be considered from training.

    minimum frequency of words to be considered from training. Increase if training set is LARGE. Defaults to 0.

    Definition Classes
    SymmetricDeleteParams
  31. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  33. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  34. def getDeletes(word: String, med: Int): List[String]

    Permalink

    Created by danilo 14/04/2018 Given a word, derive strings with up to maxEditDistance characters deleted

  35. def getDeletesThreshold: Int

    Permalink

    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. Defaults to 0

    Definition Classes
    SymmetricDeleteParams
  36. def getDupsLimit: Int

    Permalink

    maximum duplicate of characters in a word to consider.

    maximum duplicate of characters in a word to consider. Defaults to 2

    Definition Classes
    SymmetricDeleteParams
  37. def getFrequencyThreshold: Int

    Permalink

    minimum frequency of words to be considered from training.

    minimum frequency of words to be considered from training. Increase if training set is LARGE. Defaults to 0.

    Definition Classes
    SymmetricDeleteParams
  38. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  39. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  40. def getMaxEditDistance: Int

    Permalink

    max edit distance characters to derive strings from a word

    max edit distance characters to derive strings from a word

    Definition Classes
    SymmetricDeleteParams
  41. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  42. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  43. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  44. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  45. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  46. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  47. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Input annotator type : TOKEN

    Input annotator type : TOKEN

    Definition Classes
    SymmetricDeleteApproachHasInputAnnotationCols
  50. final val inputCols: StringArrayParam

    Permalink

    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

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  51. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  52. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  53. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  54. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  56. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. val longestWordLength: IntParam

    Permalink

    length of longest word in corpus

    length of longest word in corpus

    Definition Classes
    SymmetricDeleteParams
  69. val maxEditDistance: IntParam

    Permalink

    max edit distance characters to derive strings from a word

    max edit distance characters to derive strings from a word

    Definition Classes
    SymmetricDeleteParams
  70. val maxFrequency: LongParam

    Permalink

    maximum frequency of a word in the corpus

    maximum frequency of a word in the corpus

    Definition Classes
    SymmetricDeleteParams
  71. val minFrequency: LongParam

    Permalink

    minimum frequency of a word in the corpus

    minimum frequency of a word in the corpus

    Definition Classes
    SymmetricDeleteParams
  72. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  73. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  74. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  75. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  76. def onTrained(model: SymmetricDeleteModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  77. val outputAnnotatorType: AnnotatorType

    Permalink

    Output annotator type : TOKEN

    Output annotator type : TOKEN

    Definition Classes
    SymmetricDeleteApproachHasOutputAnnotatorType
  78. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  79. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  80. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  81. final def set(paramPair: ParamPair[_]): SymmetricDeleteApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  82. final def set(param: String, value: Any): SymmetricDeleteApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  83. final def set[T](param: Param[T], value: T): SymmetricDeleteApproach.this.type

    Permalink
    Definition Classes
    Params
  84. final def setDefault(paramPairs: ParamPair[_]*): SymmetricDeleteApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  85. final def setDefault[T](param: Param[T], value: T): SymmetricDeleteApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  86. def setDeletesThreshold(value: Int): SymmetricDeleteApproach.this.type

    Permalink

    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. Defaults to 0

    Definition Classes
    SymmetricDeleteParams
  87. def setDictionary(path: String, tokenPattern: String = "\\S+", readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("format" -> "text")): SymmetricDeleteApproach.this.type

    Permalink

    Optional dictionary of properly written words.

    Optional dictionary of properly written words. If provided, significantly boosts spell checking performance

  88. def setDictionary(value: ExternalResource): SymmetricDeleteApproach.this.type

    Permalink

    Optional dictionary of properly written words.

    Optional dictionary of properly written words. If provided, significantly boosts spell checking performance

  89. def setDupsLimit(value: Int): SymmetricDeleteApproach.this.type

    Permalink

    maximum duplicate of characters in a word to consider.

    maximum duplicate of characters in a word to consider. Defaults to 2

    Definition Classes
    SymmetricDeleteParams
  90. def setFrequencyThreshold(value: Int): SymmetricDeleteApproach.this.type

    Permalink

    minimum frequency of words to be considered from training.

    minimum frequency of words to be considered from training. Increase if training set is LARGE. Defaults to 0.

    Definition Classes
    SymmetricDeleteParams
  91. final def setInputCols(value: String*): SymmetricDeleteApproach.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  92. final def setInputCols(value: Array[String]): SymmetricDeleteApproach.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  93. def setLazyAnnotator(value: Boolean): SymmetricDeleteApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  94. def setLongestWordLength(value: Int): SymmetricDeleteApproach.this.type

    Permalink

    length of longest word in corpus

    length of longest word in corpus

    Definition Classes
    SymmetricDeleteParams
  95. def setMaxEditDistance(value: Int): SymmetricDeleteApproach.this.type

    Permalink

    max edit distance characters to derive strings from a word

    max edit distance characters to derive strings from a word

    Definition Classes
    SymmetricDeleteParams
  96. def setMaxFrequency(value: Long): SymmetricDeleteApproach.this.type

    Permalink

    maximum frequency of a word in the corpus

    maximum frequency of a word in the corpus

    Definition Classes
    SymmetricDeleteParams
  97. def setMinFrequency(value: Long): SymmetricDeleteApproach.this.type

    Permalink

    minimum frequency of a word in the corpus

    minimum frequency of a word in the corpus

    Definition Classes
    SymmetricDeleteParams
  98. final def setOutputCol(value: String): SymmetricDeleteApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  99. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  100. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  101. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): SymmetricDeleteModel

    Permalink
  102. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  103. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  104. val uid: String

    Permalink
    Definition Classes
    SymmetricDeleteApproach → Identifiable
  105. def validate(schema: StructType): Boolean

    Permalink

    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.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  106. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from SymmetricDeleteParams

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[SymmetricDeleteModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters