Class/Object

com.johnsnowlabs.nlp.annotators.generic_classifier

GenericClassifierModel

Related Docs: object GenericClassifierModel | package generic_classifier

Permalink

class GenericClassifierModel extends AnnotatorModel[GenericClassifierModel] with HasStorageRef with ParamsAndFeaturesWritable with WriteTensorflowModel with Licensed

The Generic Classifier is generic single-label classifier which uses pre-generated Tensorflow graphs. The model operates on FEATURE_VECTOR annotations which can be produced using FeatureAssembler.

Linear Supertypes
Licensed, WriteTensorflowModel, HasStorageRef, AnnotatorModel[GenericClassifierModel], CanBeLazy, RawAnnotator[GenericClassifierModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[GenericClassifierModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenericClassifierModel
  2. Licensed
  3. WriteTensorflowModel
  4. HasStorageRef
  5. AnnotatorModel
  6. CanBeLazy
  7. RawAnnotator
  8. HasOutputAnnotationCol
  9. HasInputAnnotationCols
  10. HasOutputAnnotatorType
  11. ParamsAndFeaturesWritable
  12. HasFeatures
  13. DefaultParamsWritable
  14. MLWritable
  15. Model
  16. Transformer
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GenericClassifierModel()

    Permalink
  2. new GenericClassifierModel(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. 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. 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

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    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
    GenericClassifierModel → AnnotatorModel
  12. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  19. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef
  20. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. def dfAnnotate: UserDefinedFunction

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  22. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  30. val featureScaling: Param[String]

    Permalink

    Feature scaling method.

    Feature scaling method. Possible values are 'zscore', 'minmax' or empty (no scaling)

  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. def getCategories(): Array[String]

    Permalink

    Get all categories

  39. def getCategoryName(id: Int): String

    Permalink

  40. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  42. def getEncoder: GenericClassifierDataEncoder

    Permalink
  43. def getFeatureScaling: String

    Permalink

    Get feature scaling method

  44. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  45. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  46. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  47. final def getOutputCol: String

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

    Permalink
    Definition Classes
    Params
  49. def getStorageRef: String

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

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

    Permalink
    Definition Classes
    Params
  52. def hasParent: Boolean

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

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

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

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

    Permalink

    Output annotator type : SENTENCE_EMBEDDINGS

    Output annotator type : SENTENCE_EMBEDDINGS

    Definition Classes
    GenericClassifierModel → HasInputAnnotationCols
  57. final val inputCols: StringArrayParam

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  58. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  63. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def model: TensorflowGenericClassifier

    Permalink
  76. def msgHelper(schema: StructType): String

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

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

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

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

    Permalink
    Definition Classes
    GenericClassifierModel → ParamsAndFeaturesWritable
  81. val outputAnnotatorType: String

    Permalink

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

    Definition Classes
    GenericClassifierModel → HasOutputAnnotatorType
  82. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  84. var parent: Estimator[GenericClassifierModel]

    Permalink
    Definition Classes
    Model
  85. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  86. def scaleFeatures(features: Array[Array[Float]]): Array[Array[Float]]

    Permalink
    Attributes
    protected
  87. def set[T](feature: StructFeature[T], value: T): GenericClassifierModel.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  94. def setCategoryNames(categoryNames: Array[String]): GenericClassifierModel.this.type

    Permalink

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  101. def setEncoder(encoder: GenericClassifierDataEncoder): GenericClassifierModel.this.type

    Permalink
  102. def setFeatureScaling(featureScaling: String): GenericClassifierModel.this.type

    Permalink

    Set the feature scaling method.

    Set the feature scaling method. Possible values are 'zscore', 'minmax' or empty (no scaling)

  103. final def setInputCols(value: String*): GenericClassifierModel.this.type

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  105. def setLazyAnnotator(value: Boolean): GenericClassifierModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  106. final def setOutputCol(value: String): GenericClassifierModel.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  107. def setParent(parent: Estimator[GenericClassifierModel]): GenericClassifierModel

    Permalink
    Definition Classes
    Model
  108. def setStorageRef(value: String): GenericClassifierModel.this.type

    Permalink
    Definition Classes
    HasStorageRef
  109. def setTensorflowModel(spark: SparkSession, tf: TensorflowWrapper): GenericClassifierModel.this.type

    Permalink
  110. val storageRef: Param[String]

    Permalink
    Definition Classes
    HasStorageRef
  111. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  113. final def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    AnnotatorModel → Transformer
  114. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  116. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage
  117. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    GenericClassifierModel → Identifiable
  119. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  120. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

    Permalink
    Definition Classes
    HasStorageRef
  121. final def wait(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  126. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  127. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  128. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from Licensed

Inherited from WriteTensorflowModel

Inherited from HasStorageRef

Inherited from AnnotatorModel[GenericClassifierModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[GenericClassifierModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[GenericClassifierModel]

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

anno

getParam

param

setParam

Ungrouped