Packages

c

com.johnsnowlabs.nlp.annotators.spell.context

ContextSpellCheckerApproach

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()
  2. new ContextSpellCheckerApproach(uid: String)

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType
  2. implicit class ArrayHelper 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 $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): ContextSpellCheckerModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. def addRegexClass(usrLabel: String, usrRegex: String, userDist: Int = 3): ContextSpellCheckerApproach
  11. def addVocabClass(usrLabel: String, vocabList: ArrayList[String], userDist: Int = 3): ContextSpellCheckerApproach
  12. final def asInstanceOf[T0]: T0
    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)]
    Definition Classes
    WeightedLevenshtein
  14. val batchSize: IntParam
  15. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  16. val caseStrategy: IntParam
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. val classCount: Param[Double]
  19. final def clear(param: Param[_]): ContextSpellCheckerApproach.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. val compoundCount: Param[Int]
  22. def computeClasses(vocab: HashMap[String, Double], total: Double, k: Int): Map[String, (Int, Int)]
  23. val configProtoBytes: IntArrayParam
  24. final def copy(extra: ParamMap): Estimator[ContextSpellCheckerModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  25. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  26. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. val description: String
    Definition Classes
    ContextSpellCheckerApproach → AnnotatorApproach
  28. val epochs: IntParam
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  31. val errorThreshold: FloatParam
  32. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  33. def explainParams(): String
    Definition Classes
    Params
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  37. val finalRate: FloatParam
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. final def fit(dataset: Dataset[_]): ContextSpellCheckerModel
    Definition Classes
    AnnotatorApproach → Estimator
  40. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[ContextSpellCheckerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  41. def fit(dataset: Dataset[_], paramMap: ParamMap): ContextSpellCheckerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  42. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ContextSpellCheckerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  43. def genVocab(dataset: Dataset[_]): (HashMap[String, Double], Map[String, (Int, Int)])
  44. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  45. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  46. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  47. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  48. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  49. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. def getConfigProtoBytes: Option[Array[Byte]]
  51. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  52. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  53. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  54. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  55. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  56. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  57. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  58. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  59. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  60. val initialRate: FloatParam
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. val inputAnnotatorTypes: Array[String]

    Annotator reference id.

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

    Definition Classes
    ContextSpellCheckerApproach → HasInputAnnotationCols
  64. 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
  65. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  66. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  67. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  68. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  69. val languageModelClasses: Param[Int]
  70. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  71. def learnDist(s1: String, s2: String): Seq[(String, String)]
    Definition Classes
    WeightedLevenshtein
  72. def levenshteinDist(s11: String, s22: String)(cost: (String, String) ⇒ Float): Float
    Definition Classes
    WeightedLevenshtein
  73. def loadWeights(filename: String): Map[String, Map[String, Float]]
    Definition Classes
    WeightedLevenshtein
  74. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  75. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  82. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. val maxCandidates: IntParam
  87. val maxSentLen: IntParam
  88. val maxWindowLen: IntParam
  89. val minCount: Param[Double]
  90. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  91. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  92. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  93. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  94. def onTrained(model: ContextSpellCheckerModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  95. val outputAnnotatorType: AnnotatorType
    Definition Classes
    ContextSpellCheckerApproach → HasOutputAnnotatorType
  96. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  97. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  98. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  99. def set[T](feature: StructFeature[T], value: T): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def set[T](feature: SetFeature[T], value: Set[T]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def set[T](feature: ArrayFeature[T], value: Array[T]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. final def set(paramPair: ParamPair[_]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  104. final def set(param: String, value: Any): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  105. final def set[T](param: Param[T], value: T): ContextSpellCheckerApproach.this.type
    Definition Classes
    Params
  106. def setBatchSize(k: Int): ContextSpellCheckerApproach.this.type
  107. def setBlackListMinFreq(k: Int): ContextSpellCheckerApproach.this.type
  108. def setCaseStrategy(k: Int): ContextSpellCheckerApproach.this.type
  109. def setClassThreshold(t: Double): ContextSpellCheckerApproach.this.type
  110. def setConfigProtoBytes(bytes: Array[Int]): ContextSpellCheckerApproach
  111. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  113. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  114. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  115. final def setDefault(paramPairs: ParamPair[_]*): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  116. final def setDefault[T](param: Param[T], value: T): ContextSpellCheckerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  117. def setEpochs(k: Int): ContextSpellCheckerApproach.this.type
  118. def setErrorThreshold(t: Float): ContextSpellCheckerApproach.this.type
  119. def setFinalLearningRate(r: Float): ContextSpellCheckerApproach.this.type
  120. def setInitialLearningRate(r: Float): ContextSpellCheckerApproach.this.type
  121. final def setInputCols(value: String*): ContextSpellCheckerApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  122. final def setInputCols(value: Array[String]): ContextSpellCheckerApproach.this.type

    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
  124. def setLazyAnnotator(value: Boolean): ContextSpellCheckerApproach.this.type
    Definition Classes
    CanBeLazy
  125. def setMaxCandidates(k: Int): ContextSpellCheckerApproach.this.type
  126. def setMaxWindowLen(w: Int): ContextSpellCheckerApproach.this.type
  127. def setMinCount(threshold: Double): ContextSpellCheckerApproach.this.type
  128. final def setOutputCol(value: String): ContextSpellCheckerApproach.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  129. def setSpecialClasses(parsers: List[SpecialClassParser]): ContextSpellCheckerApproach.this.type
  130. def setTradeoff(alpha: Float): ContextSpellCheckerApproach.this.type
  131. def setValidationFraction(r: Float): ContextSpellCheckerApproach.this.type
  132. def setWeights(filePath: String): ContextSpellCheckerApproach.this.type
  133. def setWordMaxDist(k: Int): ContextSpellCheckerApproach.this.type
  134. val specialClasses: Param[List[SpecialClassParser]]
  135. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  136. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  137. val tradeoff: Param[Float]
  138. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): ContextSpellCheckerModel
    Definition Classes
    ContextSpellCheckerApproach → AnnotatorApproach
  139. final def transformSchema(schema: StructType): StructType

    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
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  141. val uid: String
    Definition Classes
    ContextSpellCheckerApproach → Identifiable
  142. 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
    AnnotatorApproach
  143. val validationFraction: FloatParam
  144. def wLevenshteinDist(s1: String, s2: String, weights: Map[String, Map[String, Float]]): Float
    Definition Classes
    WeightedLevenshtein
  145. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  146. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  147. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  148. val weightedDistPath: Param[String]
  149. val wordMaxDistance: IntParam
  150. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from WeightedLevenshtein

Inherited from HasFeatures

Inherited from AnnotatorApproach[ContextSpellCheckerModel]

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