Packages

class GenericClassifierModel extends AnnotatorModel[GenericClassifierModel] with HasStorageRef with ParamsAndFeaturesWritable with WriteTensorflowModel with HasSimpleAnnotate[GenericClassifierModel] with CheckLicense

Creates a generic single-label classifier which uses pre-generated Tensorflow graphs. The model operates on FEATURE_VECTOR annotations which can be produced using FeatureAssembler. Requires the FeaturesAssembler to create the input.

See also

GenericClassifierApproach for an example and on how to define your own model

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

Instance Constructors

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

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotationContent = Seq[Row]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. 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. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    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 → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    GenericClassifierModel → AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkValidEnvironment(spark: Option[SparkContext]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkContext], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  18. final def clear(param: Param[_]): GenericClassifierModel.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def copy(extra: ParamMap): GenericClassifierModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  23. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  28. def explainParams(): String
    Definition Classes
    Params
  29. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  32. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  33. val featureScaling: Param[String]

    Feature scaling method.

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

  34. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  35. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  41. def getCategories(): Array[String]
  42. def getCategoryName(id: Int): String
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  45. def getEncoder: GenericClassifierDataEncoder
  46. def getFeatureScaling: String

    Get feature scaling method

  47. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  48. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  49. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  50. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  51. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  52. def getStorageRef: String
    Definition Classes
    HasStorageRef
  53. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  54. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  55. def hasParent: Boolean
    Definition Classes
    Model
  56. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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]

    Output annotator type : FEATURE_VECTOR

    Output annotator type : FEATURE_VECTOR

    Definition Classes
    GenericClassifierModel → 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. def isLp(): Boolean
    Definition Classes
    CheckLicense
  64. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  65. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  66. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  67. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  68. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  75. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def model: TensorflowGenericClassifier
  80. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    GenericClassifierModel → ParamsAndFeaturesWritable
  85. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  86. val outputAnnotatorType: String

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

    Definition Classes
    GenericClassifierModel → HasOutputAnnotatorType
  87. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  88. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  89. var parent: Estimator[GenericClassifierModel]
    Definition Classes
    Model
  90. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  91. def scaleFeatures(features: Array[Array[Float]]): Array[Array[Float]]
    Attributes
    protected
  92. def set[T](feature: StructFeature[T], value: T): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. def set[T](feature: SetFeature[T], value: Set[T]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def set[T](feature: ArrayFeature[T], value: Array[T]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. final def set(paramPair: ParamPair[_]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  97. final def set(param: String, value: Any): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  98. final def set[T](param: Param[T], value: T): GenericClassifierModel.this.type
    Definition Classes
    Params
  99. def setCategoryNames(categoryNames: Array[String]): GenericClassifierModel.this.type
  100. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. final def setDefault(paramPairs: ParamPair[_]*): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  105. final def setDefault[T](param: Param[T], value: T): GenericClassifierModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  106. def setEncoder(encoder: GenericClassifierDataEncoder): GenericClassifierModel.this.type
  107. def setFeatureScaling(featureScaling: String): GenericClassifierModel.this.type

    Set the feature scaling method.

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

  108. final def setInputCols(value: String*): GenericClassifierModel.this.type
    Definition Classes
    HasInputAnnotationCols
  109. final def setInputCols(value: Array[String]): GenericClassifierModel.this.type
    Definition Classes
    HasInputAnnotationCols
  110. def setLazyAnnotator(value: Boolean): GenericClassifierModel.this.type
    Definition Classes
    CanBeLazy
  111. final def setOutputCol(value: String): GenericClassifierModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  112. def setParent(parent: Estimator[GenericClassifierModel]): GenericClassifierModel
    Definition Classes
    Model
  113. def setStorageRef(value: String): GenericClassifierModel.this.type
    Definition Classes
    HasStorageRef
  114. def setTensorflowModel(spark: SparkSession, tf: TensorflowWrapper): GenericClassifierModel.this.type
  115. val storageRef: Param[String]
    Definition Classes
    HasStorageRef
  116. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  117. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  118. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  119. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  120. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  121. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  122. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  123. val uid: String
    Definition Classes
    GenericClassifierModel → Identifiable
  124. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  125. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  126. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  128. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  129. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  130. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  131. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String): Unit
    Definition Classes
    WriteTensorflowModel
  132. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit
    Definition Classes
    WriteTensorflowModel
  133. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]], savedSignatures: Option[Map[String, String]]): Unit
    Definition Classes
    WriteTensorflowModel

Inherited from CheckLicense

Inherited from HasSimpleAnnotate[GenericClassifierModel]

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

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters