Class/Object

com.johnsnowlabs.nlp.annotators.spell.norvig

NorvigSweetingModel

Related Docs: object NorvigSweetingModel | package norvig

Permalink

class NorvigSweetingModel extends AnnotatorModel[NorvigSweetingModel] with NorvigSweetingParams

Linear Supertypes
NorvigSweetingParams, AnnotatorModel[NorvigSweetingModel], RawAnnotator[NorvigSweetingModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[NorvigSweetingModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NorvigSweetingModel
  2. NorvigSweetingParams
  3. AnnotatorModel
  4. RawAnnotator
  5. HasOutputAnnotationCol
  6. HasInputAnnotationCols
  7. HasOutputAnnotatorType
  8. ParamsAndFeaturesWritable
  9. HasFeatures
  10. DefaultParamsWritable
  11. MLWritable
  12. Model
  13. Transformer
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NorvigSweetingModel()

    Permalink

    Annotator reference id.

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

  2. new NorvigSweetingModel(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

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 afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    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
    NorvigSweetingModelAnnotatorModel
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  13. val caseSensitive: BooleanParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkSpellWord(raw: String): (String, Double)

    Permalink
  16. final def clear(param: Param[_]): NorvigSweetingModel.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def computeDoubleVariants(word: String): Set[String]

    Permalink

    variants of variants of a word

  19. def copy(extra: ParamMap): NorvigSweetingModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  20. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. def dfAnnotate: UserDefinedFunction

    Permalink

    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

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  23. val doubleVariants: BooleanParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  24. val dupsLimit: IntParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  25. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. final def extractParamMap(): ParamMap

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. val frequencyPriority: BooleanParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  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. def getCaseSensitive: Boolean

    Permalink
    Definition Classes
    NorvigSweetingParams
  42. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  44. def getDoubleVariants: Boolean

    Permalink
    Definition Classes
    NorvigSweetingParams
  45. def getDupsLimit: Int

    Permalink
    Definition Classes
    NorvigSweetingParams
  46. def getFrequencyOrHammingRecommendation(wordsByFrequency: List[(String, Long)], wordsByHamming: List[(String, Long)], input: String): (Option[String], Double)

    Permalink
  47. def getFrequencyPriority: Boolean

    Permalink
    Definition Classes
    NorvigSweetingParams
  48. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  49. def getIntersections: Int

    Permalink
    Definition Classes
    NorvigSweetingParams
  50. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  51. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  53. def getReductLimit: Int

    Permalink
    Definition Classes
    NorvigSweetingParams
  54. def getResult(wordsByFrequency: List[(String, Long)], wordsByHamming: List[(String, Long)], input: String): (String, Double)

    Permalink
  55. def getResultByFrequency(wordsByFrequency: List[(String, Long)]): (Option[String], Double)

    Permalink
  56. def getResultByHamming(wordsByHamming: List[(String, Long)]): (Option[String], Double)

    Permalink
  57. def getScoreFrequency(word: String): Double

    Permalink
  58. def getShortCircuit: Boolean

    Permalink
    Definition Classes
    NorvigSweetingParams
  59. def getSortedWordsByFrequency(words: List[String], input: String): List[(String, Long)]

    Permalink
  60. def getSortedWordsByHamming(words: List[String], input: String): List[(String, Long)]

    Permalink
  61. def getVowelSwapLimit: Int

    Permalink
    Definition Classes
    NorvigSweetingParams
  62. def getWordCount: Map[String, Long]

    Permalink
    Attributes
    protected
  63. def getWordSizeIgnore: Int

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

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

    Permalink
    Definition Classes
    Params
  66. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  67. def hashCode(): Int

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Annotator reference id.

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

    Definition Classes
    NorvigSweetingModelHasInputAnnotationCols
  71. 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
  72. val intersections: IntParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  73. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  89. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  90. def normalizeFrequencyValue(value: Long): Double

    Permalink
  91. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  93. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  94. val outputAnnotatorType: AnnotatorType

    Permalink
  95. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  97. var parent: Estimator[NorvigSweetingModel]

    Permalink
    Definition Classes
    Model
  98. val reductLimit: IntParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  99. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  107. def setCaseSensitive(value: Boolean): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  108. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NorvigSweetingModel.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  114. def setDoubleVariants(value: Boolean): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  115. def setDupsLimit(value: Int): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  116. def setFrequencyPriority(value: Boolean): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  117. final def setInputCols(value: String*): NorvigSweetingModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  119. def setIntersections(value: Int): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  120. final def setOutputCol(value: String): NorvigSweetingModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  121. def setParent(parent: Estimator[NorvigSweetingModel]): NorvigSweetingModel

    Permalink
    Definition Classes
    Model
  122. def setReductLimit(value: Int): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  123. def setShortCircuit(value: Boolean): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  124. def setVowelSwapLimit(value: Int): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  125. def setWordCount(value: Map[String, Long]): NorvigSweetingModel.this.type

    Permalink
  126. def setWordSizeIgnore(value: Int): NorvigSweetingModel.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  127. val shortCircuit: BooleanParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  128. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  130. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    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
  131. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  132. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  133. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  134. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    NorvigSweetingModel → Identifiable
  136. 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
    RawAnnotator
  137. val vowelSwapLimit: IntParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  138. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  141. val wordCount: MapFeature[String, Long]

    Permalink
    Attributes
    protected
  142. val wordSizeIgnore: IntParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  143. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  144. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from NorvigSweetingParams

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NorvigSweetingModel]

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

Ungrouped