Class/Object

com.johnsnowlabs.nlp.annotators.spell.symmetric

SymmetricDeleteModel

Related Docs: object SymmetricDeleteModel | package symmetric

Permalink

class SymmetricDeleteModel extends AnnotatorModel[SymmetricDeleteModel] with SymmetricDeleteParams with LevenshteinDistance

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
LevenshteinDistance, 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. LevenshteinDistance
  3. SymmetricDeleteParams
  4. AnnotatorModel
  5. RawAnnotator
  6. HasOutputAnnotationCol
  7. HasInputAnnotationCols
  8. HasOutputAnnotatorType
  9. ParamsAndFeaturesWritable
  10. HasFeatures
  11. DefaultParamsWritable
  12. MLWritable
  13. Model
  14. Transformer
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Serializable
  20. Identifiable
  21. AnyRef
  22. 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

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. def check(originalWord: String): Option[String]

    Permalink
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  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 derivedWords: MapFeature[String, (List[String], Long)]

    Permalink
    Attributes
    protected
  21. 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
  22. val dictionary: MapFeature[String, Long]

    Permalink
    Attributes
    protected
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  41. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  42. def getLongestWordLength: Int

    Permalink
  43. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  44. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  46. def getSuggestedCorrections(word: String): Option[(String, (Long, Int))]

    Permalink

    Return list of suggested corrections for potentially incorrectly spelled word

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

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

    Permalink
    Definition Classes
    Params
  49. def hasParent: Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. 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
  54. 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
  55. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def levenshteinDistance(s1: String, s2: String): Int

    Permalink

    Computes Levenshtein distance : Metric of measuring difference between two sequences (edit distance) Source: https://rosettacode.org/wiki/Levenshtein_distance

    Computes Levenshtein distance : Metric of measuring difference between two sequences (edit distance) Source: https://rosettacode.org/wiki/Levenshtein_distance

    Definition Classes
    LevenshteinDistance
  61. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  74. val maxEditDistance: IntParam

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  79. 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
  80. final val outputCol: Param[String]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  97. def setDerivedWords(value: Map[String, (List[String], Long)]): SymmetricDeleteModel.this.type

    Permalink
  98. def setDictionary(value: Map[String, Long]): SymmetricDeleteModel

    Permalink
  99. final def setInputCols(value: String*): SymmetricDeleteModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  100. 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
  101. def setLongestWordLength(value: Int): SymmetricDeleteModel.this.type

    Permalink
  102. def setMaxEditDistance(value: Int): SymmetricDeleteModel.this.type

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  107. 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
  108. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  110. 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
  111. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
  113. val uid: String

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

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from LevenshteinDistance

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