Class/Object

com.intel.analytics.zoo.models.common

ZooModel

Related Docs: object ZooModel | package common

Permalink

abstract class ZooModel[A <: Activity, B <: Activity, T] extends Container[A, B, T]

The base class for models in Analytics Zoo.

A

Input data type.

B

Output data type.

T

Numeric type of parameter(e.g. weight, bias). Only support float/double now.

Linear Supertypes
Container[A, B, T], AbstractModule[A, B, T], InferShape, Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZooModel
  2. Container
  3. AbstractModule
  4. InferShape
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ZooModel()(implicit arg0: ClassTag[A], arg1: ClassTag[B], arg2: ClassTag[T], ev: TensorNumeric[T])

    Permalink

Abstract Value Members

  1. abstract def buildModel(): AbstractModule[A, B, T]

    Permalink

    Override this method to define a model.

    Override this method to define a model.

    Attributes
    protected

Concrete 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 ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def accGradParameters(input: A, gradOutput: B): Unit

    Permalink
    Definition Classes
    ZooModel → AbstractModule
  5. def addModel(model: AbstractModule[A, B, T]): ZooModel.this.type

    Permalink
  6. def apply(name: String): Option[AbstractModule[Activity, Activity, T]]

    Permalink
    Definition Classes
    Container → AbstractModule
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def backward(input: A, gradOutput: B): A

    Permalink
    Definition Classes
    AbstractModule
  9. var backwardTime: Long

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  10. def build(): ZooModel.this.type

    Permalink
  11. def canEqual(other: Any): Boolean

    Permalink
    Definition Classes
    Container → AbstractModule
  12. final def checkEngineType(): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  13. def clearState(): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  14. final def clone(deepCopy: Boolean): AbstractModule[A, B, T]

    Permalink
    Definition Classes
    AbstractModule
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. final def cloneModule(): AbstractModule[A, B, T]

    Permalink
    Definition Classes
    AbstractModule
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(other: Any): Boolean

    Permalink
    Definition Classes
    Container → AbstractModule → AnyRef → Any
  19. final def evaluate(): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  20. final def evaluate(dataSet: LocalDataSet[MiniBatch[T]], vMethods: Array[_ <: ValidationMethod[T]]): Array[(ValidationResult, ValidationMethod[T])]

    Permalink
    Definition Classes
    AbstractModule
  21. final def evaluate(dataset: RDD[Sample[T]], vMethods: Array[_ <: ValidationMethod[T]], batchSize: Option[Int]): Array[(ValidationResult, ValidationMethod[T])]

    Permalink
    Definition Classes
    AbstractModule
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def findModules(moduleType: String): ArrayBuffer[AbstractModule[_, _, T]]

    Permalink
    Definition Classes
    Container
  24. final def forward(input: A): B

    Permalink
    Definition Classes
    AbstractModule
  25. var forwardTime: Long

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  26. def freeze(names: String*): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def getExtraParameter(): Array[Tensor[T]]

    Permalink
    Definition Classes
    Container → AbstractModule
  29. final def getInputShape(): Shape

    Permalink
    Definition Classes
    InferShape
  30. final def getName(): String

    Permalink
    Definition Classes
    AbstractModule
  31. final def getNumericType(): TensorDataType

    Permalink
    Definition Classes
    AbstractModule
  32. final def getOutputShape(): Shape

    Permalink
    Definition Classes
    InferShape
  33. def getParametersTable(): Table

    Permalink
    Definition Classes
    Container → AbstractModule
  34. final def getPrintName(): String

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  35. final def getScaleB(): Double

    Permalink
    Definition Classes
    AbstractModule
  36. final def getScaleW(): Double

    Permalink
    Definition Classes
    AbstractModule
  37. def getTimes(): Array[(AbstractModule[_ <: Activity, _ <: Activity, T], Long, Long)]

    Permalink
    Definition Classes
    Container → AbstractModule
  38. final def getWeightsBias(): Array[Tensor[T]]

    Permalink
    Definition Classes
    AbstractModule
  39. var gradInput: A

    Permalink
    Definition Classes
    AbstractModule
  40. final def hasName: Boolean

    Permalink
    Definition Classes
    AbstractModule
  41. def hashCode(): Int

    Permalink
    Definition Classes
    Container → AbstractModule → AnyRef → Any
  42. def inputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Permalink
    Definition Classes
    AbstractModule
  43. def inputs(nodes: Array[ModuleNode[T]]): ModuleNode[T]

    Permalink
    Definition Classes
    AbstractModule
  44. def inputs(nodes: ModuleNode[T]*): ModuleNode[T]

    Permalink
    Definition Classes
    AbstractModule
  45. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  46. final def isTraining(): Boolean

    Permalink
    Definition Classes
    AbstractModule
  47. var line: String

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  48. final def loadModelWeights(srcModel: Module[Float], matchAll: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  49. final def loadWeights(weightPath: String, matchAll: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  50. def model: AbstractModule[A, B, T]

    Permalink

    The defined model, either from buildModel() or loaded from file.

  51. val modules: ArrayBuffer[AbstractModule[Activity, Activity, T]]

    Permalink
    Definition Classes
    Container
  52. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  55. var output: B

    Permalink
    Definition Classes
    AbstractModule
  56. def parameters(): (Array[Tensor[T]], Array[Tensor[T]])

    Permalink
    Definition Classes
    Container → AbstractModule
  57. final def predict(dataset: RDD[Sample[T]], batchSize: Int, shareBuffer: Boolean): RDD[Activity]

    Permalink
    Definition Classes
    AbstractModule
  58. final def predictClass(dataset: RDD[Sample[T]], batchSize: Int): RDD[Int]

    Permalink
    Definition Classes
    AbstractModule
  59. final def predictImage(imageFrame: ImageFrame, outputLayer: String, shareBuffer: Boolean, batchPerPartition: Int, predictKey: String, featurePaddingParam: Option[PaddingParam[T]]): ImageFrame

    Permalink
    Definition Classes
    AbstractModule
  60. def processInputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  61. def processInputs(nodes: Seq[ModuleNode[T]]): ModuleNode[T]

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  62. final def quantize(): Module[T]

    Permalink
    Definition Classes
    AbstractModule
  63. def reset(): Unit

    Permalink
    Definition Classes
    Container → AbstractModule
  64. def resetTimes(): Unit

    Permalink
    Definition Classes
    Container → AbstractModule
  65. final def saveCaffe(prototxtPath: String, modelPath: String, useV2: Boolean, overwrite: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  66. final def saveDefinition(path: String, overWrite: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  67. def saveModel(path: String, weightPath: String = null, overWrite: Boolean = false): ZooModel.this.type

    Permalink

    Save the model to the specified path.

    Save the model to the specified path.

    path

    The path to save the model. Local file system, HDFS and Amazon S3 are supported. HDFS path should be like "hdfs://[host]:[port]/xxx". Amazon S3 path should be like "s3a://bucket/xxx".

    weightPath

    The path to save weights. Default is null.

    overWrite

    Whether to overwrite the file if it already exists. Default is false.

  68. final def saveModule(path: String, weightPath: String, overWrite: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  69. final def saveTF(inputs: Seq[(String, Seq[Int])], path: String, byteOrder: ByteOrder, dataFormat: TensorflowDataFormat): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  70. final def saveTorch(path: String, overWrite: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  71. final def saveWeights(path: String, overWrite: Boolean): Unit

    Permalink
    Definition Classes
    AbstractModule
  72. var scaleB: Double

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  73. var scaleW: Double

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  74. final def setExtraParameter(extraParam: Array[Tensor[T]]): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  75. final def setLine(line: String): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  76. final def setName(name: String): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  77. def setScaleB(b: Double): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  78. def setScaleW(w: Double): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  79. final def setWeightsBias(newWeights: Array[Tensor[T]]): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
  80. def summary(): Unit

    Permalink

    Print out the summary of the model.

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

    Permalink
    Definition Classes
    AnyRef
  82. def toGraph(startNodes: ModuleNode[T]*): Graph[T]

    Permalink
    Definition Classes
    AbstractModule
  83. def toString(): String

    Permalink
    Definition Classes
    AbstractModule → AnyRef → Any
  84. var train: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  85. final def training(): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  86. def unFreeze(names: String*): ZooModel.this.type

    Permalink
    Definition Classes
    Container → AbstractModule
  87. def updateGradInput(input: A, gradOutput: B): A

    Permalink
    Definition Classes
    ZooModel → AbstractModule
  88. def updateOutput(input: A): B

    Permalink
    Definition Classes
    ZooModel → AbstractModule
  89. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  92. final def zeroGradParameters(): Unit

    Permalink
    Definition Classes
    AbstractModule

Deprecated Value Members

  1. final def save(path: String, overWrite: Boolean): ZooModel.this.type

    Permalink
    Definition Classes
    AbstractModule
    Annotations
    @deprecated
    Deprecated

    (Since version 0.3.0) please use recommended saveModule(path, overWrite)

Inherited from Container[A, B, T]

Inherited from AbstractModule[A, B, T]

Inherited from InferShape

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped