# CudnnRNNV3

public final class **CudnnRNNV3** A RNN backed by cuDNN.


Computes the RNN from the input and initial states, with respect to the params
buffer. Accepts one extra input "sequence_lengths" than CudnnRNN.


rnn_mode: Indicates the type of the RNN model.
input_mode: Indicates whether there is a linear projection between the input and
the actual computation before the first layer. 'skip_input' is only allowed
when input_size == num_units; 'auto_select' implies 'skip_input' when
input_size == num_units; otherwise, it implies 'linear_input'.
direction: Indicates whether a bidirectional model will be used. Should be
"unidirectional" or "bidirectional".
dropout: Dropout probability. When set to 0., dropout is disabled.
seed: The 1st part of a seed to initialize dropout.
seed2: The 2nd part of a seed to initialize dropout.
input: If time_major is true, this is a 3-D tensor with the shape of
\[seq_length, batch_size, input_size\]. If time_major is false, the shape is
\[batch_size, seq_length, input_size\].
input_h: If time_major is true, this is a 3-D tensor with the shape of
\[num_layer \* dir, batch_size, num_units\]. If time_major is false, the shape
is \[batch_size, num_layer \* dir, num_units\].
input_c: For LSTM, a 3-D tensor with the shape of
\[num_layer \* dir, batch, num_units\]. For other models, it is ignored.
params: A 1-D tensor that contains the weights and biases in an opaque layout.
The size must be created through CudnnRNNParamsSize, and initialized
separately. Note that they might not be compatible across different
generations. So it is a good idea to save and restore
sequence_lengths: a vector of lengths of each input sequence.
output: If time_major is true, this is a 3-D tensor with the shape of
\[seq_length, batch_size, dir \* num_units\]. If time_major is false, the
shape is \[batch_size, seq_length, dir \* num_units\].
output_h: The same shape has input_h.
output_c: The same shape as input_c for LSTM. An empty tensor for other models.
is_training: Indicates whether this operation is used for inference or
training.
time_major: Indicates whether the input/output format is time major or batch
major.
reserve_space: An opaque tensor that can be used in backprop calculation. It
is only produced if is_training is true.

<br />

<br />

### Nested Classes

|---|---|---|---|
| class | [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3` |

### Public Methods

|---|---|
| static \<T extends Number\> [CudnnRNNV3](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<java.lang.Integer>,%20org.tensorflow.op.core.CudnnRNNV3.Options...))([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\> input, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> inputH, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> inputC, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> params, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Integer\> sequenceLengths, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) options) Factory method to create a class wrapping a new CudnnRNNV3 operation. |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [direction](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#direction(java.lang.String))(String direction) |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [dropout](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#dropout(java.lang.Float))(Float dropout) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<?\> | [hostReserved](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#hostReserved())() |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [inputMode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#inputMode(java.lang.String))(String inputMode) |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [isTraining](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#isTraining(java.lang.Boolean))(Boolean isTraining) |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [numProj](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#numProj(java.lang.Long))(Long numProj) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [output](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#output())() |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [outputC](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#outputC())() |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [outputH](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#outputH())() |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [reserveSpace](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#reserveSpace())() |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [rnnMode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#rnnMode(java.lang.String))(String rnnMode) |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [seed](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#seed(java.lang.Long))(Long seed) |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [seed2](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#seed2(java.lang.Long))(Long seed2) |
| static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) | [timeMajor](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3#timeMajor(java.lang.Boolean))(Boolean timeMajor) |

### 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 [CudnnRNNV3](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3)\<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\> input, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> inputH, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> inputC, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> params, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Integer\> sequenceLengths, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options) options)

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

##### Parameters

| scope | current scope |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of CudnnRNNV3

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**direction**
(String direction)

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**dropout**
(Float dropout)

<br />

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

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**inputMode**
(String inputMode)

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**isTraining**
(Boolean isTraining)

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**numProj**
(Long numProj)

<br />

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

<br />

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

<br />

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

<br />

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

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**rnnMode**
(String rnnMode)

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**seed**
(Long seed)

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**seed2**
(Long seed2)

<br />

#### public static [CudnnRNNV3.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/CudnnRNNV3.Options)
**timeMajor**
(Boolean timeMajor)

<br />