Packages

class DocumentLogRegClassifierModel extends Model[DocumentLogRegClassifierModel] with RawAnnotator[DocumentLogRegClassifierModel] with CanBeLazy with Licensed

Classifies documents with a Logarithmic Regression algorithm. Currently there are no pretrained models available. Please see DocumentLogRegClassifierApproach to train your own model.

Please check out the Models Hub for available models in the future.

Linear Supertypes
Licensed, CanBeLazy, RawAnnotator[DocumentLogRegClassifierModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[DocumentLogRegClassifierModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DocumentLogRegClassifierModel
  2. Licensed
  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 DocumentLogRegClassifierModel()
  2. new DocumentLogRegClassifierModel(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. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  11. val classificationModel: StructFeature[OneVsRestModel]
  12. lazy val classificationPipeline: Pipeline
  13. final def clear(param: Param[_]): DocumentLogRegClassifierModel.this.type
    Definition Classes
    Params
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def copy(extra: ParamMap): DocumentLogRegClassifierModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  16. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  18. lazy val docCol: String
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  22. def explainParams(): String
    Definition Classes
    Params
  23. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  24. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  25. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  26. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  27. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  30. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  31. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  32. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  33. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  34. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def getClassificationModel: OneVsRestModel
  36. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  37. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  38. def getLabels: Array[String]

    array to output the label in the original form.

  39. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  40. def getMergeChunks: Boolean

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

  41. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  42. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  43. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  44. def getVectorizationModel: PipelineModel
  45. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  46. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  47. def hasParent: Boolean
    Definition Classes
    Model
  48. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  50. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator types: TOKEN

    Input annotator types: TOKEN

    Definition Classes
    DocumentLogRegClassifierModel → HasInputAnnotationCols
  52. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  53. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  56. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  57. lazy val labelArray: Array[String]
  58. val labels: StringArrayParam

    array to output the label in the original form.

  59. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  60. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. val mergeChunks: BooleanParam

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

  73. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  74. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  75. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  76. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  77. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  78. val outputAnnotatorType: AnnotatorType

    Output annotator types: CATEGORY

    Output annotator types: CATEGORY

    Definition Classes
    DocumentLogRegClassifierModel → HasOutputAnnotatorType
  79. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  80. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  81. var parent: Estimator[DocumentLogRegClassifierModel]
    Definition Classes
    Model
  82. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  83. def set[T](feature: StructFeature[T], value: T): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def set[T](feature: SetFeature[T], value: Set[T]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. def set[T](feature: ArrayFeature[T], value: Array[T]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. final def set(paramPair: ParamPair[_]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  88. final def set(param: String, value: Any): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  89. final def set[T](param: Param[T], value: T): DocumentLogRegClassifierModel.this.type
    Definition Classes
    Params
  90. def setClassificationModel(value: OneVsRestModel): DocumentLogRegClassifierModel.this.type
  91. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. final def setDefault(paramPairs: ParamPair[_]*): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  96. final def setDefault[T](param: Param[T], value: T): DocumentLogRegClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  97. final def setInputCols(value: String*): DocumentLogRegClassifierModel.this.type
    Definition Classes
    HasInputAnnotationCols
  98. final def setInputCols(value: Array[String]): DocumentLogRegClassifierModel.this.type
    Definition Classes
    HasInputAnnotationCols
  99. def setLabels(value: Array[String]): DocumentLogRegClassifierModel.this.type

    array to output the label in the original form.

  100. def setLazyAnnotator(value: Boolean): DocumentLogRegClassifierModel.this.type
    Definition Classes
    CanBeLazy
  101. def setMergeChunks(value: Boolean): DocumentLogRegClassifierModel.this.type

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

  102. final def setOutputCol(value: String): DocumentLogRegClassifierModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  103. def setParent(parent: Estimator[DocumentLogRegClassifierModel]): DocumentLogRegClassifierModel
    Definition Classes
    Model
  104. def setVectorizationModel(value: PipelineModel): DocumentLogRegClassifierModel.this.type
  105. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  106. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  107. lazy val tokenAnnotationCol: String
  108. lazy val tokenRawCol: String
  109. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    DocumentLogRegClassifierModel → Transformer
  110. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  111. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  112. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  113. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  114. val uid: String
    Definition Classes
    DocumentLogRegClassifierModel → Identifiable
  115. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  116. val vectorizationModel: StructFeature[PipelineModel]
  117. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  120. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  121. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from Licensed

Inherited from CanBeLazy

Inherited from RawAnnotator[DocumentLogRegClassifierModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[DocumentLogRegClassifierModel]

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