Class/Object

com.intel.analytics.bigdl.nn

SpatialFullConvolution

Related Docs: object SpatialFullConvolution | package nn

Permalink

class SpatialFullConvolution[A <: Activity, T] extends AbstractModule[A, Tensor[T], T]

Apply a 2D full convolution over an input image.

The input tensor is expected to be a 3D or 4D(with batch) tensor. Note that instead of setting adjW and adjH, SpatialFullConvolution[Table, T] also accepts a table input with two tensors: T(convInput, sizeTensor) where convInput is the standard input tensor, and the size of sizeTensor is used to set the size of the output (will ignore the adjW and adjH values used to construct the module). This module can be used without a bias by setting parameter noBias = true while constructing the module.

If input is a 3D tensor nInputPlane x height x width, owidth = (width - 1) * dW - 2*padW + kW + adjW oheight = (height - 1) * dH - 2*padH + kH + adjH

Other frameworks call this operation "In-network Upsampling", "Fractionally-strided convolution", "Backwards Convolution," "Deconvolution", or "Upconvolution."

Reference Paper: Long J, Shelhamer E, Darrell T. Fully convolutional networks for semantic segmentation[C]//Proceedings of the IEEE Conference on Computer Vision and Pattern Recognition. 2015: 3431-3440.

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

Instance Constructors

  1. new SpatialFullConvolution(nInputPlane: Int, nOutputPlane: Int, kW: Int, kH: Int, dW: Int = 1, dH: Int = 1, padW: Int = 0, padH: Int = 0, adjW: Int = 0, adjH: Int = 0, nGroup: Int = 1, noBias: Boolean = false, initMethod: InitializationMethod = Default)(implicit arg0: ClassTag[A], arg1: ClassTag[T], ev: TensorNumeric[T])

    Permalink

    nInputPlane

    The number of expected input planes in the image given into forward()

    nOutputPlane

    The number of output planes the convolution layer will produce.

    kW

    The kernel width of the convolution.

    kH

    The kernel height of the convolution.

    dW

    The step of the convolution in the width dimension. Default is 1.

    dH

    The step of the convolution in the height dimension. Default is 1.

    padW

    The additional zeros added per width to the input planes. Default is 0.

    padH

    The additional zeros added per height to the input planes. Default is 0.

    adjW

    Extra width to add to the output image. Default is 0.

    adjH

    Extra height to add to the output image. Default is 0.

    nGroup

    Kernel group number.

    noBias

    If bias is needed.

    initMethod

    Init method, Default, Xavier, Bilinear.

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: A, 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
    SpatialFullConvolutionAbstractModule
  6. var adjH: Int

    Permalink

    Extra height to add to the output image.

    Extra height to add to the output image. Default is 0.

  7. var adjW: Int

    Permalink

    Extra width to add to the output image.

    Extra width to add to the output image. Default is 0.

  8. final def asInstanceOf[T0]: T0

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

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

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

    Permalink
  12. def calcGradParametersFrame(input: Tensor[T], gradOutput: Tensor[T], gradWeight: Tensor[T], gradBias: Tensor[T], columns: Tensor[T], outputHeight: Int, outputWidth: Int, scale: T)(implicit ev: TensorNumeric[T]): Unit

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

    Permalink
    Definition Classes
    AbstractModule
  14. def checkEngineType(): SpatialFullConvolution.this.type

    Permalink

    get execution engine type

    get execution engine type

    Definition Classes
    AbstractModule
  15. def clearState(): SpatialFullConvolution.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
    SpatialFullConvolutionAbstractModule
  16. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AbstractModule
  18. def copyStatus(src: Module[T]): SpatialFullConvolution.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. val dH: Int

    Permalink

    The step of the convolution in the height dimension.

    The step of the convolution in the height dimension. Default is 1.

  20. val dW: Int

    Permalink

    The step of the convolution in the width dimension.

    The step of the convolution in the width dimension. Default is 1.

  21. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    SpatialFullConvolutionAbstractModule → AnyRef → Any
  23. def evaluate(): SpatialFullConvolution.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def forward(input: A): 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
    SpatialFullConvolutionAbstractModule
  34. def getTimes(): Array[(AbstractModule[_ <: Activity, _ <: Activity, T], Long, Long)]

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

    Permalink
  36. var gradInput: A

    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 gradWeightMMInBatch: Tensor[T]

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

    Permalink
    Attributes
    protected
  40. def hashCode(): Int

    Permalink
    Definition Classes
    SpatialFullConvolutionAbstractModule → AnyRef → Any
  41. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AbstractModule
  43. val kH: Int

    Permalink

    The kernel height of the convolution.

  44. val kW: Int

    Permalink

    The kernel width of the convolution.

  45. var line: String

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

    Permalink

    Kernel group number.

  47. val nInputPlane: Int

    Permalink

    The number of expected input planes in the image given into forward()

  48. val nOutputPlane: Int

    Permalink

    The number of output planes the convolution layer will produce.

  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  50. val noBias: Boolean

    Permalink

    If bias is needed.

  51. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  53. val onesBatch: Tensor[T]

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

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

    Permalink

    The cached output.

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

    Definition Classes
    AbstractModule
  56. val padH: Int

    Permalink

    The additional zeros added per height to the input planes.

    The additional zeros added per height to the input planes. Default is 0.

  57. val padW: Int

    Permalink

    The additional zeros added per width to the input planes.

    The additional zeros added per width to the input planes. Default is 0.

  58. 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
    SpatialFullConvolutionAbstractModule
  59. 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
  60. 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
  61. def reset(): Unit

    Permalink
    Definition Classes
    SpatialFullConvolutionAbstractModule
  62. def resetTimes(): Unit

    Permalink
    Definition Classes
    AbstractModule
  63. def save(path: String, overWrite: Boolean = false): SpatialFullConvolution.this.type

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

    Permalink
    Definition Classes
    AbstractModule
  65. def setInitMethod(initMethod: InitializationMethod): SpatialFullConvolution.this.type

    Permalink
  66. def setLine(line: String): SpatialFullConvolution.this.type

    Permalink
    Definition Classes
    AbstractModule
  67. def setName(name: String): SpatialFullConvolution.this.type

    Permalink

    Set the module name

    Set the module name

    Definition Classes
    AbstractModule
  68. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    SpatialFullConvolution → AnyRef → Any
  70. var train: Boolean

    Permalink

    Module status.

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  71. def training(): SpatialFullConvolution.this.type

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

    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
    SpatialFullConvolutionAbstractModule
  73. def updateGradInputFrame(gradInput: Tensor[T], gradOutput: Tensor[T], weight: Tensor[T], columns: Tensor[T], kW: Int, kH: Int, dW: Int, dH: Int, padW: Int, padH: Int, outputHeight: Int, outputWidth: Int)(implicit ev: TensorNumeric[T]): Unit

    Permalink
    Attributes
    protected
  74. def updateOutput(input: A): 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
    SpatialFullConvolutionAbstractModule
  75. def updateOutputFrame(input: Tensor[T], output: Tensor[T], weight: Tensor[T], bias: Tensor[T], columns: 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
  76. def updateParameters(learningRate: T): Unit

    Permalink
    Definition Classes
    SpatialFullConvolutionAbstractModule
  77. final def wait(): Unit

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

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

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

    Permalink
  81. var weightMM: Tensor[T]

    Permalink
    Attributes
    protected
  82. 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
    SpatialFullConvolutionAbstractModule

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped