com.intel.analytics.zoo.pipeline.nnframes

NNClassifier

class NNClassifier[T] extends NNEstimator[T]

NNClassifier is a specialized NNEstimator that simplifies the data format for classification tasks. It explicitly supports label column of DoubleType. and the fitted NNClassifierModel will have the prediction column of DoubleType.

Linear Supertypes
NNEstimator[T], TrainingParams[T], NNParams[T], HasBatchSize, HasPredictionCol, HasPredictionCol, HasFeaturesCol, HasFeaturesCol, DLEstimatorBase[NNEstimator[T], NNModel[T]], HasLabelCol, Estimator[NNModel[T]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NNClassifier
  2. NNEstimator
  3. TrainingParams
  4. NNParams
  5. HasBatchSize
  6. HasPredictionCol
  7. HasPredictionCol
  8. HasFeaturesCol
  9. HasFeaturesCol
  10. DLEstimatorBase
  11. HasLabelCol
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def $[T](param: Param[T]): T

    Attributes
    protected
    Definition Classes
    Params
  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. final val batchSize: IntParam

    Definition Classes
    HasBatchSize
  9. final val cachingSample: BooleanParam

    whether to cache the Samples after preprocessing.

    whether to cache the Samples after preprocessing. Default: true

    Definition Classes
    TrainingParams
  10. final def clear(param: Param[_]): NNClassifier.this.type

    Definition Classes
    Params
  11. def clearGradientClipping(): NNClassifier.this.type

    Clear clipping params, in this case, clipping will not be applied.

    Clear clipping params, in this case, clipping will not be applied.

    Definition Classes
    NNEstimator
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final val constantGradientClippingParams: Param[(Float, Float)]

    Constant gradient clipping thresholds.

    Constant gradient clipping thresholds.

    Definition Classes
    TrainingParams
  14. def copy(extra: ParamMap): NNClassifier[T]

    Return a deep copy for DLEstimator.

    Return a deep copy for DLEstimator. Note that trainSummary and validationSummary will not be copied to the new instance since currently they are not thread-safe.

    Definition Classes
    NNClassifierNNEstimator → DLEstimatorBase → Estimator → PipelineStage → Params
  15. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Attributes
    protected
    Definition Classes
    Params
  16. val criterion: Criterion[T]

    BigDL criterion method

    BigDL criterion method

    Definition Classes
    NNClassifierNNEstimator
  17. final def defaultCopy[T <: Params](extra: ParamMap): T

    Attributes
    protected
    Definition Classes
    Params
  18. final val endWhen: Param[Trigger]

    When to stop the training, passed in a Trigger.

    When to stop the training, passed in a Trigger. E.g. Trigger.maxIterations

    Definition Classes
    TrainingParams
  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. final def extractParamMap(): ParamMap

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

    Definition Classes
    Params
  25. final val featuresCol: Param[String]

    Definition Classes
    HasFeaturesCol
  26. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def fit(dataFrame: DataFrame): NNModel[T]

    Definition Classes
    DLEstimatorBase → Estimator
  28. def fit(dataset: DataFrame, paramMaps: Array[ParamMap]): Seq[NNModel[T]]

    Definition Classes
    Estimator
  29. def fit(dataset: DataFrame, paramMap: ParamMap): NNModel[T]

    Definition Classes
    Estimator
  30. def fit(dataset: DataFrame, firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): NNModel[T]

    Definition Classes
    Estimator
    Annotations
    @varargs()
  31. final def get[T](param: Param[T]): Option[T]

    Definition Classes
    Params
  32. def getBatchSize: Int

    Definition Classes
    HasBatchSize
  33. final def getClass(): Class[_]

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

    Definition Classes
    Params
  35. def getEndWhen: Trigger

    Definition Classes
    TrainingParams
  36. final def getFeaturesCol: String

    Definition Classes
    HasFeaturesCol
  37. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  38. def getLearningRate: Double

    Definition Classes
    TrainingParams
  39. def getLearningRateDecay: Double

    Definition Classes
    TrainingParams
  40. def getMaxEpoch: Int

    Definition Classes
    TrainingParams
  41. def getOptimMethod: OptimMethod[T]

    Definition Classes
    TrainingParams
  42. final def getOrDefault[T](param: Param[T]): T

    Definition Classes
    Params
  43. def getParam(paramName: String): Param[Any]

    Definition Classes
    Params
  44. final def getPredictionCol: String

    Definition Classes
    HasPredictionCol
  45. def getSamplePreprocessing: Preprocessing[Any, Sample[T]]

    Definition Classes
    NNParams
  46. def getTrainSummary: Option[TrainSummary]

    Definition Classes
    NNEstimator
  47. def getValidation: Option[(Trigger, DataFrame, Array[ValidationMethod[T]], Int)]

    get the validate configuration during training

    get the validate configuration during training

    returns

    an Option of Tuple(ValidationTrigger, Validation data, Array[ValidationMethod[T] ], batchsize)

    Definition Classes
    NNEstimator
  48. def getValidationSummary: Option[ValidationSummary]

    Statistics (LearningRate, Loss, Throughput, Parameters) collected during training for the validation data if validation data is set, which can be used for visualization via Tensorboard.

    Statistics (LearningRate, Loss, Throughput, Parameters) collected during training for the validation data if validation data is set, which can be used for visualization via Tensorboard. Use setValidationSummary to enable validation logger. Then the log will be saved to logDir/appName/ as specified by the parameters of validationSummary.

    Default: None

    Definition Classes
    NNEstimator
  49. final def hasDefault[T](param: Param[T]): Boolean

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

    Definition Classes
    Params
  51. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  52. def internalFit(dataFrame: DataFrame): NNModel[T]

    Attributes
    protected
    Definition Classes
    NNEstimator → DLEstimatorBase
  53. def isCachingSample: Boolean

    Definition Classes
    TrainingParams
  54. final def isDefined(param: Param[_]): Boolean

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

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

    Definition Classes
    Params
  57. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging
  58. final val l2GradientClippingParams: FloatParam

    L2 norm gradient clipping threshold.

    L2 norm gradient clipping threshold.

    Definition Classes
    TrainingParams
  59. final val labelCol: Param[String]

    Definition Classes
    HasLabelCol
  60. final val learningRate: DoubleParam

    learning rate for the optimizer in the NNEstimator.

    learning rate for the optimizer in the NNEstimator. Default: 0.001

    Definition Classes
    TrainingParams
  61. final val learningRateDecay: DoubleParam

    learning rate decay for each iteration.

    learning rate decay for each iteration. Default: 0

    Definition Classes
    TrainingParams
  62. def log: Logger

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  69. def logName: String

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  74. final val maxEpoch: IntParam

    Number of max Epoch for the training, an epoch refers to a traverse over the training data Default: 50

    Number of max Epoch for the training, an epoch refers to a traverse over the training data Default: 50

    Definition Classes
    TrainingParams
  75. val model: Module[T]

    BigDL module to be optimized

    BigDL module to be optimized

    Definition Classes
    NNClassifierNNEstimator
  76. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  77. final def notify(): Unit

    Definition Classes
    AnyRef
  78. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  79. final val optimMethod: Param[OptimMethod[T]]

    optimization method to be used.

    optimization method to be used. BigDL supports many optimization methods like Adam, SGD and LBFGS. Refer to package com.intel.analytics.bigdl.optim for all the options. Default: SGD

    Definition Classes
    TrainingParams
  80. lazy val params: Array[Param[_]]

    Definition Classes
    Params
  81. final val predictionCol: Param[String]

    Definition Classes
    HasPredictionCol
  82. final val samplePreprocessing: Param[Preprocessing[Any, Sample[T]]]

    Definition Classes
    NNParams
  83. final def set(paramPair: ParamPair[_]): NNClassifier.this.type

    Attributes
    protected
    Definition Classes
    Params
  84. final def set(param: String, value: Any): NNClassifier.this.type

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

    Definition Classes
    Params
  86. def setBatchSize(value: Int): NNClassifier.this.type

    Definition Classes
    NNEstimator
  87. def setCachingSample(value: Boolean): NNClassifier.this.type

    Definition Classes
    NNEstimator
  88. def setConstantGradientClipping(min: Float, max: Float): NNClassifier.this.type

    Definition Classes
    NNEstimator
  89. final def setDefault(paramPairs: ParamPair[_]*): NNClassifier.this.type

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

    Attributes
    protected
    Definition Classes
    Params
  91. def setEndWhen(trigger: Trigger): NNClassifier.this.type

    Definition Classes
    NNEstimator
  92. def setFeaturesCol(featuresColName: String): NNClassifier.this.type

    Definition Classes
    NNEstimator
  93. def setGradientClippingByL2Norm(clipNorm: Float): NNClassifier.this.type

    Definition Classes
    NNEstimator
  94. def setLabelCol(labelColName: String): NNClassifier.this.type

    Definition Classes
    NNEstimator
  95. def setLearningRate(value: Double): NNClassifier.this.type

    Definition Classes
    NNEstimator
  96. def setLearningRateDecay(value: Double): NNClassifier.this.type

    Definition Classes
    NNEstimator
  97. def setMaxEpoch(value: Int): NNClassifier.this.type

    Definition Classes
    NNEstimator
  98. def setOptimMethod(value: OptimMethod[T]): NNClassifier.this.type

    Definition Classes
    NNEstimator
  99. def setPredictionCol(value: String): NNClassifier.this.type

    Definition Classes
    NNEstimator
  100. def setSamplePreprocessing[FF, LL](value: Preprocessing[(FF, Option[LL]), Sample[T]]): NNClassifier.this.type

    Definition Classes
    NNEstimator
  101. def setTrainSummary(value: TrainSummary): NNClassifier.this.type

    Statistics (LearningRate, Loss, Throughput, Parameters) collected during training for the training data, which can be used for visualization via Tensorboard.

    Statistics (LearningRate, Loss, Throughput, Parameters) collected during training for the training data, which can be used for visualization via Tensorboard. Use setTrainSummary to enable train logger. Then the log will be saved to logDir/appName/train as specified by the parameters of TrainSummary.

    Default: Not enabled

    Definition Classes
    NNEstimator
  102. def setValidation(trigger: Trigger, validationDF: DataFrame, vMethods: Array[ValidationMethod[T]], batchSize: Int): NNClassifier.this.type

    Set a validate evaluation during training

    Set a validate evaluation during training

    trigger

    how often to evaluation validation set

    validationDF

    validate data set

    vMethods

    a set of validation method ValidationMethod

    batchSize

    batch size for validation

    returns

    this optimizer

    Definition Classes
    NNEstimator
  103. def setValidationSummary(value: ValidationSummary): NNClassifier.this.type

    Enable validation Summary

    Enable validation Summary

    Definition Classes
    NNEstimator
  104. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  105. def toString(): String

    Definition Classes
    Identifiable → AnyRef → Any
  106. def transformSchema(schema: StructType): StructType

    Definition Classes
    NNClassifierNNEstimator → PipelineStage
  107. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Definition Classes
    NNClassifierNNEstimator → Identifiable
  109. def validateParams(schema: StructType): Unit

    Attributes
    protected
    Definition Classes
    NNEstimator
  110. def validateParams(): Unit

    Definition Classes
    Params
  111. var validationBatchSize: Int

    Attributes
    protected
    Definition Classes
    NNEstimator
  112. var validationDF: DataFrame

    Attributes
    protected
    Definition Classes
    NNEstimator
  113. var validationMethods: Array[ValidationMethod[T]]

    Attributes
    protected
    Definition Classes
    NNEstimator
  114. var validationTrigger: Option[Trigger]

    Attributes
    protected
    Definition Classes
    NNEstimator
  115. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. def wrapBigDLModel(m: Module[T]): NNClassifierModel[T]

    sub classes can extend the method and return required model for different transform tasks

    sub classes can extend the method and return required model for different transform tasks

    Attributes
    protected
    Definition Classes
    NNClassifierNNEstimator

Inherited from NNEstimator[T]

Inherited from TrainingParams[T]

Inherited from NNParams[T]

Inherited from HasBatchSize

Inherited from HasPredictionCol

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasFeaturesCol

Inherited from DLEstimatorBase[NNEstimator[T], NNModel[T]]

Inherited from HasLabelCol

Inherited from Estimator[NNModel[T]]

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