Skip to content

Commit

Permalink
[docs] Align LSTMSequence specification attributes order with constru…
Browse files Browse the repository at this point in the history
…ctor (openvinotoolkit#27559)

### Details:
 - Align LSTMSequence specification attributes order with constructor

### Related PRs:
- openvinotoolkit#27355 

### Tickets:
 - CVS-156182

Signed-off-by: Pawel Raasz <pawel.raasz@intel.com>
  • Loading branch information
praasz authored Nov 18, 2024
1 parent 5b43849 commit 9705c7e
Showing 1 changed file with 13 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,12 @@ A single cell in the sequence is implemented in the same way as in :doc:`LSTM Ce
* **Type**: ``int``
* **Required**: *yes*

* *activations*
* *direction*

* **Description**: *activations* specifies activation functions for gates, there are three gates, so three activation functions should be specified as a value for this attributes
* **Range of values**: any combination of *relu*, *sigmoid*, *tanh*
* **Type**: a list of strings
* **Default value**: *sigmoid,tanh,tanh*
* **Required**: *no*
* **Description**: Specify if the RNN is forward, reverse, or bidirectional. If it is one of *forward* or *reverse* then ``num_directions = 1``, if it is *bidirectional*, then ``num_directions = 2``. This ``num_directions`` value specifies input/output shape requirements.
* **Range of values**: *forward*, *reverse*, *bidirectional*
* **Type**: ``string``
* **Required**: *yes*

* *activations_alpha, activations_beta*

Expand All @@ -42,6 +41,14 @@ A single cell in the sequence is implemented in the same way as in :doc:`LSTM Ce
* **Default value**: None
* **Required**: *no*

* *activations*

* **Description**: *activations* specifies activation functions for gates, there are three gates, so three activation functions should be specified as a value for this attributes
* **Range of values**: any combination of *relu*, *sigmoid*, *tanh*
* **Type**: a list of strings
* **Default value**: *sigmoid,tanh,tanh*
* **Required**: *no*

* *clip*

* **Description**: *clip* specifies bound values *[-C, C]* for tensor clipping. Clipping is performed before activations.
Expand All @@ -50,12 +57,6 @@ A single cell in the sequence is implemented in the same way as in :doc:`LSTM Ce
* **Default value**: *infinity* that means that the clipping is not applied
* **Required**: *no*

* *direction*

* **Description**: Specify if the RNN is forward, reverse, or bidirectional. If it is one of *forward* or *reverse* then ``num_directions = 1``, if it is *bidirectional*, then ``num_directions = 2``. This ``num_directions`` value specifies input/output shape requirements.
* **Range of values**: *forward*, *reverse*, *bidirectional*
* **Type**: ``string``
* **Required**: *yes*

**Inputs**

Expand Down

0 comments on commit 9705c7e

Please sign in to comment.