Class

com.johnsnowlabs.nlp.annotators.spell.context

ContextSpellCheckerApproach

Related Doc: package context

Permalink

class ContextSpellCheckerApproach extends AnnotatorApproach[ContextSpellCheckerModel] with HasFeatures with WeightedLevenshtein

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

Instance Constructors

  1. new ContextSpellCheckerApproach()

    Permalink
  2. new ContextSpellCheckerApproach(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType
  2. implicit class ArrayHelper extends AnyRef

    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 _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): ContextSpellCheckerModel

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. def addRegexClass(usrLabel: String, usrRegex: String, userDist: Int = 3): ContextSpellCheckerApproach

    Permalink
  11. def addVocabClass(usrLabel: String, vocabList: ArrayList[String], userDist: Int = 3): ContextSpellCheckerApproach

    Permalink
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def backTrack(dist: Array[Array[Float]], s2: String, s1: String, j: Int, i: Int, acc: Seq[(String, String)]): Seq[(String, String)]

    Permalink
    Definition Classes
    WeightedLevenshtein
  14. val batchSize: IntParam

    Permalink
  15. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  16. val caseStrategy: IntParam

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. val classCount: Param[Double]

    Permalink
  19. final def clear(param: Param[_]): ContextSpellCheckerApproach.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. val compoundCount: Param[Int]

    Permalink
  22. def computeClasses(vocab: HashMap[String, Double], total: Double, k: Int): Map[String, (Int, Int)]

    Permalink
  23. val configProtoBytes: IntArrayParam

    Permalink
  24. final def copy(extra: ParamMap): Estimator[ContextSpellCheckerModel]

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  27. val description: String

    Permalink
  28. val epochs: IntParam

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. val errorThreshold: FloatParam

    Permalink
  32. def explainParam(param: Param[_]): String

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

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

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

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

    Permalink
    Definition Classes
    HasFeatures
  37. val finalRate: FloatParam

    Permalink
  38. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  43. def genVocab(dataset: Dataset[_]): (HashMap[String, Double], Map[String, (Int, Int)])

    Permalink
  44. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  50. def getConfigProtoBytes: Option[Array[Byte]]

    Permalink
  51. final def getDefault[T](param: Param[T]): Option[T]

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  53. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  54. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  55. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  60. val initialRate: FloatParam

    Permalink
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. val inputAnnotatorTypes: Array[String]

    Permalink

    Annotator reference id.

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. val languageModelClasses: Param[Int]

    Permalink
  70. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  71. def learnDist(s1: String, s2: String): Seq[(String, String)]

    Permalink
    Definition Classes
    WeightedLevenshtein
  72. def levenshteinDist(s11: String, s22: String)(cost: (String, String) ⇒ Float): Float

    Permalink
    Definition Classes
    WeightedLevenshtein
  73. def loadWeights(filename: String): Map[String, Map[String, Float]]

    Permalink
    Definition Classes
    WeightedLevenshtein
  74. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  86. val maxCandidates: IntParam

    Permalink
  87. val maxSentLen: IntParam

    Permalink
  88. val maxWindowLen: IntParam

    Permalink
  89. val minCount: Param[Double]

    Permalink
  90. def msgHelper(schema: StructType): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
  94. def onTrained(model: ContextSpellCheckerModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  95. val outputAnnotatorType: AnnotatorType

    Permalink
  96. final val outputCol: Param[String]

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  106. def setBatchSize(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  107. def setBlackListMinFreq(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  108. def setCaseStrategy(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  109. def setClassThreshold(t: Double): ContextSpellCheckerApproach.this.type

    Permalink
  110. def setConfigProtoBytes(bytes: Array[Int]): ContextSpellCheckerApproach

    Permalink
  111. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ContextSpellCheckerApproach.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  117. def setEpochs(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  118. def setErrorThreshold(t: Float): ContextSpellCheckerApproach.this.type

    Permalink
  119. def setFinalLearningRate(r: Float): ContextSpellCheckerApproach.this.type

    Permalink
  120. def setInitialLearningRate(r: Float): ContextSpellCheckerApproach.this.type

    Permalink
  121. final def setInputCols(value: String*): ContextSpellCheckerApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  123. def setLMClasses(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  124. def setLazyAnnotator(value: Boolean): ContextSpellCheckerApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  125. def setMaxCandidates(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  126. def setMaxWindowLen(w: Int): ContextSpellCheckerApproach.this.type

    Permalink
  127. def setMinCount(threshold: Double): ContextSpellCheckerApproach.this.type

    Permalink
  128. final def setOutputCol(value: String): ContextSpellCheckerApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  129. def setSpecialClasses(parsers: List[SpecialClassParser]): ContextSpellCheckerApproach.this.type

    Permalink
  130. def setTradeoff(alpha: Float): ContextSpellCheckerApproach.this.type

    Permalink
  131. def setValidationFraction(r: Float): ContextSpellCheckerApproach.this.type

    Permalink
  132. def setWeights(filePath: String): ContextSpellCheckerApproach.this.type

    Permalink
  133. def setWordMaxDist(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  134. val specialClasses: Param[List[SpecialClassParser]]

    Permalink
  135. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  137. val tradeoff: Param[Float]

    Permalink
  138. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): ContextSpellCheckerModel

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

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

    Permalink
    Definition Classes
    ContextSpellCheckerApproach → Identifiable
  142. 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
  143. val validationFraction: FloatParam

    Permalink
  144. def wLevenshteinDist(s1: String, s2: String, weights: Map[String, Map[String, Float]]): Float

    Permalink
    Definition Classes
    WeightedLevenshtein
  145. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  148. val weightedDistPath: Param[String]

    Permalink
  149. val wordMaxDistance: IntParam

    Permalink
  150. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from WeightedLevenshtein

Inherited from HasFeatures

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[ContextSpellCheckerModel]

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