Class/Object

com.johnsnowlabs.nlp.annotators

Lemmatizer

Related Docs: object Lemmatizer | package annotators

Permalink

class Lemmatizer extends AnnotatorApproach[LemmatizerModel]

Class to find standarized lemmas from words. Uses a user-provided or default dictionary.

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

Instance Constructors

  1. new Lemmatizer()

    Permalink
  2. new Lemmatizer(uid: String)

    Permalink

    uid

    required internal uid provided by constructor

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

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  8. final def clear(param: Param[_]): Lemmatizer.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    LemmatizerAnnotatorApproach
  14. val dictionary: ExternalResourceParam

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  29. def getDictionary: ExternalResource

    Permalink
  30. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  32. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  60. def onTrained(model: LemmatizerModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  61. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    LemmatizerHasOutputAnnotatorType
  62. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  64. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  68. final def setDefault(paramPairs: ParamPair[_]*): Lemmatizer.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  70. def setDictionary(path: String, keyDelimiter: String, valueDelimiter: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): Lemmatizer.this.type

    Permalink
  71. def setDictionary(value: ExternalResource): Lemmatizer.this.type

    Permalink
  72. final def setInputCols(value: String*): Lemmatizer.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  74. final def setOutputCol(value: String): Lemmatizer.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  75. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Definition Classes
    LemmatizerAnnotatorApproach
  78. 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
  79. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    required internal uid provided by constructor

    required internal uid provided by constructor

    Definition Classes
    Lemmatizer → Identifiable
  81. 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
    AnnotatorApproach
  82. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[LemmatizerModel]

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