Class/Object

com.johnsnowlabs.nlp.annotators.spell.symmetric

SymmetricDeleteModel

Related Docs: object SymmetricDeleteModel | package symmetric

Permalink

class SymmetricDeleteModel extends AnnotatorModel[SymmetricDeleteModel] with SymmetricDeleteParams

Created by danilo 16/04/2018, inspired on https://github.com/wolfgarbe/SymSpell

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.

Linear Supertypes
SymmetricDeleteParams, AnnotatorModel[SymmetricDeleteModel], RawAnnotator[SymmetricDeleteModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[SymmetricDeleteModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SymmetricDeleteModel
  2. SymmetricDeleteParams
  3. AnnotatorModel
  4. RawAnnotator
  5. HasOutputAnnotationCol
  6. HasInputAnnotationCols
  7. HasOutputAnnotatorType
  8. ParamsAndFeaturesWritable
  9. HasFeatures
  10. DefaultParamsWritable
  11. MLWritable
  12. Model
  13. Transformer
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SymmetricDeleteModel()

    Permalink
  2. new SymmetricDeleteModel(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType
  2. case class SuggestedWord(correction: String, frequency: Long, distance: Int, score: Double) extends Product with Serializable

    Permalink

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. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    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

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    SymmetricDeleteModelAnnotatorModel
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  14. def checkSpellWord(originalWord: String): (String, Double)

    Permalink
  15. final def clear(param: Param[_]): SymmetricDeleteModel.this.type

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

    Permalink
    Definition Classes
    SymmetricDeleteParams
  21. val derivedWords: MapFeature[String, (List[String], Long)]

    Permalink
    Attributes
    protected
  22. def dfAnnotate: UserDefinedFunction

    Permalink

    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

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  23. val dictionary: MapFeature[String, Long]

    Permalink
    Attributes
    protected
  24. val dupsLimit: IntParam

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

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

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

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

    Permalink
    Definition Classes
    Params
  29. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  33. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  34. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. val frequencyThreshold: IntParam

    Permalink
    Definition Classes
    SymmetricDeleteParams
  36. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  41. def getCaseWordType(word: String): Char

    Permalink
  42. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  44. def getDeletesThreshold: Int

    Permalink
    Definition Classes
    SymmetricDeleteParams
  45. def getDictionarySuggestions(word: String): Option[SuggestedWord]

    Permalink
  46. def getDupsLimit: Int

    Permalink
    Definition Classes
    SymmetricDeleteParams
  47. def getFrequencyThreshold: Int

    Permalink
    Definition Classes
    SymmetricDeleteParams
  48. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  49. def getMaxEditDistance: Int

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

    Permalink
    Definition Classes
    Params
  51. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  53. def getScoreFrequency(word: String): Double

    Permalink
  54. def getSuggestedCorrections(word: String): Option[SuggestedWord]

    Permalink

    Return list of suggested corrections for potentially incorrectly spelled word

  55. def getSymmetricSuggestions(word: String): Option[SuggestedWord]

    Permalink
  56. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  58. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  59. def hashCode(): Int

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

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

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

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    SymmetricDeleteModelHasInputAnnotationCols
  63. 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
  64. final def isDefined(param: Param[_]): Boolean

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

    Permalink
    Definition Classes
    Any
  66. def isNoisyWord(word: String): Boolean

    Permalink
  67. final def isSet(param: Param[_]): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SymmetricDeleteParams
  82. val maxEditDistance: IntParam

    Permalink
    Definition Classes
    SymmetricDeleteParams
  83. val maxFrequency: LongParam

    Permalink
    Definition Classes
    SymmetricDeleteParams
  84. val minFrequency: LongParam

    Permalink
    Definition Classes
    SymmetricDeleteParams
  85. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  86. def normalizeFrequencyValue(value: Long): Double

    Permalink
  87. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  89. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  90. val outputAnnotatorType: AnnotatorType

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    SymmetricDeleteModelHasOutputAnnotatorType
  91. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  93. var parent: Estimator[SymmetricDeleteModel]

    Permalink
    Definition Classes
    Model
  94. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  95. def set[T](feature: StructFeature[T], value: T): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[T](feature: SetFeature[T], value: Set[T]): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: ArrayFeature[T], value: Array[T]): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. final def set(paramPair: ParamPair[_]): SymmetricDeleteModel.this.type

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

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

    Permalink
    Definition Classes
    Params
  102. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): SymmetricDeleteModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. final def setDefault(paramPairs: ParamPair[_]*): SymmetricDeleteModel.this.type

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

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

    Permalink
    Definition Classes
    SymmetricDeleteParams
  109. def setDerivedWords(value: Map[String, (List[String], Long)]): SymmetricDeleteModel.this.type

    Permalink
  110. def setDictionary(value: Map[String, Long]): SymmetricDeleteModel.this.type

    Permalink
  111. def setDupsLimit(value: Int): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    SymmetricDeleteParams
  112. def setFrequencyThreshold(value: Int): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    SymmetricDeleteParams
  113. final def setInputCols(value: String*): SymmetricDeleteModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  115. def setLongestWordLength(value: Int): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    SymmetricDeleteParams
  116. def setMaxEditDistance(value: Int): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    SymmetricDeleteParams
  117. def setMaxFrequency(value: Long): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    SymmetricDeleteParams
  118. def setMinFrequency(value: Long): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    SymmetricDeleteParams
  119. final def setOutputCol(value: String): SymmetricDeleteModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  120. def setParent(parent: Estimator[SymmetricDeleteModel]): SymmetricDeleteModel

    Permalink
    Definition Classes
    Model
  121. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  123. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    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

    Dataset[Row]

    Definition Classes
    AnnotatorModel → Transformer
  124. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  125. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  126. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  127. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  128. def transformToOriginalCaseType(caseType: Char, word: String): String

    Permalink
  129. val uid: String

    Permalink
    Definition Classes
    SymmetricDeleteModel → Identifiable
  130. 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
    RawAnnotator
  131. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  135. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from SymmetricDeleteParams

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[SymmetricDeleteModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped