Class/Object

com.intel.analytics.bigdl.nn

LSTM

Related Docs: object LSTM | package nn

Permalink

class LSTM[T] extends Cell[T]

Long Short Term Memory architecture. 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()
Linear Supertypes
Cell[T], AbstractModule[Table, Table, T], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LSTM
  2. Cell
  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 LSTM(inputSize: Int, hiddenSize: Int)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    Permalink

    inputSize

    the size of each input vector

    hiddenSize

    Hidden unit size in the LSTM

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  8. def buildGates(): Sequential[T]

    Permalink
  9. def buildLSTM(): Sequential[T]

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

    Permalink
    Definition Classes
    LSTMAbstractModule
  11. var cellLayer: Sequential[T]

    Permalink
  12. def checkEngineType(): LSTM.this.type

    Permalink

    get execution engine type

    get execution engine type

    Definition Classes
    AbstractModule
  13. def clearState(): LSTM.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[Table, Table, T]

    Permalink
    Definition Classes
    AbstractModule
  16. def copyStatus(src: Module[T]): LSTM.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
    AbstractModule
  17. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    LSTMAbstractModule → AnyRef → Any
  19. def evaluate(): LSTM.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def forward(input: Table): Table

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

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractModule
  23. var gates: Sequential[T]

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

    Permalink
    Definition Classes
    AbstractModule
  30. var gradInput: Table

    Permalink

    The cached gradient of activities.

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

    Definition Classes
    AbstractModule
  31. def hashCode(): Int

    Permalink
    Definition Classes
    LSTMAbstractModule → AnyRef → Any
  32. def hidResize(hidden: Activity, size: Int): Activity

    Permalink

    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.

    size

    batchSize

    Definition Classes
    Cell
  33. val hiddenSize: Int

    Permalink

    Hidden unit size in the LSTM

  34. val hiddensShape: Array[Int]

    Permalink
    Definition Classes
    Cell
  35. val inputSize: Int

    Permalink

    the size of each input vector

  36. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AbstractModule
  38. var line: String

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

    Permalink
  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: Table

    Permalink

    The cached output.

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

    Definition Classes
    AbstractModule
  44. val p: Double

    Permalink
  45. 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
    LSTMAbstractModule
  46. 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
  47. 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
  48. def reset(): Unit

    Permalink
    Definition Classes
    LSTMAbstractModule
  49. def resetTimes(): Unit

    Permalink
    Definition Classes
    AbstractModule
  50. def save(path: String, overWrite: Boolean = false): LSTM.this.type

    Permalink
    Definition Classes
    AbstractModule
  51. def saveTorch(path: String, overWrite: Boolean = false): LSTM.this.type

    Permalink
    Definition Classes
    AbstractModule
  52. def setLine(line: String): LSTM.this.type

    Permalink
    Definition Classes
    AbstractModule
  53. def setName(name: String): LSTM.this.type

    Permalink

    Set the module name

    Set the module name

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

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

    Permalink
    Definition Classes
    LSTM → AnyRef → Any
  56. var train: Boolean

    Permalink

    Module status.

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

    Attributes
    protected
    Definition Classes
    AbstractModule
  57. def training(): LSTM.this.type

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

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

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

    Permalink
    Definition Classes
    LSTMAbstractModule
  61. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. 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
    LSTMAbstractModule

Inherited from Cell[T]

Inherited from AbstractModule[Table, Table, T]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped