Class/Object

com.intel.analytics.bigdl.nn

BatchNormalization

Related Docs: object BatchNormalization | package nn

Permalink

class BatchNormalization[T] extends TensorModule[T]

This layer implements Batch Normalization as described in the paper: "Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift" by Sergey Ioffe, Christian Szegedy https://arxiv.org/abs/1502.03167

This implementation is useful for inputs NOT coming from convolution layers. For convolution layers, use nn.SpatialBatchNormalization.

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.

T

numeric type

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

Instance Constructors

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

    Permalink

    nOutput

    output feature map number

    eps

    avoid divide zero

    momentum

    momentum for weight update

    affine

    affine operation on output or not

    ev

    numeric operator

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. def accGradParameters(input: Tensor[T], gradOutput: Tensor[T], scale: Double): 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
    BatchNormalizationAbstractModule
  5. val affine: Boolean

    Permalink

    affine operation on output or not

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. 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]

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

    Permalink

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

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

    input

    input data

    gradOutput

    gradient of next layer

    returns

    gradient corresponding to input data

    Definition Classes
    BatchNormalizationAbstractModule
  9. var backwardTime: Long

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

    Permalink
  11. def canEqual(other: Any): Boolean

    Permalink
    Definition Classes
    BatchNormalizationAbstractModule
  12. def checkEngineType(): BatchNormalization.this.type

    Permalink

    get execution engine type

    get execution engine type

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

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

    Permalink
    Definition Classes
    AbstractModule
  16. def copyStatus(src: Module[T]): BatchNormalization.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
    BatchNormalizationAbstractModule
  17. val eps: Double

    Permalink

    avoid divide zero

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. 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
  23. var forwardTime: Long

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

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

    Permalink

    returns

    Float or Double

    Definition Classes
    AbstractModule
  27. 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
  28. 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
    BatchNormalizationAbstractModule
  29. def getTimes(): Array[(AbstractModule[_ <: Activity, _ <: Activity, T], Long, Long)]

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

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

    Permalink
  33. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AbstractModule
  36. var line: String

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  37. val momentum: Double

    Permalink

    momentum for weight update

  38. val nDim: Int

    Permalink
  39. val nOutput: Int

    Permalink

    output feature map number

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

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

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

    Permalink
    Definition Classes
    AnyRef
  43. var output: Tensor[T]

    Permalink

    The cached output.

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

    Definition Classes
    AbstractModule
  44. 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
    BatchNormalizationAbstractModule
  45. 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
  46. 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
  47. def reset(): Unit

    Permalink
    Definition Classes
    BatchNormalizationAbstractModule
  48. def resetTimes(): Unit

    Permalink
    Definition Classes
    AbstractModule
  49. val runningMean: Tensor[T]

    Permalink
  50. val runningVar: Tensor[T]

    Permalink
  51. def save(path: String, overWrite: Boolean = false): BatchNormalization.this.type

    Permalink
    Definition Classes
    AbstractModule
  52. val saveMean: Tensor[T]

    Permalink
  53. val saveStd: Tensor[T]

    Permalink
  54. def saveTorch(path: String, overWrite: Boolean = false): BatchNormalization.this.type

    Permalink
    Definition Classes
    AbstractModule
  55. def setInit(status: Boolean = true): BatchNormalization.this.type

    Permalink
    Annotations
    @inline()
  56. def setLine(line: String): BatchNormalization.this.type

    Permalink
    Definition Classes
    AbstractModule
  57. def setName(name: String): BatchNormalization.this.type

    Permalink

    Set the module name

    Set the module name

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

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

    Permalink
    Definition Classes
    BatchNormalization → AnyRef → Any
  60. var train: Boolean

    Permalink

    Module status.

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  61. def training(): BatchNormalization.this.type

    Permalink
    Definition Classes
    AbstractModule
  62. 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
    BatchNormalizationAbstractModule
  63. 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
    BatchNormalizationAbstractModule
  64. def updateParameters(learningRate: T): Unit

    Permalink
    Definition Classes
    AbstractModule
  65. final def wait(): Unit

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

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

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

    Permalink
  69. 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
    BatchNormalizationAbstractModule

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