com.intel.analytics.zoo.pipeline.api.keras.layers

GRU

class GRU[T] extends Recurrent[T] with Net

Gated Recurrent Unit architecture. The input of this layer should be 3D, i.e. (batch, time steps, input dim).

When you use this layer as the first layer of a model, you need to provide the argument inputShape (a Single Shape, does not include the batch dimension).

T

Numeric type of parameter(e.g. weight, bias). Only support float/double now.

Linear Supertypes
Net, Recurrent[T], KerasLayer[Tensor[T], Tensor[T], T], Container[Tensor[T], Tensor[T], T], AbstractModule[Tensor[T], Tensor[T], T], InferShape, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GRU
  2. Net
  3. Recurrent
  4. KerasLayer
  5. Container
  6. AbstractModule
  7. InferShape
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GRU(outputDim: Int, activation: KerasLayer[Tensor[T], Tensor[T], T] = null, innerActivation: KerasLayer[Tensor[T], Tensor[T], T] = null, returnSequences: Boolean = false, goBackwards: Boolean = false, wRegularizer: Regularizer[T] = null, uRegularizer: Regularizer[T] = null, bRegularizer: Regularizer[T] = null, inputShape: Shape = null)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    outputDim

    Hidden unit size. Dimension of internal projections and final output.

    activation

    Activation function to use. You can also pass in corresponding string representations such as 'relu' or 'sigmoid', etc. for simple activations in the factory method. Default is 'tanh'.

    innerActivation

    Activation function for inner cells. You can also pass in corresponding string representations such as 'relu' or 'sigmoid', etc. for simple activations in the factory method. Default is 'hard_sigmoid'.

    returnSequences

    Whether to return the full sequence or only return the last output in the output sequence. Default is false.

    goBackwards

    Whether the input sequence will be processed backwards. Default is false.

    wRegularizer

    An instance of Regularizer, (eg. L1 or L2 regularization), applied to the input weights matrices. Default is null.

    uRegularizer

    An instance of Regularizer, applied the recurrent weights matrices. Default is null.

    bRegularizer

    An instance of Regularizer, applied to the bias. Default is null.

    inputShape

    A Single Shape, does not include the batch dimension.

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]): Unit

    Definition Classes
    KerasLayer → AbstractModule
  7. val activation: KerasLayer[Tensor[T], Tensor[T], T]

    Activation function to use.

    Activation function to use. You can also pass in corresponding string representations such as 'relu' or 'sigmoid', etc. for simple activations in the factory method. Default is 'tanh'.

  8. def apply(name: String): Option[AbstractModule[Activity, Activity, T]]

    Definition Classes
    Container → AbstractModule
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. var bRegularizer: Regularizer[T]

    An instance of Regularizer, applied to the bias.

    An instance of Regularizer, applied to the bias. Default is null.

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

    Definition Classes
    AbstractModule
  12. var backwardTime: Long

    Attributes
    protected
    Definition Classes
    AbstractModule
  13. def build(calcInputShape: Shape): Shape

    Definition Classes
    KerasLayer → InferShape
  14. def buildCell(input: Array[Int]): Cell[T]

    Definition Classes
    GRU → Recurrent
  15. def canEqual(other: Any): Boolean

    Definition Classes
    Container → AbstractModule
  16. final def checkEngineType(): GRU.this.type

    Definition Classes
    Container → AbstractModule
  17. def clearState(): GRU.this.type

    Definition Classes
    Container → AbstractModule
  18. final def clone(deepCopy: Boolean): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    AbstractModule
  19. def clone(): AnyRef

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

    Definition Classes
    AbstractModule
  21. def computeOutputShape(inputShape: Shape): Shape

    Definition Classes
    Recurrent → KerasLayer → InferShape
  22. def doBuild(inputShape: Shape): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    Recurrent → KerasLayer
  23. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    Container → AbstractModule → AnyRef → Any
  25. final def evaluate(): GRU.this.type

    Definition Classes
    Container → AbstractModule
  26. final def evaluate(dataSet: LocalDataSet[MiniBatch[T]], vMethods: Array[_ <: ValidationMethod[T]]): Array[(ValidationResult, ValidationMethod[T])]

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

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

    Definition Classes
    AbstractModule
  29. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def findModules(moduleType: String): ArrayBuffer[AbstractModule[_, _, T]]

    Definition Classes
    Container
  31. final def forward(input: Tensor[T]): Tensor[T]

    Definition Classes
    AbstractModule
  32. var forwardTime: Long

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

    Definition Classes
    Container → AbstractModule
  34. def from[T](vars: Variable[T]*)(implicit arg0: ClassTag[T], ev: TensorNumeric[T]): Variable[T]

    Build graph: some other modules point to current module

    Build graph: some other modules point to current module

    vars

    upstream variables

    returns

    Variable containing current module

    Definition Classes
    Net
  35. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  36. def getExtraParameter(): Array[Tensor[T]]

    Definition Classes
    Container → AbstractModule
  37. final def getInputShape(): Shape

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

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

    Definition Classes
    AbstractModule
  40. final def getOutputShape(): Shape

    Definition Classes
    InferShape
  41. def getParametersTable(): Table

    Definition Classes
    Container → AbstractModule
  42. final def getPrintName(): String

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

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

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

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

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

    Definition Classes
    AbstractModule
  48. val goBackwards: Boolean

    Whether the input sequence will be processed backwards.

    Whether the input sequence will be processed backwards. Default is false.

    Definition Classes
    GRU → Recurrent
  49. var gradInput: Tensor[T]

    Definition Classes
    AbstractModule
  50. final def hasName: Boolean

    Definition Classes
    AbstractModule
  51. def hashCode(): Int

    Definition Classes
    Container → AbstractModule → AnyRef → Any
  52. val innerActivation: KerasLayer[Tensor[T], Tensor[T], T]

    Activation function for inner cells.

    Activation function for inner cells. You can also pass in corresponding string representations such as 'relu' or 'sigmoid', etc. for simple activations in the factory method. Default is 'hard_sigmoid'.

  53. val inputShape: Shape

    A Single Shape, does not include the batch dimension.

    A Single Shape, does not include the batch dimension.

    Definition Classes
    GRU → Recurrent
  54. def inputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Definition Classes
    KerasLayer → AbstractModule
  55. def inputs(nodes: Array[ModuleNode[T]]): ModuleNode[T]

    Definition Classes
    KerasLayer → AbstractModule
  56. def inputs(nodes: ModuleNode[T]*): ModuleNode[T]

    Definition Classes
    KerasLayer → AbstractModule
  57. def isBuilt(): Boolean

    Definition Classes
    KerasLayer → InferShape
  58. def isFrozen[T]()(implicit arg0: ClassTag[T]): Boolean

    Definition Classes
    Net
  59. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  60. def isKerasStyle(): Boolean

    Definition Classes
    KerasLayer → InferShape
  61. final def isTraining(): Boolean

    Definition Classes
    AbstractModule
  62. def labor: AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    KerasLayer
  63. def labor_=(value: AbstractModule[Tensor[T], Tensor[T], T]): Unit

    Definition Classes
    KerasLayer
  64. var line: String

    Attributes
    protected
    Definition Classes
    AbstractModule
  65. final def loadModelWeights(srcModel: Module[Float], matchAll: Boolean): GRU.this.type

    Definition Classes
    AbstractModule
  66. final def loadWeights(weightPath: String, matchAll: Boolean): GRU.this.type

    Definition Classes
    AbstractModule
  67. val modules: ArrayBuffer[AbstractModule[Activity, Activity, T]]

    Definition Classes
    Container
  68. final def ne(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AbstractModule
  72. val outputDim: Int

    Hidden unit size.

    Hidden unit size. Dimension of internal projections and final output.

    Definition Classes
    GRU → Recurrent
  73. def parameters(): (Array[Tensor[T]], Array[Tensor[T]])

    Definition Classes
    Container → AbstractModule
  74. final def predict(dataset: RDD[Sample[T]], batchSize: Int, shareBuffer: Boolean): RDD[Activity]

    Definition Classes
    AbstractModule
  75. final def predictClass(dataset: RDD[Sample[T]], batchSize: Int): RDD[Int]

    Definition Classes
    AbstractModule
  76. final def predictImage(imageFrame: ImageFrame, outputLayer: String, shareBuffer: Boolean, batchPerPartition: Int, predictKey: String, featurePaddingParam: Option[PaddingParam[T]]): ImageFrame

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

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  79. final def quantize(): Module[T]

    Definition Classes
    AbstractModule
  80. def release(): Unit

    Definition Classes
    Container → AbstractModule
  81. def reset(): Unit

    Definition Classes
    Container → AbstractModule
  82. def resetTimes(): Unit

    Definition Classes
    Container → AbstractModule
  83. val returnSequences: Boolean

    Whether to return the full sequence or only return the last output in the output sequence.

    Whether to return the full sequence or only return the last output in the output sequence. Default is false.

    Definition Classes
    GRU → Recurrent
  84. final def saveCaffe(prototxtPath: String, modelPath: String, useV2: Boolean, overwrite: Boolean): GRU.this.type

    Definition Classes
    AbstractModule
  85. final def saveDefinition(path: String, overWrite: Boolean): GRU.this.type

    Definition Classes
    AbstractModule
  86. final def saveModule(path: String, weightPath: String, overWrite: Boolean): GRU.this.type

    Definition Classes
    AbstractModule
  87. final def saveTF(inputs: Seq[(String, Seq[Int])], path: String, byteOrder: ByteOrder, dataFormat: TensorflowDataFormat): GRU.this.type

    Definition Classes
    AbstractModule
  88. final def saveTorch(path: String, overWrite: Boolean): GRU.this.type

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

    Definition Classes
    AbstractModule
  90. var scaleB: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  91. var scaleW: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  92. final def setExtraParameter(extraParam: Array[Tensor[T]]): GRU.this.type

    Definition Classes
    AbstractModule
  93. final def setLine(line: String): GRU.this.type

    Definition Classes
    AbstractModule
  94. final def setName(name: String): GRU.this.type

    Definition Classes
    AbstractModule
  95. def setScaleB(b: Double): GRU.this.type

    Definition Classes
    Container → AbstractModule
  96. def setScaleW(w: Double): GRU.this.type

    Definition Classes
    Container → AbstractModule
  97. final def setWeightsBias(newWeights: Array[Tensor[T]]): GRU.this.type

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

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

    Definition Classes
    AbstractModule
  100. def toString(): String

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  102. final def training(): GRU.this.type

    Definition Classes
    Container → AbstractModule
  103. var uRegularizer: Regularizer[T]

    An instance of Regularizer, applied the recurrent weights matrices.

    An instance of Regularizer, applied the recurrent weights matrices. Default is null.

  104. def unFreeze(names: String*): GRU.this.type

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

    Definition Classes
    KerasLayer → AbstractModule
  106. def updateOutput(input: Tensor[T]): Tensor[T]

    Definition Classes
    KerasLayer → AbstractModule
  107. var wRegularizer: Regularizer[T]

    An instance of Regularizer, (eg.

    An instance of Regularizer, (eg. L1 or L2 regularization), applied to the input weights matrices. Default is null.

  108. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  111. def zeroGradParameters(): Unit

    Definition Classes
    AbstractModule

Deprecated Value Members

  1. final def save(path: String, overWrite: Boolean): GRU.this.type

    Definition Classes
    AbstractModule
    Annotations
    @deprecated
    Deprecated

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

Inherited from Net

Inherited from Recurrent[T]

Inherited from KerasLayer[Tensor[T], Tensor[T], T]

Inherited from Container[Tensor[T], Tensor[T], T]

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

Inherited from InferShape

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped