Class/Object

com.intel.analytics.bigdl.nn

SpatialConvolution

Related Docs: object SpatialConvolution | package nn

Permalink

class SpatialConvolution[T] extends TensorModule[T] with Initializable

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).

When padW and padH are both -1, we use a padding algorithm similar to the "SAME" padding of tensorflow. That is

outHeight = Math.ceil(inHeight.toFloat/strideH.toFloat) outWidth = Math.ceil(inWidth.toFloat/strideW.toFloat)

padAlongHeight = Math.max(0, (outHeight - 1) * strideH + kernelH - inHeight) padAlongWidth = Math.max(0, (outWidth - 1) * strideW + kernelW - inWidth)

padTop = padAlongHeight / 2 padLeft = padAlongWidth / 2

Annotations
@SerialVersionUID()
Linear Supertypes
Initializable, TensorModule[T], AbstractModule[Tensor[T], Tensor[T], T], Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpatialConvolution
  2. Initializable
  3. TensorModule
  4. AbstractModule
  5. Serializable
  6. Serializable
  7. AnyRef
  8. 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, wRegularizer: Regularizer[T] = null, bRegularizer: Regularizer[T] = null, initWeight: Tensor[T] = null, initBias: Tensor[T] = null, initGradWeight: Tensor[T] = null, initGradBias: Tensor[T] = null, withBias: Boolean = true, format: DataFormat = DataFormat.NCHW)(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]): 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], scaleW: T, scaleB: T)(implicit ev: TensorNumeric[T]): Unit

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

    Permalink

    Find a module with given name.

    Find a module with given name. If there is no module with given name, it will return None. If there are multiple modules with the given name, an exception will be thrown.

    Definition Classes
    AbstractModule
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. var bRegularizer: Regularizer[T]

    Permalink
  10. 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
  11. var backwardTime: Long

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

    Permalink
  13. var biasInitMethod: InitializationMethod

    Permalink
    Attributes
    protected
    Definition Classes
    Initializable
  14. def calcGradParametersFrame(gradOutput: Tensor[T], gradWeight: Tensor[T], gradBias: Tensor[T], fInput: Tensor[T], scaleW: T, scaleB: T)(implicit ev: TensorNumeric[T]): Unit

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

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

    Permalink

    get execution engine type

    get execution engine type

    Definition Classes
    AbstractModule
  17. 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
  18. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AbstractModule
  20. var col2imTime: Long

    Permalink
    Attributes
    protected
  21. 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
  22. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule → AnyRef → Any
  24. def evaluate(dataSet: LocalDataSet[MiniBatch[T]], vMethods: Array[ValidationMethod[T]]): Array[(ValidationResult, ValidationMethod[T])]

    Permalink
    Definition Classes
    AbstractModule
  25. def evaluate(dataset: RDD[Sample[T]], vMethods: Array[ValidationMethod[T]], batchSize: Option[Int] = None): Array[(ValidationResult, ValidationMethod[T])]

    Permalink

    use ValidationMethod to evaluate module

    use ValidationMethod to evaluate module

    dataset

    dataset for test

    vMethods

    validation methods

    batchSize

    total batchsize of all partitions, optional param and default 4 * partitionNum of dataset

    Definition Classes
    AbstractModule
  26. def evaluate(): SpatialConvolution.this.type

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

    Permalink
  28. var fInput: Tensor[T]

    Permalink
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. val format: DataFormat

    Permalink
  31. 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
  32. var forwardTime: Long

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

    Permalink

    freeze the module, i.e.

    freeze the module, i.e. their parameters(weight/bias, if exists) are not changed in training process if names is not empty, set an array of layers that match the given names to be "freezed",

    names

    an array of layer names

    returns

    current graph model

    Definition Classes
    AbstractModule
  34. final def getClass(): Class[_]

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

    Permalink
  36. def getIm2ColTime(): Double

    Permalink
  37. 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
  38. def getNamePostfix: String

    Permalink
    Definition Classes
    AbstractModule
  39. def getNumericType(): TensorDataType

    Permalink

    returns

    Float or Double

    Definition Classes
    AbstractModule
  40. def getPadding(inputHeight: Int, inputWidth: Int): (Int, Int, Int, Int)

    Permalink
    Attributes
    protected
  41. 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
  42. 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
  43. def getPrintName(): String

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

    Permalink

    Get the scale of gradientBias

    Get the scale of gradientBias

    Definition Classes
    AbstractModule
  45. def getScaleW(): Double

    Permalink

    Get the scale of gradientWeight

    Get the scale of gradientWeight

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

    Permalink
    Definition Classes
    AbstractModule
  47. def getWeightsBias(): Array[Tensor[T]]

    Permalink

    Get weight and bias for the module

    Get weight and bias for the module

    returns

    array of weights and bias

    Definition Classes
    AbstractModule
  48. val gradBias: Tensor[T]

    Permalink
  49. 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
  50. val gradWeight: Tensor[T]

    Permalink
  51. var gradWeightMM: Tensor[T]

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

    Permalink
    Attributes
    protected
  53. val gradientBiasMT: Tensor[T]

    Permalink
    Attributes
    protected
  54. def hasName: Boolean

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

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

    Permalink
    Attributes
    protected
  57. val initBias: Tensor[T]

    Permalink
  58. val initGradBias: Tensor[T]

    Permalink
  59. val initGradWeight: Tensor[T]

    Permalink
  60. val initWeight: Tensor[T]

    Permalink
  61. def inputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Permalink

    Build graph: some other modules point to current module

    Build graph: some other modules point to current module

    first

    distinguish from another inputs when input parameter list is empty

    nodesWithIndex

    upstream module nodes and the output tensor index. The start index is 1.

    returns

    node containing current module

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

    Permalink

    Build graph: some other modules point to current module

    Build graph: some other modules point to current module

    nodes

    upstream module nodes

    returns

    node containing current module

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

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

    Permalink
    Definition Classes
    AbstractModule
  65. val kernelH: Int

    Permalink
  66. val kernelW: Int

    Permalink
  67. var line: String

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  68. def loadModelWeights(srcModel: Module[Float], matchAll: Boolean = true): SpatialConvolution.this.type

    Permalink

    copy weights from another model, mapping by layer name

    copy weights from another model, mapping by layer name

    srcModel

    model to copy from

    matchAll

    whether to match all layers' weights and bias,

    returns

    current module

    Definition Classes
    AbstractModule
  69. def loadWeights(weightPath: String, matchAll: Boolean = true): SpatialConvolution.this.type

    Permalink

    load pretrained weights and bias to current module

    load pretrained weights and bias to current module

    weightPath

    file to store weights and bias

    matchAll

    whether to match all layers' weights and bias, if not, only load existing pretrained weights and bias

    returns

    current module

    Definition Classes
    AbstractModule
  70. val nGroup: Int

    Permalink
  71. val nInputPlane: Int

    Permalink
  72. val nOutputPlane: Int

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

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

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

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

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

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

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

    Permalink

    The cached output.

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

    Definition Classes
    AbstractModule
  80. val padH: Int

    Permalink
  81. val padW: Int

    Permalink
  82. 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
  83. def predict(dataset: RDD[Sample[T]], batchSize: Int = 1, shareBuffer: Boolean = false): RDD[Activity]

    Permalink

    module predict, return the probability distribution

    module predict, return the probability distribution

    dataset

    dataset for prediction

    batchSize

    total batchSize for all partitions. if -1, default is 4 * partitionNumber of datatset

    shareBuffer

    whether to share same memory for each batch predict results

    Definition Classes
    AbstractModule
  84. def predictClass(dataset: RDD[Sample[T]], batchSize: Int = 1): RDD[Int]

    Permalink

    module predict, return the predict label

    module predict, return the predict label

    dataset

    dataset for prediction

    batchSize

    total batchSize for all partitions. if -1, default is 4 * partitionNumber of dataset

    Definition Classes
    AbstractModule
  85. val propagateBack: Boolean

    Permalink
  86. def quantize(): Module[T]

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

    Permalink
  88. def resetTimes(): Unit

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

    Permalink
    Attributes
    protected
  90. def saveCaffe(prototxtPath: String, modelPath: String, useV2: Boolean = true, overwrite: Boolean = false): SpatialConvolution.this.type

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

    Permalink

    Save this module definition to path.

    Save this module definition to path.

    path

    path to save module, local file system, HDFS and Amazon S3 is supported. HDFS path should be like "hdfs://[host]:[port]/xxx" Amazon S3 path should be like "s3a://bucket/xxx"

    overWrite

    if overwrite

    returns

    self

    Definition Classes
    AbstractModule
  92. def saveModule(path: String, overWrite: Boolean = false): SpatialConvolution.this.type

    Permalink

    Save this module to path with protobuf format

    Save this module to path with protobuf format

    path

    path to save module, local file system, HDFS and Amazon S3 is supported. HDFS path should be like "hdfs://[host]:[port]/xxx" Amazon S3 path should be like "s3a://bucket/xxx"

    overWrite

    if overwrite

    returns

    self

    Definition Classes
    AbstractModule
  93. def saveTF(inputs: Seq[(String, Seq[Int])], path: String, byteOrder: ByteOrder = ByteOrder.LITTLE_ENDIAN, dataFormat: TensorflowDataFormat = TensorflowDataFormat.NHWC): SpatialConvolution.this.type

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

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

    Permalink

    save weights and bias to file

    save weights and bias to file

    path

    file to save

    overWrite

    whether to overwrite or not

    Definition Classes
    AbstractModule
  96. var scaleB: Double

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

    Permalink

    The scale of gradient weight and gradient bias before gradParameters being accumulated.

    The scale of gradient weight and gradient bias before gradParameters being accumulated.

    Attributes
    protected
    Definition Classes
    AbstractModule
  98. def setInitMethod(weightInitMethod: InitializationMethod = null, biasInitMethod: InitializationMethod = null): SpatialConvolution.this.type

    Permalink
    Definition Classes
    Initializable
  99. def setLine(line: String): SpatialConvolution.this.type

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

    Permalink

    Set the module name

    Set the module name

    Definition Classes
    AbstractModule
  101. def setNamePostfix(namePostfix: String): Unit

    Permalink
    Definition Classes
    AbstractModule
  102. def setScaleB(b: Double): SpatialConvolution.this.type

    Permalink

    Set the scale of gradientBias

    Set the scale of gradientBias

    b

    the value of the scale of gradientBias

    returns

    this

    Definition Classes
    AbstractModule
  103. def setScaleW(w: Double): SpatialConvolution.this.type

    Permalink

    Set the scale of gradientWeight

    Set the scale of gradientWeight

    w

    the value of the scale of gradientWeight

    returns

    this

    Definition Classes
    AbstractModule
  104. def setWeightsBias(newWeights: Array[Tensor[T]]): SpatialConvolution.this.type

    Permalink

    Set weight and bias for the module

    Set weight and bias for the module

    newWeights

    array of weights and bias

    Definition Classes
    AbstractModule
  105. val strideH: Int

    Permalink
  106. val strideW: Int

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

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

    Permalink

    Generate graph module with start nodes

    Generate graph module with start nodes

    Definition Classes
    AbstractModule
  109. def toString(): String

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule → AnyRef → Any
  110. var train: Boolean

    Permalink

    Module status.

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

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

    Permalink
    Definition Classes
    AbstractModule
  112. def unFreeze(names: String*): SpatialConvolution.this.type

    Permalink

    "unfreeze" module, i.e.

    "unfreeze" module, i.e. make the module parameters(weight/bias, if exists) to be trained(updated) in training process if names is not empty, unfreeze layers that match given names

    names

    array of module names to unFreeze

    Definition Classes
    AbstractModule
  113. 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
  114. def updateGradInputFrame(gradInput: Tensor[T], gradOutput: Tensor[T], weight: Tensor[T], fgradInput: Tensor[T], kW: Int, kH: Int, dW: Int, dH: Int, padLeft: Int, padTop: Int, padRight: Int, padBottom: Int)(implicit ev: TensorNumeric[T]): Unit

    Permalink
    Attributes
    protected
  115. 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
  116. 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, padLeft: Int, padTop: Int, padRight: Int, padBottom: Int, nInputPlane: Int, inputWidth: Int, inputHeight: Int, nOutputPlane: Int, outputWidth: Int, outputHeight: Int)(implicit ev: TensorNumeric[T]): Unit

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

    Permalink
    Definition Classes
    SpatialConvolutionAbstractModule
  118. var wRegularizer: Regularizer[T]

    Permalink
  119. final def wait(): Unit

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

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

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

    Permalink
  123. var weightInitMethod: InitializationMethod

    Permalink
    Attributes
    protected
    Definition Classes
    Initializable
  124. var weightMM: Tensor[T]

    Permalink
    Attributes
    protected
  125. val withBias: Boolean

    Permalink
  126. 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

Deprecated Value Members

  1. def save(path: String, overWrite: Boolean = false): SpatialConvolution.this.type

    Permalink

    Save this module to path.

    Save this module to path.

    path

    path to save module, local file system, HDFS and Amazon S3 is supported. HDFS path should be like "hdfs://[host]:[port]/xxx" Amazon S3 path should be like "s3a://bucket/xxx"

    overWrite

    if overwrite

    returns

    self

    Definition Classes
    AbstractModule
    Annotations
    @deprecated
    Deprecated

    please use recommended saveModule(path, overWrite)

Inherited from Initializable

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