Class/Object

com.johnsnowlabs.nlp.annotators.spell.norvig

NorvigSweetingApproach

Related Docs: object NorvigSweetingApproach | package norvig

Permalink

class NorvigSweetingApproach extends AnnotatorApproach[NorvigSweetingModel] with NorvigSweetingParams

Linear Supertypes
NorvigSweetingParams, AnnotatorApproach[NorvigSweetingModel], DefaultParamsWritable, MLWritable, HasAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[NorvigSweetingModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NorvigSweetingApproach
  2. NorvigSweetingParams
  3. AnnotatorApproach
  4. DefaultParamsWritable
  5. MLWritable
  6. HasAnnotatorType
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NorvigSweetingApproach()

    Permalink
  2. new NorvigSweetingApproach(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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val annotatorType: AnnotatorType

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  8. val caseSensitive: BooleanParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  9. final def clear(param: Param[_]): NorvigSweetingApproach.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def copy(extra: ParamMap): Estimator[NorvigSweetingModel]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. val corpus: ExternalResourceParam

    Permalink
  14. final def defaultCopy[T <: Params](extra: ParamMap): T

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

    Permalink
  16. val dictionary: ExternalResourceParam

    Permalink
  17. val doubleVariants: BooleanParam

    Permalink
    Definition Classes
    NorvigSweetingParams
  18. val dupsLimit: IntParam

    Permalink
    Attributes
    protected
  19. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

    Permalink
    Definition Classes
    Params
  27. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  32. final def get[T](param: Param[T]): Option[T]

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

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

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

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  37. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. 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
  45. val intersections: IntParam

    Permalink
    Attributes
    protected
  46. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  65. def onTrained(model: NorvigSweetingModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  66. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  68. val reductLimit: IntParam

    Permalink
    Attributes
    protected
  69. val requiredAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Annotator reference id.

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

    Definition Classes
    NorvigSweetingApproachHasInputAnnotationCols
  70. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  71. final def set(paramPair: ParamPair[_]): NorvigSweetingApproach.this.type

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

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

    Permalink
    Definition Classes
    Params
  74. def setCaseSensitive(value: Boolean): NorvigSweetingApproach.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  75. def setCorpus(path: String, tokenPattern: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): NorvigSweetingApproach.this.type

    Permalink
  76. def setCorpus(value: ExternalResource): NorvigSweetingApproach.this.type

    Permalink
  77. final def setDefault(paramPairs: ParamPair[_]*): NorvigSweetingApproach.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  79. def setDictionary(path: String, tokenPattern: String = "\\S+", readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): NorvigSweetingApproach.this.type

    Permalink
  80. def setDictionary(value: ExternalResource): NorvigSweetingApproach.this.type

    Permalink
  81. def setDoubleVariants(value: Boolean): NorvigSweetingApproach.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  82. def setDupsLimit(v: Int): NorvigSweetingApproach

    Permalink
  83. final def setInputCols(value: String*): NorvigSweetingApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  85. def setIntersections(v: Int): NorvigSweetingApproach

    Permalink
  86. final def setOutputCol(value: String): NorvigSweetingApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  87. def setReductLimit(v: Int): NorvigSweetingApproach

    Permalink
  88. def setShortCircuit(value: Boolean): NorvigSweetingApproach.this.type

    Permalink
    Definition Classes
    NorvigSweetingParams
  89. def setVowelSwapLimit(v: Int): NorvigSweetingApproach

    Permalink
  90. def setWordSizeIgnore(v: Int): NorvigSweetingApproach

    Permalink
  91. val shortCircuit: BooleanParam

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  94. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): NorvigSweetingModel

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

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

    Permalink
    Definition Classes
    NorvigSweetingApproach → Identifiable
  98. 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
  99. val vowelSwapLimit: IntParam

    Permalink
    Attributes
    protected
  100. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. val wordSizeIgnore: IntParam

    Permalink

    params

    params

    Attributes
    protected
  104. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from NorvigSweetingParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[NorvigSweetingModel]

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