Class/Object

com.johnsnowlabs.nlp.annotators

NormalizerModel

Related Docs: object NormalizerModel | package annotators

Permalink

class NormalizerModel extends AnnotatorModel[NormalizerModel]

Annotator that cleans out tokens. Requires stems, hence tokens.

Removes all dirty characters from text following a regex pattern and transforms words based on a provided dictionary

See https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/NormalizerTestSpec.scala for examples on how to use the API

Linear Supertypes
AnnotatorModel[NormalizerModel], CanBeLazy, RawAnnotator[NormalizerModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[NormalizerModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NormalizerModel
  2. AnnotatorModel
  3. CanBeLazy
  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 NormalizerModel()

    Permalink
  2. new NormalizerModel(uid: String)

    Permalink

    uid

    required internal uid for saving annotator

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    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

    Permalink
    Definition Classes
    HasOutputAnnotatorType
  3. case class TokenizerAndNormalizerMap(beginTokenizer: Int, endTokenizer: Int, token: String, beginNormalizer: Int, endNormalizer: Int, normalizer: String) extends Product with Serializable

    Permalink

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 _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

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

    Permalink

    ToDo: Review implementation, Current implementation generates spaces between non-words, potentially breaking tokens

    ToDo: Review implementation, Current implementation generates spaces between non-words, potentially breaking tokens

    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
    NormalizerModelAnnotatorModel
  12. def applyRegexPatterns(word: String): String

    Permalink
  13. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. val cleanupPatterns: StringArrayParam

    Permalink

    normalization regex patterns which match will be removed from token

  17. final def clear(param: Param[_]): NormalizerModel.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def copy(extra: ParamMap): NormalizerModel

    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. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  39. def getCleanupPatterns: Array[String]

    Permalink

    Regular expressions list for normalization, defaults [^A-Za-z]

  40. final def getDefault[T](param: Param[T]): Option[T]

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  42. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  43. def getLowercase: Boolean

    Permalink

    Lowercase tokens, default true

  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. def getSlangDict: Map[String, String]

    Permalink

    Txt file with delimited words to be transformed into something else

    Txt file with delimited words to be transformed into something else

    Attributes
    protected
  48. def getSlangMatchCase: Boolean

    Permalink

    Whether to convert string to lowercase or not while checking

  49. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  51. def hasParent: Boolean

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

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

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

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

    Permalink

    Input annotator type : TOKEN

    Input annotator type : TOKEN

    Definition Classes
    NormalizerModelHasInputAnnotationCols
  56. 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
  57. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  62. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. val lowercase: BooleanParam

    Permalink

    whether to convert strings to lowercase

  75. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  76. final def ne(arg0: AnyRef): Boolean

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

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

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

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

    Permalink

    Output annotator type : TOKEN

    Output annotator type : TOKEN

    Definition Classes
    NormalizerModelHasOutputAnnotatorType
  81. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  83. var parent: Estimator[NormalizerModel]

    Permalink
    Definition Classes
    Model
  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): NormalizerModel.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  92. def setCleanupPatterns(value: Array[String]): NormalizerModel.this.type

    Permalink

    Regular expressions list for normalization, defaults [^A-Za-z]

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

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

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

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

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

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

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

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  101. def setLazyAnnotator(value: Boolean): NormalizerModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  102. def setLowercase(value: Boolean): NormalizerModel.this.type

    Permalink

    Lowercase tokens, default true

  103. final def setOutputCol(value: String): NormalizerModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  104. def setParent(parent: Estimator[NormalizerModel]): NormalizerModel

    Permalink
    Definition Classes
    Model
  105. def setSlangDict(value: Map[String, String]): NormalizerModel.this.type

    Permalink

    Txt file with delimited words to be transformed into something else

  106. def setSlangMatchCase(value: Boolean): NormalizerModel.this.type

    Permalink

    Whether to convert string to lowercase or not while checking

  107. val slangDict: MapFeature[String, String]

    Permalink

    slangDict

    slangDict

    Attributes
    protected
  108. val slangMatchCase: BooleanParam

    Permalink

    whether or not to be case sensitive to match slangs.

    whether or not to be case sensitive to match slangs. Defaults to false.

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  111. 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
  112. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  114. 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
  115. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    required internal uid for saving annotator

    required internal uid for saving annotator

    Definition Classes
    NormalizerModel → Identifiable
  117. 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
  118. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. def wrapColumnMetadata(col: Column): Column

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from CanBeLazy

Inherited from RawAnnotator[NormalizerModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NormalizerModel]

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

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters