Class/Object

com.intel.analytics.bigdl.nn

SpatialConvolution

Related Docs: object SpatialConvolution | package nn

Permalink

class SpatialConvolution[T] extends TensorModule[T]

Applies a 2D convolution over an input image composed of several input planes. The input tensor in forward(input) is expected to be a 3D tensor (nInputPlane x height x width).

Annotations
@SerialVersionUID()
Linear Supertypes
TensorModule[T], AbstractModule[Tensor[T], Tensor[T], T], Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpatialConvolution
  2. TensorModule
  3. AbstractModule
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpatialConvolution(nInputPlane: Int, nOutputPlane: Int, kernelW: Int, kernelH: Int, strideW: Int = 1, strideH: Int = 1, padW: Int = 0, padH: Int = 0, nGroup: Int = 1, propagateBack: Boolean = true, initMethod: InitializationMethod = Default)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    Permalink

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. val _1x1: Boolean

    Permalink
    Attributes
    protected
  5. def accGradParameters(input: Tensor[T], gradOutput: Tensor[T], scale: Double = 1.0): Unit

    Permalink

    Computing the gradient of the module with respect to its own parameters.

    Computing the gradient of the module with respect to its own parameters. Many modules do not perform this step as they do not have any parameters. The state variable name for the parameters is module dependent. The module is expected to accumulate the gradients with respect to the parameters in some variable.

    Definition Classes
    SpatialConvolutionAbstractModule
  6. def accGradParametersFrame(gradOutput: Tensor[T], gradWeight: Tensor[T], gradBias: Tensor[T], fInput: Tensor[T], scale: T)(implicit ev: TensorNumeric[T]): Unit

    Permalink
    Attributes
    protected
  7. final def asInstanceOf[T0]: T0

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

    Permalink

    Performs a back-propagation step through the module, with respect to the given input.

    Performs a back-propagation step through the module, with respect to the given input. In general this method makes the assumption forward(input) has been called before, with the same input. This is necessary for optimization reasons. If you do not respect this rule, backward() will compute incorrect gradients.

    input

    input data

    gradOutput

    gradient of next layer

    returns

    gradient corresponding to input data

    Definition Classes
    AbstractModule
  9. var backwardTime: Long

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  10. val bias: Tensor[T]

    Permalink
  11. def calcGradParametersFrame(gradOutput: Tensor[T], gradWeight: Tensor[T], gradBias: Tensor[T], fInput: Tensor[T], scale: T)(implicit ev: TensorNumeric[T]): Unit

    Permalink
    Attributes
    protected
  12. def canEqual(other: Any): Boolean

    Permalink
    Definition Classes
    AbstractModule
  13. def checkEngineType(): SpatialConvolution.this.type

    Permalink

    get execution engine type

    get execution engine type

    Definition Classes
    AbstractModule
  14. def clearState(): SpatialConvolution.this.type

    Permalink

    Clear cached activities to save storage space or network bandwidth.

    Clear cached activities to save storage space or network bandwidth. Note that we use Tensor.set to keep some information like tensor share

    The subclass should override this method if it allocate some extra resource, and call the super.clearState in the override method

    Definition Classes
    SpatialConvolutionAbstractModule
  15. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AbstractModule
  17. var col2imTime: Long

    Permalink
    Attributes
    protected
  18. def copyStatus(src: Module[T]): SpatialConvolution.this.type

    Permalink

    Copy the useful running status from src to this.

    Copy the useful running status from src to this.

    The subclass should override this method if it has some parameters besides weight and bias. Such as runningMean and runningVar of BatchNormalization.

    src

    source Module

    returns

    this

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

    Permalink
    Definition Classes
    AnyRef
  20. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule → AnyRef → Any
  21. def evaluate(): SpatialConvolution.this.type

    Permalink
    Definition Classes
    AbstractModule
  22. var fGradInput: Tensor[T]

    Permalink
  23. var fInput: Tensor[T]

    Permalink
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def forward(input: Tensor[T]): Tensor[T]

    Permalink

    Takes an input object, and computes the corresponding output of the module.

    Takes an input object, and computes the corresponding output of the module. After a forward, the output state variable should have been updated to the new value.

    input

    input data

    returns

    output data

    Definition Classes
    AbstractModule
  26. var forwardTime: Long

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. def getCol2ImgTime(): Double

    Permalink
  29. def getIm2ColTime(): Double

    Permalink
  30. def getName(): String

    Permalink

    Get the module name, default name is className@namePostfix

    Get the module name, default name is className@namePostfix

    Definition Classes
    AbstractModule
  31. def getNumericType(): TensorDataType

    Permalink

    returns

    Float or Double

    Definition Classes
    AbstractModule
  32. def getParameters(): (Tensor[T], Tensor[T])

    Permalink

    This method compact all parameters and gradients of the model into two tensors.

    This method compact all parameters and gradients of the model into two tensors. So it's easier to use optim method

    Definition Classes
    AbstractModule
  33. def getParametersTable(): Table

    Permalink

    This function returns a table contains ModuleName, the parameter names and parameter value in this module.

    This function returns a table contains ModuleName, the parameter names and parameter value in this module. The result table is a structure of Table(ModuleName -> Table(ParameterName -> ParameterValue)), and the type is Table[String, Table[String, Tensor[T]]].

    For example, get the weight of a module named conv1: table[Table]("conv1")[Tensor[T]]("weight").

    Custom modules should override this function if they have parameters.

    returns

    Table

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

    Permalink
    Definition Classes
    AbstractModule
  35. val gradBias: Tensor[T]

    Permalink
  36. var gradInput: Tensor[T]

    Permalink

    The cached gradient of activities.

    The cached gradient of activities. So we don't compute it again when need it

    Definition Classes
    AbstractModule
  37. val gradWeight: Tensor[T]

    Permalink
  38. var gradWeightMM: Tensor[T]

    Permalink
    Attributes
    protected
  39. var gradWeightMMInBatch: Tensor[T]

    Permalink
    Attributes
    protected
  40. var gradientBiasMT: Tensor[T]

    Permalink
    Attributes
    protected
  41. def hashCode(): Int

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule → AnyRef → Any
  42. var im2colTime: Long

    Permalink
    Attributes
    protected
  43. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AbstractModule
  45. val kernelH: Int

    Permalink
  46. val kernelW: Int

    Permalink
  47. var line: String

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  48. val nGroup: Int

    Permalink
  49. val nInputPlane: Int

    Permalink
  50. val nOutputPlane: Int

    Permalink
  51. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  54. val ones: Tensor[T]

    Permalink
    Attributes
    protected
  55. val onesBatch: Tensor[T]

    Permalink
    Attributes
    protected
  56. val onesBias: Tensor[T]

    Permalink
    Attributes
    protected
  57. var output: Tensor[T]

    Permalink

    The cached output.

    The cached output. So we don't compute it again when need it

    Definition Classes
    AbstractModule
  58. val padH: Int

    Permalink
  59. val padW: Int

    Permalink
  60. def parameters(): (Array[Tensor[T]], Array[Tensor[T]])

    Permalink

    This function returns two arrays.

    This function returns two arrays. One for the weights and the other the gradients Custom modules should override this function if they have parameters

    returns

    (Array of weights, Array of grad)

    Definition Classes
    SpatialConvolutionAbstractModule
  61. def predict(dataset: RDD[Sample[T]]): RDD[Activity]

    Permalink

    module predict, return the probability distribution

    module predict, return the probability distribution

    dataset

    dataset for prediction

    Definition Classes
    AbstractModule
  62. def predictClass(dataset: RDD[Sample[T]]): RDD[Int]

    Permalink

    module predict, return the predict label

    module predict, return the predict label

    dataset

    dataset for prediction

    Definition Classes
    AbstractModule
  63. val propagateBack: Boolean

    Permalink
  64. def reset(): Unit

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule
  65. def resetTimes(): Unit

    Permalink
    Definition Classes
    AbstractModule
  66. var results: Array[Future[Unit]]

    Permalink
    Attributes
    protected
  67. def save(path: String, overWrite: Boolean = false): SpatialConvolution.this.type

    Permalink
    Definition Classes
    AbstractModule
  68. def saveTorch(path: String, overWrite: Boolean = false): SpatialConvolution.this.type

    Permalink
    Definition Classes
    AbstractModule
  69. def setInitMethod(initMethod: InitializationMethod): SpatialConvolution.this.type

    Permalink
  70. def setLine(line: String): SpatialConvolution.this.type

    Permalink
    Definition Classes
    AbstractModule
  71. def setName(name: String): SpatialConvolution.this.type

    Permalink

    Set the module name

    Set the module name

    Definition Classes
    AbstractModule
  72. val strideH: Int

    Permalink
  73. val strideW: Int

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

    Permalink
    Definition Classes
    AnyRef
  75. def toString(): String

    Permalink
    Definition Classes
    SpatialConvolution → AnyRef → Any
  76. var train: Boolean

    Permalink

    Module status.

    Module status. It is useful for modules like dropout/batch normalization

    Attributes
    protected
    Definition Classes
    AbstractModule
  77. def training(): SpatialConvolution.this.type

    Permalink
    Definition Classes
    AbstractModule
  78. def updateGradInput(input: Tensor[T], gradOutput: Tensor[T]): Tensor[T]

    Permalink

    Computing the gradient of the module with respect to its own input.

    Computing the gradient of the module with respect to its own input. This is returned in gradInput. Also, the gradInput state variable is updated accordingly.

    Definition Classes
    SpatialConvolutionAbstractModule
  79. def updateGradInputFrame(gradInput: Tensor[T], gradOutput: Tensor[T], weight: Tensor[T], fgradInput: Tensor[T], kW: Int, kH: Int, dW: Int, dH: Int, padW: Int, padH: Int)(implicit ev: TensorNumeric[T]): Unit

    Permalink
    Attributes
    protected
  80. def updateOutput(input: Tensor[T]): Tensor[T]

    Permalink

    Computes the output using the current parameter set of the class and input.

    Computes the output using the current parameter set of the class and input. This function returns the result which is stored in the output field.

    Definition Classes
    SpatialConvolutionAbstractModule
  81. def updateOutputFrame(input: Tensor[T], output: Tensor[T], weight: Tensor[T], bias: Tensor[T], fInput: Tensor[T], kW: Int, kH: Int, dW: Int, dH: Int, padW: Int, padH: Int, nInputPlane: Int, inputWidth: Int, inputHeight: Int, nOutputPlane: Int, outputWidth: Int, outputHeight: Int)(implicit ev: TensorNumeric[T]): Unit

    Permalink
    Attributes
    protected
  82. def updateParameters(learningRate: T): Unit

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule
  83. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. val weight: Tensor[T]

    Permalink
  87. var weightMM: Tensor[T]

    Permalink
    Attributes
    protected
  88. def zeroGradParameters(): Unit

    Permalink

    If the module has parameters, this will zero the accumulation of the gradients with respect to these parameters.

    If the module has parameters, this will zero the accumulation of the gradients with respect to these parameters. Otherwise, it does nothing.

    Definition Classes
    SpatialConvolutionAbstractModule

Inherited from TensorModule[T]

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped