c

com.johnsnowlabs.nlp.annotators.classification

DocumentMLClassifierApproach

class DocumentMLClassifierApproach extends AnnotatorApproach[DocumentMLClassifierModel] with DocumentMLClassifierParams with CheckLicense

Trains a model to classify documents with a Logarithmic Regression algorithm. Training data requires columns for text and their label. The result is a trained DocumentMLClassifierModel.

Example

Define pipeline stages to prepare the data

val document_assembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")

val tokenizer = new Tokenizer()
  .setInputCols("document")
  .setOutputCol("token")

val normalizer = new Normalizer()
  .setInputCols("token")
  .setOutputCol("normalized")

val stopwords_cleaner = new StopWordsCleaner()
  .setInputCols("normalized")
  .setOutputCol("cleanTokens")
  .setCaseSensitive(false)

val stemmer = new Stemmer()
  .setInputCols("cleanTokens")
  .setOutputCol("stem")

Define the document classifier and fit training data to it

val logreg = new DocumentMLClassifierApproach()
  .setInputCols("stem")
  .setLabelCol("category")
  .setOutputCol("prediction")

val pipeline = new Pipeline().setStages(Array(
  document_assembler,
  tokenizer,
  normalizer,
  stopwords_cleaner,
  stemmer,
  logreg
))

val model = pipeline.fit(trainingData)
See also

DocumentMLClassifierModel for instantiated models

Linear Supertypes
CheckLicense, DocumentMLClassifierParams, AnnotatorApproach[DocumentMLClassifierModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[DocumentMLClassifierModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
FinanceDocumentMLClassifierApproach, LegalDocumentMLClassifierApproach
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DocumentMLClassifierApproach
  2. CheckLicense
  3. DocumentMLClassifierParams
  4. AnnotatorApproach
  5. CanBeLazy
  6. DefaultParamsWritable
  7. MLWritable
  8. HasOutputAnnotatorType
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentMLClassifierApproach()
  2. new DocumentMLClassifierApproach(uid: String)

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): DocumentMLClassifierModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  8. def calculateNgramsUdf: UserDefinedFunction
    Definition Classes
    DocumentMLClassifierParams
  9. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  10. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  11. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  12. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  13. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  14. val classificationModelClass: Param[String]

    specify the classification model if it has been already trained.

  15. val classificationModelPath: Param[String]

    specify the classification model if it has been already trained.

  16. final def clear(param: Param[_]): DocumentMLClassifierApproach.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def copy(extra: ParamMap): Estimator[DocumentMLClassifierModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  21. val description: String
    Definition Classes
    DocumentMLClassifierApproach → AnnotatorApproach
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  25. def explainParams(): String
    Definition Classes
    Params
  26. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  27. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. final def fit(dataset: Dataset[_]): DocumentMLClassifierModel
    Definition Classes
    AnnotatorApproach → Estimator
  30. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[DocumentMLClassifierModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  31. def fit(dataset: Dataset[_], paramMap: ParamMap): DocumentMLClassifierModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  32. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DocumentMLClassifierModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  33. val fitIntercept: Param[Boolean]

    whether to fit an intercept term (Default: true)

  34. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def getClassificationModelClass: String

    get the SparkML classification class to use

  37. def getClassificationModelPath: String

    get the classification model if it has been already trained.

  38. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  39. def getFitIntercept: Boolean

    get whether to fit an intercept term (Default: true)

  40. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  41. def getLabelCol: String

    column with the value result we are trying to predict.

  42. def getLabels: Array[String]

    array to output the label in the original form.

    array to output the label in the original form.

    Definition Classes
    DocumentMLClassifierParams
  43. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  44. def getMaxIter: Int

    maximum number of iterations (Default: 10)

  45. def getMaxTokenNgramFingerprint: Int
    Definition Classes
    DocumentMLClassifierParams
  46. def getMergeChunks: Boolean

    whether to merge all chunks in a document or not (Default: false)

    whether to merge all chunks in a document or not (Default: false)

    Definition Classes
    DocumentMLClassifierParams
  47. def getMinTokenNgramFingerprint: Int
    Definition Classes
    DocumentMLClassifierParams
  48. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  49. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  50. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  51. def getTol: Double

    get convergence tolerance after each iteration (Default: 1e-6)

  52. def getVectorizationModelPath: String

    get the vectorization model if it has been already trained.

  53. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  54. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  55. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. lazy val idf: IDF
  57. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  58. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator types: TOKEN

    Input annotator types: TOKEN

    Definition Classes
    DocumentMLClassifierApproach → HasInputAnnotationCols
  60. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  61. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  62. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  63. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  64. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  65. val labelCol: Param[String]

    column with the value result we are trying to predict.

  66. lazy val labelEncodedCol: String
  67. lazy val labelPredictedCol: String
  68. lazy val labelRawCol: String
  69. val labels: StringArrayParam

    array to output the label in the original form.

    array to output the label in the original form.

    Definition Classes
    DocumentMLClassifierParams
  70. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  71. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. val maxIter: Param[Int]

    maximum number of iterations (Default: 10)

  84. val maxTokenNgram: IntParam

    the max number of tokens for Ngrams

    the max number of tokens for Ngrams

    Definition Classes
    DocumentMLClassifierParams
  85. val mergeChunks: BooleanParam

    whether to merge all chunks in a document or not (Default: false)

    whether to merge all chunks in a document or not (Default: false)

    Definition Classes
    DocumentMLClassifierParams
  86. val minTokenNgram: IntParam

    the min number of tokens for Ngrams

    the min number of tokens for Ngrams

    Definition Classes
    DocumentMLClassifierParams
  87. lazy val mlClassifier: Classifier[_, _, _] with HasMaxIter with HasTol with HasFitIntercept
  88. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  89. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  90. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. def onTrained(model: DocumentMLClassifierModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  93. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  94. val outputAnnotatorType: AnnotatorType

    Output annotator types: CATEGORY

    Output annotator types: CATEGORY

    Definition Classes
    DocumentMLClassifierApproach → HasOutputAnnotatorType
  95. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  96. lazy val ovrClassifier: OneVsRest
  97. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  98. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  99. final def set(paramPair: ParamPair[_]): DocumentMLClassifierApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def set(param: String, value: Any): DocumentMLClassifierApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set[T](param: Param[T], value: T): DocumentMLClassifierApproach.this.type
    Definition Classes
    Params
  102. def setClassificationModelClass(value: String): DocumentMLClassifierApproach.this.type

    set the SparkML classification class to use

  103. def setClassificationModelPath(value: String): DocumentMLClassifierApproach.this.type

    set the classification model if it has been already trained.

  104. final def setDefault(paramPairs: ParamPair[_]*): DocumentMLClassifierApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  105. final def setDefault[T](param: Param[T], value: T): DocumentMLClassifierApproach.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  106. def setFitIntercept(value: Boolean): DocumentMLClassifierApproach.this.type

    set whether to fit an intercept term (Default: true)

  107. final def setInputCols(value: String*): DocumentMLClassifierApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  108. def setInputCols(value: Array[String]): DocumentMLClassifierApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  109. def setLabelCol(value: String): DocumentMLClassifierApproach.this.type

    column with the value result we are trying to predict.

  110. def setLabels(value: Array[String]): DocumentMLClassifierApproach.this.type

    array to output the label in the original form.

    array to output the label in the original form.

    Definition Classes
    DocumentMLClassifierParams
  111. def setLazyAnnotator(value: Boolean): DocumentMLClassifierApproach.this.type
    Definition Classes
    CanBeLazy
  112. def setMaxIter(value: Int): DocumentMLClassifierApproach.this.type

    maximum number of iterations (Default: 10)

  113. def setMaxTokenNgram(value: Int): DocumentMLClassifierApproach.this.type
  114. def setMaxTokenNgramFingerprint(value: Int): DocumentMLClassifierApproach.this.type
    Definition Classes
    DocumentMLClassifierParams
  115. def setMergeChunks(value: Boolean): DocumentMLClassifierApproach.this.type

    whether to merge all chunks in a document or not (Default: false)

    whether to merge all chunks in a document or not (Default: false)

    Definition Classes
    DocumentMLClassifierParams
  116. def setMinTokenNgram(value: Int): DocumentMLClassifierApproach.this.type
  117. def setMinTokenNgramFingerprint(value: Int): DocumentMLClassifierApproach.this.type
    Definition Classes
    DocumentMLClassifierParams
  118. final def setOutputCol(value: String): DocumentMLClassifierApproach.this.type
    Definition Classes
    HasOutputAnnotationCol
  119. def setTol(value: Double): DocumentMLClassifierApproach.this.type

    set convergence tolerance after each iteration (Default: 1e-6)

  120. def setVectorizationModelPath(value: String): DocumentMLClassifierApproach.this.type

    set the vectorization model if it has been already trained.

  121. lazy val sidx: StringIndexer
  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. lazy val tf: HashingTF
  124. lazy val tfCol: String
  125. lazy val tfidfCol: String
  126. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  127. lazy val tokenAnnotationCol: String
  128. lazy val tokenRawCol: String
  129. val tol: Param[Double]

    convergence tolerance after each iteration (Default: 1e-6)

  130. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DocumentMLClassifierModel
    Definition Classes
    DocumentMLClassifierApproach → AnnotatorApproach
  131. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AnnotatorApproach → PipelineStage
  132. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  133. val uid: String
    Definition Classes
    DocumentMLClassifierApproach → Identifiable
  134. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  135. val vectorizationModelPath: Param[String]

    specify the vectorization model if it has been already trained.

  136. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  139. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from DocumentMLClassifierParams

Inherited from AnnotatorApproach[DocumentMLClassifierModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[DocumentMLClassifierModel]

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