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 inspired on https://github.com/wolfgarbe/SymSpell

Linear Supertypes
SymmetricDeleteParams, AnnotatorApproach[SymmetricDeleteModel], DefaultParamsWritable, MLWritable, HasAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[SymmetricDeleteModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SymmetricDeleteApproach
  2. SymmetricDeleteParams
  3. AnnotatorApproach
  4. DefaultParamsWritable
  5. MLWritable
  6. HasAnnotatorType
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. 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
    HasAnnotatorType
  2. case class WordFeatures(derivedWords: Map[String, (ListBuffer[String], Long)], longestWordLength: Int) 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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val annotatorType: AnnotatorType

    Permalink
  6. final def asInstanceOf[T0]: T0

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

    Permalink
    Definition Classes
    AnnotatorApproach
  8. final def clear(param: Param[_]): SymmetricDeleteApproach.this.type

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. val corpus: ExternalResourceParam

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. def derivedWordDistances(wordFrequencies: List[(String, Long)], maxEditDistance: Int): WordFeatures

    Permalink

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

  15. val description: String

    Permalink
  16. val dictionary: ExternalResourceParam

    Permalink
  17. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  22. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  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. 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. 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

  34. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  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. final def hasDefault[T](param: Param[T]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. val maxEditDistance: IntParam

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

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

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

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

    Permalink
    Definition Classes
    AnnotatorApproach
  65. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  67. 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
    SymmetricDeleteApproachHasInputAnnotationCols
  68. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  72. def setCorpus(path: String, tokenPattern: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): SymmetricDeleteApproach.this.type

    Permalink
  73. def setCorpus(value: ExternalResource): SymmetricDeleteApproach.this.type

    Permalink
  74. final def setDefault(paramPairs: ParamPair[_]*): SymmetricDeleteApproach.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  76. def setDictionary(path: String, tokenPattern: String = "\\S+", readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): SymmetricDeleteApproach.this.type

    Permalink
  77. def setDictionary(value: ExternalResource): SymmetricDeleteApproach.this.type

    Permalink
  78. final def setInputCols(value: String*): SymmetricDeleteApproach.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  79. 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
  80. def setMaxEditDistance(value: Int): SymmetricDeleteApproach.this.type

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

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

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

    Permalink
  85. 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
  86. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    SymmetricDeleteApproach → Identifiable
  88. 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
  89. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from SymmetricDeleteParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

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

Ungrouped