com.intel.analytics.bigdl.nn.mkldnn

SpatialConvolution

class SpatialConvolution extends AbstractModule[Activity, Activity, Float] with MklDnnLayer with Initializable with Serializable with MklInt8Convertible

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

nInputPlane The number of expected input planes in the image given into forward() nOutputPlane: The number of output planes the convolution layer will produce. kernelW: the kernel width of the convolution kernelH: The kernel height of the convolution strideW: Int = 1, The step of the convolution in the width dimension. strideH: Int = 1, The step of the convolution in the height dimension padW: Int = 0, The additional zeros added per width to the input planes. padH: Int = 0, The additional zeros added per height to the input planes. nGroup: Int = 1, Kernel group number propagateBack: Boolean = true, propagate gradient back wRegularizer: Regularizer[Float] = null, bRegularizer: Regularizer[Float] = null, initWeight: Tensor[Float] = null, initBias: Tensor[Float] = null, initGradWeight: Tensor[Float] = null, initGradBias: Tensor[Float] = null, withBias: Boolean = true, format: DataFormat = DataFormat.NCHW, dilationW: Int = 1, dilationH: Int = 1

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

Linear Supertypes
MklInt8Convertible, Initializable, MklDnnLayer, MklDnnModule, MklDnnModuleHelper, MemoryOwner, AbstractModule[Activity, Activity, Float], InferShape, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpatialConvolution
  2. MklInt8Convertible
  3. Initializable
  4. MklDnnLayer
  5. MklDnnModule
  6. MklDnnModuleHelper
  7. MemoryOwner
  8. AbstractModule
  9. InferShape
  10. Serializable
  11. Serializable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
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[Float] = null, bRegularizer: Regularizer[Float] = null, initWeight: Tensor[Float] = null, initBias: Tensor[Float] = null, initGradWeight: Tensor[Float] = null, initGradBias: Tensor[Float] = null, withBias: Boolean = true, format: DataFormat = ..., dilationW: Int = 1, dilationH: Int = 1)

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. var _gradInputFormats: Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  7. var _gradOutputFormats: Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  8. var _gradOutputFormatsForWeight: Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  9. var _inputFormats: Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  10. var _outputFormats: Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  11. implicit lazy val _this: MemoryOwner

    Attributes
    protected
    Definition Classes
    MklDnnModuleHelper
  12. def accGradParameters(input: Activity, gradOutput: Activity): Unit

    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.

    input
    gradOutput

    Definition Classes
    SpatialConvolutionAbstractModule
  13. var accGradientPrimitives: Array[Long]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  14. def apply(name: String): Option[AbstractModule[Activity, Activity, Float]]

    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.

    name
    returns

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

    Definition Classes
    Any
  16. var bRegularizer: Regularizer[Float]

  17. def backward(input: Activity, gradOutput: Activity): Activity

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  19. def batchNorm: Boolean

  20. var biasInitMethod: InitializationMethod

    Attributes
    protected
    Definition Classes
    Initializable
  21. def calcScales(inputActvt: Activity): Unit

    Calculate the required scales for converting int8 modules Currently there are four type of modules should be supported: 1) Graph: calculate scales for input and output 2) Linear: calculate scales for input, output and weight 3) Spatial Convolution: calculate scales for input, output and weight 4) Sequential: calculate scales for input, output as well as the scales of submodules 5) ConcatTable: calculate scales for input, output as well as the scales of submodules

    Calculate the required scales for converting int8 modules Currently there are four type of modules should be supported: 1) Graph: calculate scales for input and output 2) Linear: calculate scales for input, output and weight 3) Spatial Convolution: calculate scales for input, output and weight 4) Sequential: calculate scales for input, output as well as the scales of submodules 5) ConcatTable: calculate scales for input, output as well as the scales of submodules

    inputActvt

    input activity

    Definition Classes
    MklInt8Convertible
  22. def clearState(): SpatialConvolution.this.type

    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

    returns

    Definition Classes
    AbstractModule
  23. final def clone(deepCopy: Boolean): AbstractModule[Activity, Activity, Float]

    Clone the module, deep or shallow copy

    Clone the module, deep or shallow copy

    deepCopy
    returns

    Definition Classes
    AbstractModule
  24. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def cloneModule(): SpatialConvolution.this.type

    Clone the model

    Clone the model

    returns

    Definition Classes
    AbstractModule
  26. val dilationH: Int

  27. val dilationW: Int

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

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

    Definition Classes
    AbstractModule → AnyRef → Any
  30. final def evaluate(dataSet: LocalDataSet[MiniBatch[Float]], vMethods: Array[_ <: ValidationMethod[Float]]): Array[(ValidationResult, ValidationMethod[Float])]

    use ValidationMethod to evaluate module on the given local dataset

    use ValidationMethod to evaluate module on the given local dataset

    dataSet
    vMethods
    returns

    Definition Classes
    AbstractModule
  31. final def evaluate(dataset: RDD[MiniBatch[Float]], vMethods: Array[_ <: ValidationMethod[Float]]): Array[(ValidationResult, ValidationMethod[Float])]

    use ValidationMethod to evaluate module on the given rdd dataset

    use ValidationMethod to evaluate module on the given rdd dataset

    dataset
    vMethods
    returns

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

    use ValidationMethod to evaluate module on the given rdd dataset

    use ValidationMethod to evaluate module on the given rdd dataset

    dataset

    dataset for test

    vMethods

    validation methods

    batchSize

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

    returns

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

    Set the module to evaluate mode

    Set the module to evaluate mode

    returns

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

    use ValidationMethod to evaluate module on the given ImageFrame

    use ValidationMethod to evaluate module on the given ImageFrame

    imageFrame

    ImageFrame for valudation

    vMethods

    validation methods

    batchSize

    total batch size of all partitions

    returns

    Definition Classes
    AbstractModule
  35. def finalize(): Unit

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

  37. final def forward(input: Activity): Activity

    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
  38. var forwardTime: Long

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

    freeze the module, i.

    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
  40. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  41. def getExtraParameter(): Array[Tensor[Float]]

    Get extra parameter in this module.

    Get extra parameter in this module. Extra parameter means the trainable parameters beside weight and bias. Such as runningMean and runningVar in BatchNormalization.

    The subclass should override this method if it has some parameters besides weight and bias.

    returns

    an array of tensor

    Definition Classes
    AbstractModule
  42. def getInputDimMask(): Int

    Get dimension mask of input

    Get dimension mask of input

    returns

    inputDimMask field which stores value of input dimension mask

    Definition Classes
    MklInt8Convertible
  43. def getInputScales(): Array[Array[Float]]

    Get input scales

    Get input scales

    returns

    field which stores value of input scales

    Definition Classes
    MklInt8Convertible
  44. final def getInputShape(): Shape

    Return the inputShape for the current Layer and the first dim is batch.

    Return the inputShape for the current Layer and the first dim is batch.

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

    Get the module name, default name is className@namePostfix

    Get the module name, default name is className@namePostfix

    returns

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

    Get numeric type of module parameters

    Get numeric type of module parameters

    returns

    Definition Classes
    AbstractModule
  47. def getOutputScales(): Array[Array[Float]]

    Get output scales

    Get output scales

    returns

    field which stores value of output scales

    Definition Classes
    MklInt8Convertible
  48. final def getOutputShape(): Shape

    Return the outputShape for the current Layer and the first dim is batch.

    Return the outputShape for the current Layer and the first dim is batch.

    Definition Classes
    InferShape
  49. def getParametersTable(): Table

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

    The names of the parameters follow such convention:

    1. If there's one parameter, the parameter is named as "weight", the gradient is named as "gradWeight"

    2. If there're two parameters, the first parameter is named as "weight", the first gradient is named as "gradWeight"; the second parameter is named as "bias", the seconcd gradient is named as "gradBias"

    3. If there're more parameters, the weight is named as "weight" with a seq number as suffix, the gradient is named as "gradient" with a seq number as suffix

    Custom modules should override this function the default impl if the convention doesn't meet the requirement.

    returns

    Table

    Definition Classes
    AbstractModule
  50. final def getPrintName(): String

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

    Get the scale of gradientBias

    Get the scale of gradientBias

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

    Get the scale of gradientWeight

    Get the scale of gradientWeight

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

    Get the forward/backward cost time for the module or its submodules

    Get the forward/backward cost time for the module or its submodules

    returns

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

    Get the forward/backward cost time for the module or its submodules and group by module type.

    Get the forward/backward cost time for the module or its submodules and group by module type.

    returns

    (module type name, forward time, backward time)

    Definition Classes
    AbstractModule
  55. def getUpdateGradInputMemoryPrimitives(): Array[Long]

    Definition Classes
    MklDnnLayer
  56. def getUpdateOutputMemoryPrimitives(): Array[Long]

    Definition Classes
    MklDnnLayer
  57. def getWeightDimMask(): Int

    Get dimension mask of weight

    Get dimension mask of weight

    returns

    weightDimMask which stores value of weight mask

    Definition Classes
    MklInt8Convertible
  58. def getWeightScales(): Array[Array[Float]]

    Get weight scales

    Get weight scales

    returns

    field which stores value of weight scales

    Definition Classes
    MklInt8Convertible
  59. final def getWeightsBias(): Array[Tensor[Float]]

    Get weight and bias for the module

    Get weight and bias for the module

    returns

    array of weights and bias

    Definition Classes
    AbstractModule
  60. var gradInput: Activity

    The cached gradient of activities.

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

    Definition Classes
    AbstractModule
  61. final def hasName: Boolean

    Whether user set a name to the module before

    Whether user set a name to the module before

    returns

    Definition Classes
    AbstractModule
  62. def hashCode(): Int

    Definition Classes
    AbstractModule → AnyRef → Any
  63. def initActivity(formats: Array[MemoryData]): Activity

    Attributes
    protected
    Definition Classes
    MklDnnModuleHelper
  64. val initBias: Tensor[Float]

  65. val initGradBias: Tensor[Float]

  66. val initGradWeight: Tensor[Float]

  67. def initTensor(format: MemoryData): Tensor[_]

    Attributes
    protected
    Definition Classes
    MklDnnModuleHelper
  68. val initWeight: Tensor[Float]

  69. var inputDimMask: Int

    Attributes
    protected
    Definition Classes
    MklInt8Convertible
  70. def inputs(first: (ModuleNode[Float], Int), nodesWithIndex: (ModuleNode[Float], Int)*): ModuleNode[Float]

    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
  71. def inputs(nodes: Array[ModuleNode[Float]]): ModuleNode[Float]

    Build graph: some other modules point to current module

    Build graph: some other modules point to current module

    nodes

    upstream module nodes in an array

    returns

    node containing current module

    Definition Classes
    AbstractModule
  72. def inputs(nodes: ModuleNode[Float]*): ModuleNode[Float]

    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
  73. var inputsFormats: Seq[Int]

    Attributes
    protected
    Definition Classes
    AbstractModule
  74. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  75. final def isTraining(): Boolean

    Check if the model is in training mode

    Check if the model is in training mode

    returns

    Definition Classes
    AbstractModule
  76. val kernelH: Int

  77. val kernelW: Int

  78. var line: String

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

    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
  80. final def loadWeights(weightPath: String, matchAll: Boolean = true): SpatialConvolution.this.type

    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
  81. val nGroup: Int

  82. val nInputPlane: Int

  83. val nOutputPlane: Int

  84. def nativeData(formats: Array[MemoryData]): Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnModuleHelper
  85. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  86. var needQuantize: Boolean

  87. var negativeInput: Boolean

  88. final def notify(): Unit

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

    Definition Classes
    AnyRef
  90. var output: Activity

    The cached output.

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

    Definition Classes
    AbstractModule
  91. var outputDimMask: Int

    Attributes
    protected
    Definition Classes
    MklInt8Convertible
  92. var outputsFormats: Seq[Int]

    Attributes
    protected
    Definition Classes
    AbstractModule
  93. val padH: Int

  94. val padW: Int

  95. def parameters(): (Array[Tensor[Float]], Array[Tensor[Float]])

    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
  96. def paramsMMap(): (Array[TensorMMap], Array[TensorMMap])

    Definition Classes
    SpatialConvolutionMklDnnLayer
  97. final def predict(dataset: RDD[Sample[Float]], batchSize: Int = 1, shareBuffer: Boolean = false): RDD[Activity]

    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
  98. final def predictClass(dataset: RDD[Sample[Float]], batchSize: Int = 1): RDD[Int]

    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
  99. final def predictImage(imageFrame: ImageFrame, outputLayer: String = null, shareBuffer: Boolean = false, batchPerPartition: Int = 4, predictKey: String = ImageFeature.predict, featurePaddingParam: Option[PaddingParam[Float]] = None): ImageFrame

    model predict images, return imageFrame with predicted tensor, if you want to call predictImage multiple times, it is recommended to use Predictor for DistributedImageFrame or LocalPredictor for LocalImageFrame

    model predict images, return imageFrame with predicted tensor, if you want to call predictImage multiple times, it is recommended to use Predictor for DistributedImageFrame or LocalPredictor for LocalImageFrame

    imageFrame

    imageFrame that contains images

    outputLayer

    if outputLayer is not null, the output of layer that matches outputLayer will be used as predicted output

    shareBuffer

    whether to share same memory for each batch predict results

    batchPerPartition

    batch size per partition, default is 4

    predictKey

    key to store predicted result

    featurePaddingParam

    featurePaddingParam if the inputs have variant size

    returns

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

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  102. val propagateBack: Boolean

  103. final def quantize(): Module[Float]

    Quantize this module, which reduces the precision of the parameter.

    Quantize this module, which reduces the precision of the parameter. Get a higher speed with a little accuracy cost.

    returns

    Definition Classes
    AbstractModule
  104. def registerResource(m: Releasable): Unit

    Definition Classes
    MemoryOwner
  105. def release(): Unit

    if the model contains native resources such as aligned memory, we should release it by manual.

    if the model contains native resources such as aligned memory, we should release it by manual. JVM GC can't release them reliably.

    Definition Classes
    MklDnnLayerAbstractModule
  106. def releaseResources(): Unit

    Definition Classes
    MemoryOwner
  107. def relu: Boolean

  108. def reset(): Unit

    Reset module parameters, which is re-initialize the parameter with given initMethod

    Reset module parameters, which is re-initialize the parameter with given initMethod

    Definition Classes
    SpatialConvolutionInitializableAbstractModule
  109. def resetTimes(): Unit

    Reset the forward/backward record time for the module or its submodules

    Reset the forward/backward record time for the module or its submodules

    returns

    Definition Classes
    AbstractModule
  110. var runtime: MklDnnRuntime

    MklDnn runtime, which includes a MKL-DNN engine and a MKL-DNN stream.

    MklDnn runtime, which includes a MKL-DNN engine and a MKL-DNN stream. Note that this instance will be erased when send to remote worker, so you should recreate a MklDnnRuntime.

    Attributes
    protected
    Definition Classes
    MklDnnModule
  111. final def saveCaffe(prototxtPath: String, modelPath: String, useV2: Boolean = true, overwrite: Boolean = false): SpatialConvolution.this.type

    Save this module to path in caffe readable format

    Save this module to path in caffe readable format

    prototxtPath
    modelPath
    useV2
    overwrite
    returns

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

    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
  113. final def saveModule(path: String, weightPath: String = null, overWrite: Boolean = false): SpatialConvolution.this.type

    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"

    weightPath

    where to store weight

    overWrite

    if overwrite

    returns

    self

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

    Save this module to path in tensorflow readable format

    Save this module to path in tensorflow readable format

    inputs
    path
    byteOrder
    dataFormat
    returns

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

    Save this module to path in torch7 readable format

    Save this module to path in torch7 readable format

    path
    overWrite
    returns

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

    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
  117. var scaleB: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  118. var scaleW: Double

    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
  119. def setBatchNorm(value: Boolean = true): SpatialConvolution.this.type

  120. def setExtraParameter(extraParam: Array[Tensor[Float]]): SpatialConvolution.this.type

    Set extra parameter to this module.

    Set extra parameter to this module. Extra parameter means the trainable parameters beside weight and bias. Such as runningMean and runningVar in BatchNormalization.

    returns

    this

    Definition Classes
    AbstractModule
  121. def setInitMethod(initMethod: Array[InitializationMethod]): SpatialConvolution.this.type

    Definition Classes
    Initializable
  122. def setInitMethod(weightInitMethod: InitializationMethod = null, biasInitMethod: InitializationMethod = null): SpatialConvolution.this.type

    Definition Classes
    Initializable
  123. def setInputDimMask(mask: Int, overrideSubmodules: Boolean = false): Unit

    Set dimension mask of input

    Set dimension mask of input

    mask

    value of input dimension mask to be set

    overrideSubmodules

    when set it to true, update mask including itself and submodules, otherwise only update mask to module itself.

    returns

    Unit

    Definition Classes
    MklInt8Convertible
  124. def setInputFormats(formats: Seq[Int]): SpatialConvolution.this.type

    set input formats for graph

    set input formats for graph

    formats
    returns

    Definition Classes
    AbstractModule
  125. def setInputScales(inScales: Array[Array[Float]]): Unit

    Set input scales Clear existing buffer of input scales, and place updated scales into the cleared buffer

    Set input scales Clear existing buffer of input scales, and place updated scales into the cleared buffer

    inScales

    value of input scales to be set

    returns

    Unit

    Definition Classes
    MklInt8Convertible
  126. final def setLine(line: String): SpatialConvolution.this.type

    Set the line separator when print the module

    Set the line separator when print the module

    line
    returns

    Definition Classes
    AbstractModule
  127. final def setName(name: String): SpatialConvolution.this.type

    Set the module name

    Set the module name

    name
    returns

    Definition Classes
    AbstractModule
  128. def setOutputDimMask(mask: Int, overrideSubmodules: Boolean = false): Unit

    Set dimension mask of output

    Set dimension mask of output

    mask

    value of output dimension mask to be set

    overrideSubmodules

    when set it to true, update mask in full scope including itself and submodules, otherwise only update mask to module itself.

    returns

    Unit

    Definition Classes
    MklInt8Convertible
  129. def setOutputFormats(formats: Seq[Int]): SpatialConvolution.this.type

    set output formats for graph

    set output formats for graph

    formats
    returns

    Definition Classes
    AbstractModule
  130. def setOutputScales(outScales: Array[Array[Float]]): Unit

    Set output scales Clear existing buffer of output scales, and place updated scales into the cleared buffer

    Set output scales Clear existing buffer of output scales, and place updated scales into the cleared buffer

    outScales

    value of output scales to be set

    returns

    Unit

    Definition Classes
    MklInt8Convertible
  131. def setQuantize(value: Boolean): SpatialConvolution.this.type

    Definition Classes
    SpatialConvolutionMklDnnLayerMklDnnModule
  132. def setReLU(value: Boolean = true): SpatialConvolution.this.type

  133. def setRuntime(runtime: MklDnnRuntime): Unit

    Definition Classes
    MklDnnModule
  134. def setScaleB(b: Double): SpatialConvolution.this.type

    Set the scale of gradientBias

    Set the scale of gradientBias

    b

    the value of the scale of gradientBias

    returns

    this

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

    Set the scale of gradientWeight

    Set the scale of gradientWeight

    w

    the value of the scale of gradientWeight

    returns

    this

    Definition Classes
    AbstractModule
  136. def setSum(value: Boolean = true): SpatialConvolution.this.type

  137. def setSumOp(conv: Module[Float], number: Int = 1): SpatialConvolution.this.type

  138. def setWeightDimMask(mask: Int, overrideSubmodules: Boolean = false): Unit

    Set dimension mask for weight

    Set dimension mask for weight

    mask

    value of weight mask to be set

    overrideSubmodules

    when set it to true, update mask in full scope including itself and submodules, otherwise only update mask to module itself.

    returns

    Unit

    Definition Classes
    MklInt8Convertible
  139. def setWeightScales(weightScales: Array[Array[Float]]): Unit

    Set weight scales Clear existing buffer of weight scales, and place updated scales into the cleared buffer

    Set weight scales Clear existing buffer of weight scales, and place updated scales into the cleared buffer

    weightScales

    value of weight scales to be set

    returns

    Unit

    Definition Classes
    MklInt8Convertible
  140. final def setWeightsBias(newWeights: Array[Tensor[Float]]): SpatialConvolution.this.type

    Set weight and bias for the module

    Set weight and bias for the module

    newWeights

    array of weights and bias

    returns

    Definition Classes
    AbstractModule
  141. def singleNativeData(formats: Array[MemoryData]): Array[MemoryData]

    Attributes
    protected
    Definition Classes
    MklDnnModuleHelper
  142. val strideH: Int

  143. val strideW: Int

  144. def sum: Boolean

  145. var sumOp: MklDnnLayer

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

    Definition Classes
    AnyRef
  147. def toGraph(startNodes: ModuleNode[Float]*): Graph[Float]

    Generate graph module with start nodes

    Generate graph module with start nodes

    startNodes
    returns

    Definition Classes
    AbstractModule
  148. def toString(): String

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

    Module status.

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

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

    Set the module to training mode

    Set the module to training mode

    returns

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

    "unfreeze" module, i.

    "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
  152. def updateGradInput(input: Activity, gradOutput: Activity): Activity

    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.

    input
    gradOutput
    returns

    Definition Classes
    SpatialConvolutionMklDnnLayerAbstractModule
  153. var updateGradInputPrimitives: Array[Long]

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  154. def updateOutput(input: Activity): Activity

    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.

    input
    returns

    Definition Classes
    SpatialConvolutionMklDnnLayerAbstractModule
  155. var updateOutputPrimitives: Array[Long]

    MKL-DNN primitives of the module.

    MKL-DNN primitives of the module. Note you should only initialize this field by calling initPrimitives method. This field will be erased when sending model to remote worker. So you need to reinitialize it after sending the model.

    Attributes
    protected
    Definition Classes
    MklDnnLayer
  156. def updateWithNewTensor(from: Array[Tensor[Float]], index: Int, value: Activity): Unit

    Definition Classes
    MklDnnLayer
  157. var wRegularizer: Regularizer[Float]

  158. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  161. var weightDimMask: Int

    Attributes
    protected
    Definition Classes
    MklInt8Convertible
  162. var weightInitMethod: InitializationMethod

    Attributes
    protected
    Definition Classes
    Initializable
  163. val withBias: Boolean

  164. def zeroGradParameters(): Unit

    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

    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

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

Inherited from MklInt8Convertible

Inherited from Initializable

Inherited from MklDnnLayer

Inherited from MklDnnModule

Inherited from MklDnnModuleHelper

Inherited from MemoryOwner

Inherited from AbstractModule[Activity, Activity, Float]

Inherited from InferShape

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped