# BlockLSTMGrad

public final class **BlockLSTMGrad** Computes the LSTM cell backward propagation for the entire time sequence.


This implementation is to be used in conjunction of LSTMBlock.

<br />

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [bGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#bGrad())() The gradient for w to be back-propped. |
| static \<T extends Number\> [BlockLSTMGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<java.lang.Long>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20java.lang.Boolean))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Long\> seqLenMax, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> x, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> csPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> hPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> w, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wci, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wcf, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wco, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> b, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> i, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> cs, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> f, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> o, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> ci, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> co, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> h, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> csGrad, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> hGrad, Boolean usePeephole) Factory method to create a class wrapping a new BlockLSTMGrad operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [csPrevGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#csPrevGrad())() The gradient of cs_prev to be back-propped. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [hPrevGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#hPrevGrad())() The gradient of h_prev to be back-propped. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [wGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#wGrad())() The gradient for w to be back-propped. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [wcfGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#wcfGrad())() The gradient for wcf to be back-propped. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [wciGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#wciGrad())() The gradient for wci to be back-propped. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [wcoGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#wcoGrad())() The gradient for wco to be back-propped. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [xGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad#xGrad())() The gradient of x to be back-propped. |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**bGrad**
()

The gradient for w to be back-propped.

#### public static [BlockLSTMGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BlockLSTMGrad)\<T\>
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Long\> seqLenMax, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> x, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> csPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> hPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> w, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wci, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wcf, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wco, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> b, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> i, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> cs, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> f, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> o, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> ci, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> co, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> h, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> csGrad, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> hGrad, Boolean usePeephole)

Factory method to create a class wrapping a new BlockLSTMGrad operation.

##### Parameters

| scope | current scope |
| seqLenMax | Maximum time length actually used by this input. Outputs are padded with zeros beyond this length. |
| x | The sequence input to the LSTM, shape (timelen, batch_size, num_inputs). |
| csPrev | Value of the initial cell state. |
| hPrev | Initial output of cell (to be used for peephole). |
| w | The weight matrix. |
| wci | The weight matrix for input gate peephole connection. |
| wcf | The weight matrix for forget gate peephole connection. |
| wco | The weight matrix for output gate peephole connection. |
| b | The bias vector. |
| i | The input gate over the whole time sequence. |
| cs | The cell state before the tanh over the whole time sequence. |
| f | The forget gate over the whole time sequence. |
| o | The output gate over the whole time sequence. |
| ci | The cell input over the whole time sequence. |
| co | The cell after the tanh over the whole time sequence. |
| h | The output h vector over the whole time sequence. |
| csGrad | The current gradient of cs. |
| hGrad | The gradient of h vector. |
| usePeephole | Whether to use peephole weights. |
|---|---|

##### Returns

- a new instance of BlockLSTMGrad

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**csPrevGrad**
()

The gradient of cs_prev to be back-propped.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**hPrevGrad**
()

The gradient of h_prev to be back-propped.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**wGrad**
()

The gradient for w to be back-propped.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**wcfGrad**
()

The gradient for wcf to be back-propped.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**wciGrad**
()

The gradient for wci to be back-propped.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**wcoGrad**
()

The gradient for wco to be back-propped.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**xGrad**
()

The gradient of x to be back-propped.