com.intel.analytics.zoo.pipeline.api.keras.layers

Convolution3D

class Convolution3D[T] extends bigdl.nn.keras.Convolution3D[T] with Net

Applies convolution operator for filtering windows of three-dimensional inputs. You can also use Conv3D as an alias of this layer. Data format currently supported for this layer is 'CHANNEL_FIRST' (dimOrdering='th'). The input of this layer should be 5D.

When you use this layer as the first layer of a model, you need to provide the argument inputShape (a Single Shape, does not include the batch dimension), e.g. inputShape=Shape(3, 10, 128, 128) 10 frames of 128x128 RGB pictures.

T

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

Linear Supertypes
Net, bigdl.nn.keras.Convolution3D[T], KerasLayer[Tensor[T], Tensor[T], T], Container[Tensor[T], Tensor[T], T], AbstractModule[Tensor[T], Tensor[T], T], InferShape, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Convolution3D
  2. Net
  3. Convolution3D
  4. KerasLayer
  5. Container
  6. AbstractModule
  7. InferShape
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Convolution3D(nbFilter: Int, kernelDim1: Int, kernelDim2: Int, kernelDim3: Int, init: InitializationMethod = com.intel.analytics.bigdl.nn.Xavier, activation: KerasLayer[Tensor[T], Tensor[T], T] = null, borderMode: String = "valid", subsample: Array[Int] = scala.Array.apply(1, 1, 1), dimOrdering: String = "CHANNEL_FIRST", wRegularizer: Regularizer[T] = null, bRegularizer: Regularizer[T] = null, bias: Boolean = true, inputShape: Shape = null)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    nbFilter

    Number of convolution filters to use.

    kernelDim1

    Length of the first dimension in the convolution kernel.

    kernelDim2

    Length of the second dimension in the convolution kernel.

    kernelDim3

    Length of the third dimension in the convolution kernel.

    init

    Initialization method for the weights of the layer. Default is Xavier. You can also pass in corresponding string representations such as 'glorot_uniform' or 'normal', etc. for simple init methods in the factory method.

    activation

    Activation function to use. Default is null. You can also pass in corresponding string representations such as 'relu' or 'sigmoid', etc. for simple activations in the factory method.

    borderMode

    Either 'valid' or 'same'. Default is 'valid'.

    subsample

    Int array of length 3. Factor by which to subsample output. Also called strides elsewhere. Default is (1, 1, 1).

    dimOrdering

    Format of the input data. Please use "CHANNEL_FIRST" (dimOrdering='th').

    wRegularizer

    An instance of Regularizer, (eg. L1 or L2 regularization), applied to the input weights matrices. Default is null.

    bRegularizer

    An instance of Regularizer, applied to the bias. Default is null.

    bias

    Whether to include a bias (i.e. make the layer affine rather than linear). Default is true.

    inputShape

    A Single Shape, does not include the batch dimension.

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

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

    Definition Classes
    Any
  6. def accGradParameters(input: Tensor[T], gradOutput: Tensor[T]): Unit

    Definition Classes
    KerasLayer → AbstractModule
  7. val activation: KerasLayer[Tensor[T], Tensor[T], T]

    Activation function to use.

    Activation function to use. Default is null. You can also pass in corresponding string representations such as 'relu' or 'sigmoid', etc. for simple activations in the factory method.

    Definition Classes
    Convolution3D → Convolution3D
  8. def apply(name: String): Option[AbstractModule[Activity, Activity, T]]

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

    Definition Classes
    Any
  10. def backward(input: Tensor[T], gradOutput: Tensor[T]): Tensor[T]

    Definition Classes
    AbstractModule
  11. var backwardTime: Long

    Attributes
    protected
    Definition Classes
    AbstractModule
  12. val bias: Boolean

    Whether to include a bias (i.

    Whether to include a bias (i.e. make the layer affine rather than linear). Default is true.

    Definition Classes
    Convolution3D → Convolution3D
  13. val borderMode: String

    Either 'valid' or 'same'.

    Either 'valid' or 'same'. Default is 'valid'.

    Definition Classes
    Convolution3D → Convolution3D
  14. def build(calcInputShape: Shape): Shape

    Definition Classes
    KerasLayer → InferShape
  15. def canEqual(other: Any): Boolean

    Definition Classes
    Container → AbstractModule
  16. final def checkEngineType(): Convolution3D.this.type

    Definition Classes
    Container → AbstractModule
  17. def clearState(): Convolution3D.this.type

    Definition Classes
    Container → AbstractModule
  18. final def clone(deepCopy: Boolean): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    AbstractModule
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def cloneModule(): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    AbstractModule
  21. def computeOutputShape(inputShape: Shape): Shape

    Definition Classes
    KerasLayer → InferShape
  22. val dimOrdering: String

    Format of the input data.

    Format of the input data. Please use "CHANNEL_FIRST" (dimOrdering='th').

    Definition Classes
    Convolution3D → Convolution3D
  23. def doBuild(inputShape: Shape): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    Convolution3D → KerasLayer
  24. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    Container → AbstractModule → AnyRef → Any
  26. final def evaluate(): Convolution3D.this.type

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

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

    Definition Classes
    AbstractModule
  29. final def evaluateImage(imageFrame: ImageFrame, vMethods: Array[_ <: ValidationMethod[T]], batchSize: Option[Int]): Array[(ValidationResult, ValidationMethod[T])]

    Definition Classes
    AbstractModule
  30. def finalize(): Unit

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

    Definition Classes
    Container
  32. final def forward(input: Tensor[T]): Tensor[T]

    Definition Classes
    AbstractModule
  33. var forwardTime: Long

    Attributes
    protected
    Definition Classes
    AbstractModule
  34. def freeze(names: String*): Convolution3D.this.type

    Definition Classes
    Container → AbstractModule
  35. def from[T](vars: Variable[T]*)(implicit arg0: ClassTag[T], ev: TensorNumeric[T]): Variable[T]

    Build graph: some other modules point to current module

    Build graph: some other modules point to current module

    vars

    upstream variables

    returns

    Variable containing current module

    Definition Classes
    Net
  36. final def getClass(): Class[_]

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

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

    Definition Classes
    InferShape
  39. final def getName(): String

    Definition Classes
    AbstractModule
  40. final def getNumericType(): TensorDataType

    Definition Classes
    AbstractModule
  41. final def getOutputShape(): Shape

    Definition Classes
    InferShape
  42. def getParametersTable(): Table

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

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

    Definition Classes
    AbstractModule
  45. final def getScaleW(): Double

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

    Definition Classes
    Container → AbstractModule
  47. final def getTimesGroupByModuleType(): Array[(String, Long, Long)]

    Definition Classes
    AbstractModule
  48. final def getWeightsBias(): Array[Tensor[T]]

    Definition Classes
    AbstractModule
  49. var gradInput: Tensor[T]

    Definition Classes
    AbstractModule
  50. final def hasName: Boolean

    Definition Classes
    AbstractModule
  51. def hashCode(): Int

    Definition Classes
    Container → AbstractModule → AnyRef → Any
  52. val init: InitializationMethod

    Initialization method for the weights of the layer.

    Initialization method for the weights of the layer. Default is Xavier. You can also pass in corresponding string representations such as 'glorot_uniform' or 'normal', etc. for simple init methods in the factory method.

    Definition Classes
    Convolution3D → Convolution3D
  53. val inputShape: Shape

    A Single Shape, does not include the batch dimension.

    A Single Shape, does not include the batch dimension.

    Definition Classes
    Convolution3D → Convolution3D
  54. def inputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Definition Classes
    KerasLayer → AbstractModule
  55. def inputs(nodes: Array[ModuleNode[T]]): ModuleNode[T]

    Definition Classes
    KerasLayer → AbstractModule
  56. def inputs(nodes: ModuleNode[T]*): ModuleNode[T]

    Definition Classes
    KerasLayer → AbstractModule
  57. def isBuilt(): Boolean

    Definition Classes
    KerasLayer → InferShape
  58. def isFrozen[T]()(implicit arg0: ClassTag[T]): Boolean

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

    Definition Classes
    Any
  60. def isKerasStyle(): Boolean

    Definition Classes
    KerasLayer → InferShape
  61. final def isTraining(): Boolean

    Definition Classes
    AbstractModule
  62. val kernelDim1: Int

    Length of the first dimension in the convolution kernel.

    Length of the first dimension in the convolution kernel.

    Definition Classes
    Convolution3D → Convolution3D
  63. val kernelDim2: Int

    Length of the second dimension in the convolution kernel.

    Length of the second dimension in the convolution kernel.

    Definition Classes
    Convolution3D → Convolution3D
  64. val kernelDim3: Int

    Length of the third dimension in the convolution kernel.

    Length of the third dimension in the convolution kernel.

    Definition Classes
    Convolution3D → Convolution3D
  65. def labor: AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    KerasLayer
  66. def labor_=(value: AbstractModule[Tensor[T], Tensor[T], T]): Unit

    Definition Classes
    KerasLayer
  67. var line: String

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

    Definition Classes
    AbstractModule
  69. final def loadWeights(weightPath: String, matchAll: Boolean): Convolution3D.this.type

    Definition Classes
    AbstractModule
  70. val modules: ArrayBuffer[AbstractModule[Activity, Activity, T]]

    Definition Classes
    Container
  71. val nbFilter: Int

    Number of convolution filters to use.

    Number of convolution filters to use.

    Definition Classes
    Convolution3D → Convolution3D
  72. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  75. var output: Tensor[T]

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

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

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

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

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

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

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

    Definition Classes
    AbstractModule
  83. def release(): Unit

    Definition Classes
    Container → AbstractModule
  84. def reset(): Unit

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

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

    Definition Classes
    AbstractModule
  87. final def saveDefinition(path: String, overWrite: Boolean): Convolution3D.this.type

    Definition Classes
    AbstractModule
  88. final def saveModule(path: String, weightPath: String, overWrite: Boolean): Convolution3D.this.type

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

    Definition Classes
    AbstractModule
  90. final def saveTorch(path: String, overWrite: Boolean): Convolution3D.this.type

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

    Definition Classes
    AbstractModule
  92. var scaleB: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  93. var scaleW: Double

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

    Definition Classes
    AbstractModule
  95. final def setLine(line: String): Convolution3D.this.type

    Definition Classes
    AbstractModule
  96. final def setName(name: String): Convolution3D.this.type

    Definition Classes
    AbstractModule
  97. def setScaleB(b: Double): Convolution3D.this.type

    Definition Classes
    Container → AbstractModule
  98. def setScaleW(w: Double): Convolution3D.this.type

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

    Definition Classes
    AbstractModule
  100. val subsample: Array[Int]

    Int array of length 3.

    Int array of length 3. Factor by which to subsample output. Also called strides elsewhere. Default is (1, 1, 1).

    Definition Classes
    Convolution3D → Convolution3D
  101. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Definition Classes
    AbstractModule
  103. def toString(): String

    Definition Classes
    AbstractModule → AnyRef → Any
  104. var train: Boolean

    Attributes
    protected
    Definition Classes
    AbstractModule
  105. final def training(): Convolution3D.this.type

    Definition Classes
    Container → AbstractModule
  106. def unFreeze(names: String*): Convolution3D.this.type

    Definition Classes
    Container → AbstractModule
  107. def updateGradInput(input: Tensor[T], gradOutput: Tensor[T]): Tensor[T]

    Definition Classes
    KerasLayer → AbstractModule
  108. def updateOutput(input: Tensor[T]): Tensor[T]

    Definition Classes
    KerasLayer → AbstractModule
  109. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  112. def zeroGradParameters(): Unit

    Definition Classes
    AbstractModule

Deprecated Value Members

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

    Definition Classes
    AbstractModule
    Annotations
    @deprecated
    Deprecated

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

Inherited from Net

Inherited from bigdl.nn.keras.Convolution3D[T]

Inherited from KerasLayer[Tensor[T], Tensor[T], T]

Inherited from Container[Tensor[T], Tensor[T], T]

Inherited from AbstractModule[Tensor[T], Tensor[T], T]

Inherited from InferShape

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped