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], TransformModelSchema, HasOutputAnnotationCol, HasInputAnnotationCols, HasAnnotatorType, 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. TransformModelSchema
  5. HasOutputAnnotationCol
  6. HasInputAnnotationCols
  7. HasAnnotatorType
  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
    HasAnnotatorType

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: ArrayFeature[T]): Array[T]

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. 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
  9. val annotatorType: AnnotatorType

    Permalink

    Annotator reference id.

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

    Definition Classes
    SymmetricDeleteModelHasAnnotatorType
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def check(raw: String): Option[String]

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

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. val derivedWords: MapFeature[String, (ListBuffer[String], Long)]

    Permalink
    Attributes
    protected
  18. val dictionary: MapFeature[String, Long]

    Permalink
    Attributes
    protected
  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. val features: ArrayBuffer[Feature[_, _, _]]

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

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

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

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

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

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

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

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  34. def getLongestWordLength: Int

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

    Permalink
    Definition Classes
    Params
  36. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

    Permalink

    Return list of suggested corrections for potentially incorrectly spelled word

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

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

    Permalink
    Definition Classes
    Params
  41. def hasParent: Boolean

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. 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

  51. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. val longestWordLength: Param[Int]

    Permalink
  64. val maxEditDistance: IntParam

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable
  69. final val outputCol: Param[String]

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

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

    Permalink
    Definition Classes
    Model
  72. val requiredAnnotatorTypes: 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
  73. def save(path: String): Unit

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

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

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

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

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

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

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    TransformModelSchema
  99. def transformSchema(schema: StructType, logging: Boolean): StructType

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

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from SymmetricDeleteParams

Inherited from TransformModelSchema

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasAnnotatorType

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