com.intel.analytics.bigdl.nn

LSTMPeephole

class LSTMPeephole[T] extends Cell[T]

Long Short Term Memory architecture with peephole. Ref. A.: http://arxiv.org/pdf/1303.5778v1 (blueprint for this module) B. http://web.eecs.utk.edu/~itamar/courses/ECE-692/Bobby_paper1.pdf C. http://arxiv.org/pdf/1503.04069v1.pdf D. https://github.com/wojzaremba/lstm

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

Instance Constructors

  1. new LSTMPeephole(inputSize: Int, hiddenSize: Int)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    inputSize

    the size of each input vector

    hiddenSize

    Hidden unit size in the LSTM

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: Table, gradOutput: Table, 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
    LSTMPeepholeAbstractModule
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def backward(input: Table, gradOutput: Table): Table

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  10. def buildCell(): Sequential[T]

  11. def buildForgetGate(): Sequential[T]

  12. def buildGate(): Sequential[T]

  13. def buildHidden(): Sequential[T]

  14. def buildInputGate(): Sequential[T]

  15. def buildLSTM(): Sequential[T]

  16. def buildOutputGate(): Sequential[T]

  17. def canEqual(other: Any): Boolean

    Definition Classes
    LSTMPeepholeAbstractModule
  18. var cellLayer: Sequential[T]

  19. def checkEngineType(): LSTMPeephole.this.type

    get execution engine type

    get execution engine type

    Definition Classes
    AbstractModule
  20. def clearState(): LSTMPeephole.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
  21. def clone(): AnyRef

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

    Definition Classes
    AbstractModule
  23. def copyStatus(src: Module[T]): LSTMPeephole.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
    AbstractModule
  24. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    LSTMPeepholeAbstractModule → AnyRef → Any
  26. def evaluate(): LSTMPeephole.this.type

    Definition Classes
    AbstractModule
  27. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. var forgetGate: Sequential[T]

  29. final def forward(input: Table): Table

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

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

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

    returns

    Float or Double

    Definition Classes
    AbstractModule
  34. 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
  35. 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
    AbstractModule
  36. def getTimes(): Array[(AbstractModule[_ <: Activity, _ <: Activity, T], Long, Long)]

    Definition Classes
    AbstractModule
  37. var gradInput: Table

    The cached gradient of activities.

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

    Definition Classes
    AbstractModule
  38. def hashCode(): Int

    Definition Classes
    LSTMPeepholeAbstractModule → AnyRef → Any
  39. def hidResize(hidden: Activity, size: Int): Activity

    resize the hidden parameters wrt the batch size, hiddens shapes.

    resize the hidden parameters wrt the batch size, hiddens shapes.

    e.g. RnnCell contains 1 hidden parameter (H), thus it will return Tensor(size) LSTM contains 2 hidden parameters (C and H) and will return T(Tensor(), Tensor())\ and recursively intialize all the tensors in the Table.

    hidden
    size

    batchSize

    returns

    Definition Classes
    Cell
  40. var hiddenLayer: Sequential[T]

  41. val hiddenSize: Int

    Hidden unit size in the LSTM

  42. val hiddensShape: Array[Int]

    Definition Classes
    Cell
  43. var inputGate: Sequential[T]

  44. val inputSize: Int

    the size of each input vector

  45. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AbstractModule
  47. var line: String

    Attributes
    protected
    Definition Classes
    AbstractModule
  48. var lstm: Sequential[T]

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

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

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

    Definition Classes
    AnyRef
  52. var output: Table

    The cached output.

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

    Definition Classes
    AbstractModule
  53. var outputGate: Sequential[T]

  54. val p: Double

  55. 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
    LSTMPeepholeAbstractModule
  56. 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
  57. 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
  58. def reset(): Unit

    Definition Classes
    LSTMPeepholeAbstractModule
  59. def resetTimes(): Unit

    Definition Classes
    AbstractModule
  60. def save(path: String, overWrite: Boolean = false): LSTMPeephole.this.type

    Definition Classes
    AbstractModule
  61. def saveTorch(path: String, overWrite: Boolean = false): LSTMPeephole.this.type

    Definition Classes
    AbstractModule
  62. def setLine(line: String): LSTMPeephole.this.type

    Definition Classes
    AbstractModule
  63. def setName(name: String): LSTMPeephole.this.type

    Set the module name

    Set the module name

    name
    returns

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

    Definition Classes
    AnyRef
  65. def toString(): String

    Definition Classes
    LSTMPeephole → AnyRef → Any
  66. var train: Boolean

    Module status.

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  67. def training(): LSTMPeephole.this.type

    Definition Classes
    AbstractModule
  68. def updateGradInput(input: Table, gradOutput: Table): Table

    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
    LSTMPeepholeAbstractModule
  69. def updateOutput(input: Table): Table

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

    Definition Classes
    LSTMPeepholeAbstractModule
  71. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. 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
    LSTMPeepholeAbstractModule

Inherited from Cell[T]

Inherited from AbstractModule[Table, Table, T]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped