Packages

class ContextSpellCheckerModel extends AnnotatorModel[ContextSpellCheckerModel] with HasSimpleAnnotate[ContextSpellCheckerModel] with WeightedLevenshtein with WriteTensorflowModel with ParamsAndFeaturesWritable with HasTransducerFeatures with HasEngine

Implements a deep-learning based Noisy Channel Model Spell Algorithm. Correction candidates are extracted combining context information and word information.

Spell Checking is a sequence to sequence mapping problem. Given an input sequence, potentially containing a certain number of errors, ContextSpellChecker will rank correction sequences according to three things:

  1. Different correction candidates for each word — word level.
  2. The surrounding text of each word, i.e. it’s context — sentence level.
  3. The relative cost of different correction candidates according to the edit operations at the character level it requires — subword level.

For an in-depth explanation of the module see the article Applying Context Aware Spell Checking in Spark NLP.

This is the instantiated model of the ContextSpellCheckerApproach. For training your own model, please see the documentation of that class.

Pretrained models can be loaded with pretrained of the companion object:

val spellChecker = ContextSpellCheckerModel.pretrained()
  .setInputCols("token")
  .setOutputCol("checked")

The default model is "spellcheck_dl", if no name is provided. For available pretrained models please see the Models Hub.

For extended examples of usage, see the Examples and the ContextSpellCheckerTestSpec.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.DocumentAssembler
import com.johnsnowlabs.nlp.annotators.Tokenizer
import com.johnsnowlabs.nlp.annotators.spell.context.ContextSpellCheckerModel
import org.apache.spark.ml.Pipeline

val documentAssembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("doc")

val tokenizer = new Tokenizer()
  .setInputCols(Array("doc"))
  .setOutputCol("token")

val spellChecker = ContextSpellCheckerModel
  .pretrained()
  .setTradeOff(12.0f)
  .setInputCols("token")
  .setOutputCol("checked")

val pipeline = new Pipeline().setStages(Array(
  documentAssembler,
  tokenizer,
  spellChecker
))

val data = Seq("It was a cold , dreary day and the country was white with smow .").toDF("text")
val result = pipeline.fit(data).transform(data)

result.select("checked.result").show(false)
+--------------------------------------------------------------------------------+
|result                                                                          |
+--------------------------------------------------------------------------------+
|[It, was, a, cold, ,, dreary, day, and, the, country, was, white, with, snow, .]|
+--------------------------------------------------------------------------------+
See also

NorvigSweetingModel and SymmetricDeleteModel for alternative approaches to spell checking

Linear Supertypes
HasEngine, HasTransducerFeatures, WriteTensorflowModel, WeightedLevenshtein, HasSimpleAnnotate[ContextSpellCheckerModel], AnnotatorModel[ContextSpellCheckerModel], CanBeLazy, RawAnnotator[ContextSpellCheckerModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[ContextSpellCheckerModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ContextSpellCheckerModel
  2. HasEngine
  3. HasTransducerFeatures
  4. WriteTensorflowModel
  5. WeightedLevenshtein
  6. HasSimpleAnnotate
  7. AnnotatorModel
  8. CanBeLazy
  9. RawAnnotator
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. HasOutputAnnotatorType
  13. ParamsAndFeaturesWritable
  14. HasFeatures
  15. DefaultParamsWritable
  16. MLWritable
  17. Model
  18. Transformer
  19. PipelineStage
  20. Logging
  21. Params
  22. Serializable
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ContextSpellCheckerModel()

    Annotator reference id.

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

  2. new ContextSpellCheckerModel(uid: String)

    uid

    required uid for storing annotator to disk

Type Members

  1. type AnnotationContent = Seq[Row]

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType
  3. implicit class StringTools extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$(feature: TransducerSeqFeature): Seq[SpecialClassParser]
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  5. def $$(feature: TransducerFeature): VocabParser
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  6. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  9. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  10. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  12. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  13. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    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
    ContextSpellCheckerModel → HasSimpleAnnotate
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def backTrack(dist: Array[Array[Float]], s2: String, s1: String, j: Int, i: Int, acc: Seq[(String, String)]): Seq[(String, String)]
    Definition Classes
    WeightedLevenshtein
  16. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    ContextSpellCheckerModel → AnnotatorModel
  17. val caseStrategy: IntParam

    What case combinations to try when generating candidates (Default: CandidateStrategy.ALL).

  18. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  19. val classes: MapFeature[Int, (Int, Int)]

    Classes the spell checker recognizes

  20. final def clear(param: Param[_]): ContextSpellCheckerModel.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. val compareLowcase: BooleanParam

    If true will compare tokens in low case with vocabulary (Default: false)

  23. def computeMask(annotations: Seq[Annotation]): Array[Boolean]
  24. def computeTrellis(annotations: Seq[Annotation], mask: Seq[Boolean]): Array[Array[(String, Double, String)]]
  25. val configProtoBytes: IntArrayParam

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  26. def copy(extra: ParamMap): ContextSpellCheckerModel

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  27. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  28. val correctSymbols: BooleanParam

    Whether to correct special symbols or skip spell checking for them

  29. def decodeViterbi(trellis: Array[Array[(String, Double, String)]]): (Array[String], Double)
  30. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  31. def dfAnnotate: UserDefinedFunction

    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

    Definition Classes
    HasSimpleAnnotate
  32. val engine: Param[String]

    This param is set internally once via loadSavedModel.

    This param is set internally once via loadSavedModel. That's why there is no setter

    Definition Classes
    HasEngine
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. val errorThreshold: FloatParam

    Threshold perplexity for a word to be considered as an error.

  36. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  37. def explainParams(): String
    Definition Classes
    Params
  38. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  39. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  40. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  41. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  42. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  43. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  44. val gamma: FloatParam

    Controls the influence of individual word frequency in the decision (Default: 120.0f).

  45. def get(feature: TransducerSeqFeature): Option[Seq[SpecialClassParser]]
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  46. def get(feature: TransducerFeature): Option[VocabParser]
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  47. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  48. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  49. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  50. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  51. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  52. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. def getClassCandidates(transducer: ITransducer[Candidate], token: String, label: String, maxDist: Int, limit: Int = 2): Seq[(String, String, Float)]
  54. def getConfigProtoBytes: Option[Array[Byte]]

  55. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  56. def getEngine: String

    Definition Classes
    HasEngine
  57. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  58. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  59. def getModelIfNotSet: TensorflowSpell
  60. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  61. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  62. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  63. def getVocabCandidates(token: String, maxDist: Int): List[(String, String, Float)]
  64. def getWordClasses: Seq[(String, AnnotatorType)]

  65. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  66. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  67. def hasParent: Boolean
    Definition Classes
    Model
  68. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  69. val idsVocab: MapFeature[Int, String]

    Mapping of ids to vocabulary

  70. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  71. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. val inputAnnotatorTypes: Array[String]

    Input Annotator Types: TOKEN

    Input Annotator Types: TOKEN

    Definition Classes
    ContextSpellCheckerModel → HasInputAnnotationCols
  73. final val inputCols: StringArrayParam

    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
  74. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  75. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  76. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  77. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  78. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  79. def learnDist(s1: String, s2: String): Seq[(String, String)]
    Definition Classes
    WeightedLevenshtein
  80. def levenshteinDist(s11: String, s22: String)(cost: (String, String) ⇒ Float): Float
    Definition Classes
    WeightedLevenshtein
  81. def loadWeights(filename: String): Map[String, Map[String, Float]]
    Definition Classes
    WeightedLevenshtein
  82. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  83. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  90. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. val maxCandidates: IntParam

    Maximum number of candidates for every word (Default: 6).

  95. val maxWindowLen: IntParam

    Maximum size for the window used to remember history prior to every correction (Default: 5).

  96. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  97. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  98. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  99. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  100. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    ContextSpellCheckerModel → ParamsAndFeaturesWritable
  101. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  102. val outputAnnotatorType: AnnotatorType

    Output Annotator Types: TOKEN

    Output Annotator Types: TOKEN

    Definition Classes
    ContextSpellCheckerModel → HasOutputAnnotatorType
  103. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  104. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  105. var parent: Estimator[ContextSpellCheckerModel]
    Definition Classes
    Model
  106. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  107. def set(feature: TransducerSeqFeature, value: Seq[SpecialClassParser]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  108. def set(feature: TransducerFeature, value: VocabParser): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  109. def set[T](feature: StructFeature[T], value: T): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  110. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. def set[T](feature: SetFeature[T], value: Set[T]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. def set[T](feature: ArrayFeature[T], value: Array[T]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  113. final def set(paramPair: ParamPair[_]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  114. final def set(param: String, value: Any): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  115. final def set[T](param: Param[T], value: T): ContextSpellCheckerModel.this.type
    Definition Classes
    Params
  116. def setCaseStrategy(k: Int): ContextSpellCheckerModel.this.type

  117. def setClasses(c: Map[Int, (Int, Int)]): ContextSpellCheckerModel.this.type

  118. def setCompareLowcase(value: Boolean): ContextSpellCheckerModel.this.type

  119. def setConfigProtoBytes(bytes: Array[Int]): ContextSpellCheckerModel.this.type

  120. def setCorrectSymbols(value: Boolean): ContextSpellCheckerModel.this.type

  121. def setDefault(feature: TransducerSeqFeature, value: () ⇒ Seq[SpecialClassParser]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  122. def setDefault(feature: TransducerFeature, value: () ⇒ VocabParser): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasTransducerFeatures
  123. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  124. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  125. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  126. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  127. final def setDefault(paramPairs: ParamPair[_]*): ContextSpellCheckerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  128. final def setDefault[T](param: Param[T], value: T): ContextSpellCheckerModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  129. def setErrorThreshold(t: Float): ContextSpellCheckerModel.this.type

  130. def setGamma(g: Float): ContextSpellCheckerModel.this.type

  131. final def setInputCols(value: String*): ContextSpellCheckerModel.this.type
    Definition Classes
    HasInputAnnotationCols
  132. def setInputCols(value: Array[String]): ContextSpellCheckerModel.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  133. def setLazyAnnotator(value: Boolean): ContextSpellCheckerModel.this.type
    Definition Classes
    CanBeLazy
  134. def setMaxCandidates(k: Int): ContextSpellCheckerModel.this.type

  135. def setMaxWindowLen(w: Int): ContextSpellCheckerModel.this.type

  136. def setModelIfNotSet(spark: SparkSession, tensorflow: TensorflowWrapper): ContextSpellCheckerModel.this.type
  137. final def setOutputCol(value: String): ContextSpellCheckerModel.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  138. def setParent(parent: Estimator[ContextSpellCheckerModel]): ContextSpellCheckerModel
    Definition Classes
    Model
  139. def setSpecialClassesTransducers(transducers: Seq[SpecialClassParser]): ContextSpellCheckerModel.this.type

  140. def setTradeOff(lambda: Float): ContextSpellCheckerModel.this.type

  141. def setUseNewLines(useIt: Boolean): ContextSpellCheckerModel.this.type

  142. def setVocabFreq(v: Map[String, Double]): ContextSpellCheckerModel.this.type

  143. def setVocabIds(v: Map[String, Int]): ContextSpellCheckerModel.this.type

  144. def setVocabTransducer(trans: ITransducer[Candidate]): ContextSpellCheckerModel.this.type

  145. def setWeights(w: HashMap[String, HashMap[String, Double]]): ContextSpellCheckerModel.this.type

  146. def setWeights(w: Map[String, Map[String, Float]]): ContextSpellCheckerModel.this.type

  147. def setWordMaxDistance(k: Int): ContextSpellCheckerModel.this.type

  148. val specialTransducers: TransducerSeqFeature
  149. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  150. def toOption(boolean: Boolean): Option[Boolean]
  151. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  152. val tradeoff: FloatParam

    Tradeoff between the cost of a word and a transition in the language model (Default: 18.0f).

  153. val transducer: TransducerFeature
  154. final def transform(dataset: Dataset[_]): DataFrame

    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
  155. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  156. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  157. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  158. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  159. val uid: String
    Definition Classes
    ContextSpellCheckerModel → Identifiable
  160. def updateRegexClass(label: String, regex: String): ContextSpellCheckerModel
  161. def updateVocabClass(label: String, vocabList: ArrayList[String], append: Boolean = true): ContextSpellCheckerModel
  162. val useNewLines: BooleanParam

    When set to true new lines will be treated as any other character (Default: false).

    When set to true new lines will be treated as any other character (Default: false). When set to false correction is applied on paragraphs as defined by newline characters.

  163. def validate(schema: StructType): Boolean

    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
  164. val vocabFreq: MapFeature[String, Double]

    Frequency words from the vocabulary

  165. val vocabIds: MapFeature[String, Int]

    Mapping of vocabulary to ids

  166. def wLevenshteinDist(s1: String, s2: String, weights: Map[String, Map[String, Float]]): Float
    Definition Classes
    WeightedLevenshtein
  167. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  169. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  170. val weights: MapFeature[String, Map[String, Float]]
  171. val wordMaxDistance: IntParam

    Maximum distance for the generated candidates for every word, minimum 1.

  172. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  173. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  174. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String = "_use"): Unit
    Definition Classes
    WriteTensorflowModel
  175. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None): Unit
    Definition Classes
    WriteTensorflowModel
  176. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None, savedSignatures: Option[Map[String, String]] = None): Unit
    Definition Classes
    WriteTensorflowModel

Inherited from HasEngine

Inherited from HasTransducerFeatures

Inherited from WriteTensorflowModel

Inherited from WeightedLevenshtein

Inherited from HasSimpleAnnotate[ContextSpellCheckerModel]

Inherited from AnnotatorModel[ContextSpellCheckerModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[ContextSpellCheckerModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ContextSpellCheckerModel]

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

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters