# GRUBlockCellGrad

public final class **GRUBlockCellGrad** Computes the GRU cell back-propagation for 1 time step.


Args
x: Input to the GRU cell.
h_prev: State input from the previous GRU cell.
w_ru: Weight matrix for the reset and update gate.
w_c: Weight matrix for the cell connection gate.
b_ru: Bias vector for the reset and update gate.
b_c: Bias vector for the cell connection gate.
r: Output of the reset gate.
u: Output of the update gate.
c: Output of the cell connection gate.
d_h: Gradients of the h_new wrt to objective function.


Returns
d_x: Gradients of the x wrt to objective function.
d_h_prev: Gradients of the h wrt to objective function.
d_c_bar Gradients of the c_bar wrt to objective function.
d_r_bar_u_bar Gradients of the r_bar \& u_bar wrt to objective function.


This kernel op implements the following mathematical equations:


Note on notation of the variables:


Concatenation of a and b is represented by a_b
Element-wise dot product of a and b is represented by ab
Element-wise dot product is represented by \\circ
Matrix multiplication is represented by \*


Additional notes for clarity:


\`w_ru\` can be segmented into 4 different matrices.

    w_ru = [w_r_x w_u_x
             w_r_h_prev w_u_h_prev]
     
Similarly, \`w_c\` can be segmented into 2 different matrices.

    w_c = [w_c_x w_c_h_prevr]
     
Same goes for biases.

    b_ru = [b_ru_x b_ru_h]
     b_c = [b_c_x b_c_h]
     
Another note on notation:

    d_x = d_x_component_1 + d_x_component_2
     
     where d_x_component_1 = d_r_bar * w_r_x^T + d_u_bar * w_r_x^T
     and d_x_component_2 = d_c_bar * w_c_x^T
     
     d_h_prev = d_h_prev_component_1 + d_h_prevr \circ r + d_h \circ u
     where d_h_prev_componenet_1 = d_r_bar * w_r_h_prev^T + d_u_bar * w_r_h_prev^T
     
Mathematics behind the Gradients below:

    d_c_bar = d_h \circ (1-u) \circ (1-c \circ c)
     d_u_bar = d_h \circ (h-c) \circ u \circ (1-u)
     
     d_r_bar_u_bar = [d_r_bar d_u_bar]
     
     [d_x_component_1 d_h_prev_component_1] = d_r_bar_u_bar * w_ru^T
     
     [d_x_component_2 d_h_prevr] = d_c_bar * w_c^T
     
     d_x = d_x_component_1 + d_x_component_2
     
     d_h_prev = d_h_prev_component_1 + d_h_prevr \circ r + u
     
Below calculation is performed in the python wrapper for the Gradients (not in the gradient kernel.)

    d_w_ru = x_h_prevr^T * d_c_bar
     
     d_w_c = x_h_prev^T * d_r_bar_u_bar
     
     d_b_ru = sum of d_r_bar_u_bar along axis = 0
     
     d_b_c = sum of d_c_bar along axis = 0
     
<br />

<br />

<br />

<br />

<br />

<br />

<br />

<br />

### Public Methods

|---|---|
| static \<T extends Number\> [GRUBlockCellGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad#create(org.tensorflow.op.Scope,%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>))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [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\> hPrev, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wRu, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wC, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> bRu, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> bC, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> r, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> u, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> c, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> dH) Factory method to create a class wrapping a new GRUBlockCellGrad operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [dCBar](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad#dCBar())() |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [dHPrev](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad#dHPrev())() |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [dRBarUBar](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad#dRBarUBar())() |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [dX](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad#dX())() |

### 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 static [GRUBlockCellGrad](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/GRUBlockCellGrad)\<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)\<T\> x, [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\> wRu, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> wC, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> bRu, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> bC, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> r, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> u, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> c, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> dH)

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

##### Parameters

| scope | current scope |
|---|---|

##### Returns

- a new instance of GRUBlockCellGrad

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

<br />

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

<br />

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

<br />

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

<br />