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], DefaultParamsWritable, MLWritable, HasAnnotatorType, 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. DefaultParamsWritable
  6. MLWritable
  7. HasAnnotatorType
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. 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
    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: 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. val annotatorType: AnnotatorType

    Permalink
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. 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
  12. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  13. val blacklistMinFreq: Param[Int]

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def computeAndPersistClasses(vocab: HashMap[String, Double], total: Double, k: Int): Map[String, (Int, Int)]

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

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

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

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

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

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  27. final def extractParamMap(): ParamMap

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  35. def genVocab(rawDataPath: String): (List[(String, Double)], Map[String, (Int, Int)])

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

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

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

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

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

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

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

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  44. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  45. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  58. def learnDist(s1: String, s2: String): Seq[(String, String)]

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

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

    Permalink
    Definition Classes
    WeightedLevenshtein
  61. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  74. val minCount: Param[Double]

    Permalink
  75. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnnotatorApproach
  79. val openClose: List[OpenClose]

    Permalink
  80. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  82. val prefixes: ArrayFeature[String]

    Permalink
  83. val requiredAnnotatorTypes: 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
  84. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  92. def setBlackListMinFreq(k: Int): ContextSpellCheckerApproach.this.type

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. final def setInputCols(value: String*): ContextSpellCheckerApproach.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  100. 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
  101. def setLMClasses(k: Int): ContextSpellCheckerApproach.this.type

    Permalink
  102. def setMaxCandidates(k: Int): ContextSpellCheckerApproach.this.type

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

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  105. def setPrefixes(p: Array[String]): ContextSpellCheckerApproach.this.type

    Permalink
  106. def setSpecialClasses(parsers: List[SpecialClassParser]): ContextSpellCheckerApproach.this.type

    Permalink
  107. def setSuffixes(s: Array[String]): ContextSpellCheckerApproach.this.type

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

    Permalink
  109. def setTrainCorpusPath(path: String): ContextSpellCheckerApproach.this.type

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

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

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

    Permalink
  113. val suffixes: ArrayFeature[String]

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

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

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

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

    Permalink
  118. val trainCorpusPath: Param[String]

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

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

    Permalink
    Definition Classes
    ContextSpellCheckerApproach → Identifiable
  122. 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
  123. def wLevenshteinDist(s1: String, s2: String, weights: Map[String, Map[String, Float]]): Float

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

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

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

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

    Permalink
  128. val wordMaxDistance: IntParam

    Permalink
  129. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from WeightedLevenshtein

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

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