Class/Object

com.johnsnowlabs.nlp.annotators

NormalizerModel

Related Docs: object NormalizerModel | package annotators

Permalink

class NormalizerModel extends AnnotatorModel[NormalizerModel]

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

Instance Constructors

  1. new NormalizerModel()

    Permalink
  2. new NormalizerModel(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: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. 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
  9. val annotatorType: AnnotatorType

    Permalink
    Definition Classes
    NormalizerModelHasAnnotatorType
  10. def applyRegexPatterns(word: String): String

    Permalink
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. final def clear(param: Param[_]): NormalizerModel.this.type

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  29. def getAnnotation(word: String, token: Annotation, finalWords: Array[String], index: Int): Annotation

    Permalink
  30. final def getClass(): Class[_]

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

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

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  34. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  36. def getSlangDict: Map[String, String]

    Permalink
    Attributes
    protected
  37. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  39. def hasParent: Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable
  65. final val outputCol: Param[String]

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

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

    Permalink
    Definition Classes
    Model
  68. val patterns: StringArrayParam

    Permalink
  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
    NormalizerModelHasInputAnnotationCols
  70. def save(path: String): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  77. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NormalizerModel.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  83. 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
  84. def setLowercase(value: Boolean): NormalizerModel.this.type

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

    Permalink
    Definition Classes
    Model
  87. def setPatterns(value: Array[String]): NormalizerModel.this.type

    Permalink
  88. def setSlangDict(value: Map[String, String]): NormalizerModel.this.type

    Permalink
  89. val slangDict: MapFeature[String, String]

    Permalink
    Attributes
    protected
  90. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from TransformModelSchema

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasAnnotatorType

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

Ungrouped