com.intel.analytics.bigdl.nn

SpatialBatchNormalization

class SpatialBatchNormalization[T] extends BatchNormalization[T]

This file implements Batch Normalization as described in the paper: "Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift" by Sergey Ioffe, Christian Szegedy This implementation is useful for inputs coming from convolution layers. For non-convolutional layers, see BatchNormalization The operation implemented is:

( x - mean(x) ) y = -------------------- * gamma + beta standard-deviation(x)

where gamma and beta are learnable parameters. The learning of gamma and beta is optional.

Annotations
@SerialVersionUID( 9106336963903528047L )
Linear Supertypes
BatchNormalization[T], TensorModule[T], AbstractModule[Tensor[T], Tensor[T], T], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpatialBatchNormalization
  2. BatchNormalization
  3. TensorModule
  4. AbstractModule
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpatialBatchNormalization(nOutput: Int, eps: Double = 1.0E-5, momentum: Double = 0.1, affine: Boolean = true)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def accGradParameters(input: Tensor[T], gradOutput: Tensor[T], scale: Double): 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
    scale

    Definition Classes
    BatchNormalizationAbstractModule
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def backward(input: Tensor[T], gradOutput: Tensor[T], scale: T = ev.fromType[Int](1), theGradInput: Tensor[T] = null, theGradWeight: Tensor[T] = null, theGradBias: Tensor[T] = null): Tensor[T]

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

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

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

    Definition Classes
    BatchNormalization
  12. def canEqual(other: Any): Boolean

    Definition Classes
    BatchNormalizationAbstractModule
  13. def checkEngineType(): SpatialBatchNormalization.this.type

    get execution engine type

    get execution engine type

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

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

    Definition Classes
    AbstractModule
  17. def copyStatus(src: Module[T]): SpatialBatchNormalization.this.type

    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
    BatchNormalizationAbstractModule
  18. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    BatchNormalizationAbstractModule → AnyRef → Any
  20. def evaluate(): SpatialBatchNormalization.this.type

    Definition Classes
    AbstractModule
  21. def finalize(): Unit

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

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

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

    Definition Classes
    AnyRef → Any
  25. 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
  26. def getNumericType(): TensorDataType

    returns

    Float or Double

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

    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

    returns

    Definition Classes
    AbstractModule
  28. 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").

    Custom modules should override this function if they have parameters.

    returns

    Table

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

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

    Definition Classes
    BatchNormalization
  31. var gradInput: Tensor[T]

    The cached gradient of activities.

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

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

    Definition Classes
    BatchNormalization
  33. def hashCode(): Int

    Definition Classes
    BatchNormalizationAbstractModule → AnyRef → Any
  34. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AbstractModule
  36. var line: String

    Attributes
    protected
    Definition Classes
    AbstractModule
  37. val nDim: Int

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

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

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

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

    The cached output.

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

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

    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
    BatchNormalizationAbstractModule
  43. def predict(dataset: RDD[Sample[T]]): RDD[Activity]

    module predict, return the probability distribution

    module predict, return the probability distribution

    dataset

    dataset for prediction

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

    module predict, return the predict label

    module predict, return the predict label

    dataset

    dataset for prediction

    Definition Classes
    AbstractModule
  45. def reset(): Unit

    Definition Classes
    BatchNormalizationAbstractModule
  46. def resetTimes(): Unit

    Definition Classes
    AbstractModule
  47. val runningMean: Tensor[T]

    Definition Classes
    BatchNormalization
  48. val runningVar: Tensor[T]

    Definition Classes
    BatchNormalization
  49. def save(path: String, overWrite: Boolean = false): SpatialBatchNormalization.this.type

    Definition Classes
    AbstractModule
  50. val saveMean: Tensor[T]

    Definition Classes
    BatchNormalization
  51. val saveStd: Tensor[T]

    Definition Classes
    BatchNormalization
  52. def saveTorch(path: String, overWrite: Boolean = false): SpatialBatchNormalization.this.type

    Definition Classes
    AbstractModule
  53. def setInit(status: Boolean = true): SpatialBatchNormalization.this.type

    Definition Classes
    BatchNormalization
    Annotations
    @inline()
  54. def setLine(line: String): SpatialBatchNormalization.this.type

    Definition Classes
    AbstractModule
  55. def setName(name: String): SpatialBatchNormalization.this.type

    Set the module name

    Set the module name

    name
    returns

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

    Definition Classes
    AnyRef
  57. def toString(): String

    Definition Classes
    SpatialBatchNormalizationBatchNormalization → AnyRef → Any
  58. var train: Boolean

    Module status.

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  59. def training(): SpatialBatchNormalization.this.type

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

    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
    BatchNormalizationAbstractModule
  61. def updateOutput(input: Tensor[T]): Tensor[T]

    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
    BatchNormalizationAbstractModule
  62. def updateParameters(learningRate: T): Unit

    Definition Classes
    AbstractModule
  63. final def wait(): Unit

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

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

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

    Definition Classes
    BatchNormalization
  67. 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
    BatchNormalizationAbstractModule

Inherited from BatchNormalization[T]

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