Class/Object

com.intel.analytics.zoo.pipeline.nnframes

NNClassifierModel

Related Docs: object NNClassifierModel | package nnframes

Permalink

class NNClassifierModel[T] extends NNModel[T]

NNClassifierModel is a specialized NNModel for classification tasks. The prediction column will have the data type of Double.

Linear Supertypes
NNModel[T], MLWritable, NNParams[T], VectorCompatibility, HasBatchSize, HasPredictionCol, HasPredictionCol, HasFeaturesCol, HasFeaturesCol, DLTransformerBase[NNModel[T]], Model[NNModel[T]], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NNClassifierModel
  2. NNModel
  3. MLWritable
  4. NNParams
  5. VectorCompatibility
  6. HasBatchSize
  7. HasPredictionCol
  8. HasPredictionCol
  9. HasFeaturesCol
  10. HasFeaturesCol
  11. DLTransformerBase
  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

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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final val batchSize: IntParam

    Permalink

    Global batch size across the cluster.

    Global batch size across the cluster.

    Definition Classes
    HasBatchSize
  7. final def clear(param: Param[_]): NNClassifierModel.this.type

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  11. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasFeaturesCol
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  21. def getBatchSize: Int

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

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

    Permalink
    Definition Classes
    Params
  24. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  25. final def getOrDefault[T](param: Param[T]): T

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

    Permalink
    Definition Classes
    Params
  27. final def getPredictionCol: String

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

    Permalink
    Definition Classes
    NNParams
  29. def getThreshold: Double

    Permalink
  30. def getVectorSeq(row: Row, colType: DataType, index: Int): Seq[AnyVal]

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

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

    Permalink
    Definition Classes
    Params
  33. def hasParent: Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  37. def internalTransform(dataFrame: DataFrame): DataFrame

    Permalink

    Perform a prediction on featureCol, and write result to the predictionCol.

    Perform a prediction on featureCol, and write result to the predictionCol.

    Attributes
    protected
    Definition Classes
    NNModel → DLTransformerBase
  38. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. val model: Module[T]

    Permalink

    trained BigDL models to use in prediction.

    trained BigDL models to use in prediction.

    Definition Classes
    NNClassifierModelNNModel
  55. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  58. def outputToPrediction(output: Tensor[T]): Any

    Permalink
    Attributes
    protected
    Definition Classes
    NNClassifierModelNNModel
  59. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  60. var parent: Estimator[NNModel[T]]

    Permalink
    Definition Classes
    Model
  61. final val predictionCol: Param[String]

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

    Permalink
    Definition Classes
    NNParams
  63. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  64. final def set(paramPair: ParamPair[_]): NNClassifierModel.this.type

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

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

    Permalink
    Definition Classes
    Params
  67. def setBatchSize(value: Int): NNClassifierModel.this.type

    Permalink

    Set global batch size across the cluster.

    Set global batch size across the cluster. Global batch size = Batch per thread * num of cores.

    Definition Classes
    NNModel
  68. final def setDefault(paramPairs: ParamPair[_]*): NNClassifierModel.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  70. def setFeaturesCol(featuresColName: String): NNClassifierModel.this.type

    Permalink
    Definition Classes
    NNModel
  71. def setParent(parent: Estimator[NNModel[T]]): NNModel[T]

    Permalink
    Definition Classes
    Model
  72. def setPredictionCol(value: String): NNClassifierModel.this.type

    Permalink
    Definition Classes
    NNModel
  73. def setSamplePreprocessing[FF](value: Preprocessing[FF, Sample[T]]): NNClassifierModel.this.type

    Permalink

    set Preprocessing.

    set Preprocessing.

    Definition Classes
    NNModel
  74. def setThreshold(value: Double): NNClassifierModel.this.type

    Permalink
  75. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  76. final val threshold: DoubleParam

    Permalink

    Param for threshold in binary classification prediction.

    Param for threshold in binary classification prediction.

    The threshold applies to the raw output of the model. If the output is greater than threshold, then predict 1, else 0. A high threshold encourages the model to predict 0 more often; a low threshold encourages the model to predict 1 more often.

    Note: the param is different from the one in Spark ProbabilisticClassifier which is compared against estimated probability.

    Default is 0.5.

  77. def toString(): String

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

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

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

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

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

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

    Permalink
    Definition Classes
    NNClassifierModelNNModel → Identifiable
  84. def unwrapVectorAsNecessary(colType: DataType): (Row, Int) ⇒ Any

    Permalink
    Attributes
    protected
    Definition Classes
    NNParams
  85. val validVectorTypes: Seq[UserDefinedType[_ >: Vector with Vector <: Serializable] { def sqlType: org.apache.spark.sql.types.StructType }]

    Permalink
    Definition Classes
    VectorCompatibility
  86. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. def write: MLWriter

    Permalink
    Definition Classes
    NNModel → MLWritable

Inherited from NNModel[T]

Inherited from MLWritable

Inherited from NNParams[T]

Inherited from VectorCompatibility

Inherited from HasBatchSize

Inherited from HasPredictionCol

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasFeaturesCol

Inherited from DLTransformerBase[NNModel[T]]

Inherited from Model[NNModel[T]]

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

Ungrouped