Skip to content

Commit

Permalink
DOCS shift to rst - Opsets E for master (#17363)
Browse files Browse the repository at this point in the history
  • Loading branch information
msmykx-intel authored May 5, 2023
1 parent 909d539 commit 175e169
Show file tree
Hide file tree
Showing 27 changed files with 1,188 additions and 1,175 deletions.
59 changes: 32 additions & 27 deletions docs/ops/activation/Elu_1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Elu {#openvino_docs_ops_activation_Elu_1}

@sphinxdirective

**Versioned name**: *Elu-1*

**Category**: *Activation function*
Expand All @@ -8,15 +10,16 @@

**Detailed Description**

*Elu* operation is introduced in this [article](https://arxiv.org/abs/1511.07289v3).
*Elu* operation is introduced in this `article <https://arxiv.org/abs/1511.07289v3>`__.
It performs element-wise activation function on a given input tensor, based on the following mathematical formula:

\f[
Elu(x) = \left\{\begin{array}{r}
x \qquad \mbox{if } x > 0 \\
\alpha(e^{x} - 1) \quad \mbox{if } x \leq 0
\end{array}\right.
\f]
.. math::

Elu(x) = \left\begin{array}{r}
x \qquad \mbox{if } x > 0 \\
\alpha(e^{x} - 1) \quad \mbox{if } x \leq 0
\end{array}\right.


where α corresponds to *alpha* attribute.

Expand All @@ -28,37 +31,39 @@ where α corresponds to *alpha* attribute.

* **Description**: scale for the negative factor
* **Range of values**: non-negative arbitrary floating-point number
* **Type**: `float`
* **Type**: ``float``
* **Required**: *yes*

**Inputs**:

* **1**: A tensor of type *T* and arbitrary shape. **Required.**
* **1**: A tensor of type *T* and arbitrary shape. **Required.**

**Outputs**:

* **1**: The result of element-wise *Elu* function applied to the input tensor. A tensor of type *T* and the same shape as input tensor.
* **1**: The result of element-wise *Elu* function applied to the input tensor. A tensor of type *T* and the same shape as input tensor.

**Types**

* *T*: arbitrary supported floating-point type.

**Example**

```xml
<layer ... type="Elu">
<data alpha="1.0"/>
<input>
<port id="0">
<dim>1</dim>
<dim>128</dim>
</port>
</input>
<output>
<port id="1">
<dim>1</dim>
<dim>128</dim>
</port>
</output>
</layer>
```
.. code-block:: cpp

<layer ... type="Elu">
<data alpha="1.0"/>
<input>
<port id="0">
<dim>1</dim>
<dim>128</dim>
</port>
</input>
<output>
<port id="1">
<dim>1</dim>
<dim>128</dim>
</port>
</output>
</layer>

@endsphinxdirective
47 changes: 26 additions & 21 deletions docs/ops/activation/Exp_1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Exp {#openvino_docs_ops_activation_Exp_1}

@sphinxdirective

**Versioned name**: *Exp-1*

**Category**: *Activation function*
Expand All @@ -10,39 +12,42 @@

*Exp* performs element-wise exponential activation function on a given input tensor. The mathematical formula is as follows:

\f[
exp(x) = e^{x}
\f]
.. math::
exp(x) = e^{x}

**Attributes**: *Exp* operation has no attributes.

**Inputs**

* **1**: A tensor of type *T* and arbitrary shape. **Required.**
* **1**: A tensor of type *T* and arbitrary shape. **Required.**

**Outputs**

* **1**: The result of element-wise *Exp* function applied to the input tensor. A tensor of type *T* and the same shape as input tensor.
* **1**: The result of element-wise *Exp* function applied to the input tensor. A tensor of type *T* and the same shape as input tensor.

**Types**

* *T*: arbitrary supported floating-point type.

**Example**

```xml
<layer ... type="Exp">
<input>
<port id="0">
<dim>1</dim>
<dim>256</dim>
</port>
</input>
<output>
<port id="1">
<dim>1</dim>
<dim>256</dim>
</port>
</output>
</layer>
```
.. code-block:: cpp

<layer ... type="Exp">
<input>
<port id="0">
<dim>1</dim>
<dim>256</dim>
</port>
</input>
<output>
<port id="1">
<dim>1</dim>
<dim>256</dim>
</port>
</output>
</layer>

@endsphinxdirective

2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Abs_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ No attributes available.

*Example 1*

.. code-block:: console
.. code-block:: cpp

<layer ... type="Abs">
<input>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Acos_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ No attributes available.

*Example 1*

.. code-block:: console
.. code-block:: cpp

<layer ... type="Acos">
<input>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Acosh_3.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

**Examples**

.. code-block:: console
.. code-block:: cpp

<layer ... type="Acosh">
<input>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Add_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ After broadcasting *Add* performs addition operation for the input tensors *a* a

*Example 1*

.. code-block:: console
.. code-block:: cpp

<layer ... type="Add">
<data auto_broadcast="none"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Asin_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ No attributes available.

*Example 1*

.. code-block:: console
.. code-block:: cpp

<layer ... type="Asin">
<input>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Asinh_3.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

**Example**

.. code-block:: console
.. code-block:: cpp

<layer ... type="Asinh">
<input>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Atan_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

**Examples**

.. code-block:: console
.. code-block:: cpp

<layer ... type="Atan">
<input>
Expand Down
2 changes: 1 addition & 1 deletion docs/ops/arithmetic/Atanh_3.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Unsigned Intragral type put:

**Examples**

.. code-block:: console
.. code-block:: cpp

<layer ... type="Atanh">
<input>
Expand Down
44 changes: 24 additions & 20 deletions docs/ops/arithmetic/Erf_1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Erf {#openvino_docs_ops_arithmetic_Erf_1}

@sphinxdirective

**Versioned name**: *Erf-1*

**Category**: *Arithmetic unary*
Expand All @@ -10,9 +12,9 @@

*Erf* performs element-wise erf operation on a given input tensor, based on the following mathematical formula:

\f[
erf(x) = \pi^{-1} \int_{-x}^{x} e^{-t^2} dt
\f]
.. math::
erf(x) = \pi^{-1} \int_{-x}^{x} e^{-t^2} dt

**Attributes**: *Erf* operation has no attributes.

Expand All @@ -28,22 +30,24 @@ erf(x) = \pi^{-1} \int_{-x}^{x} e^{-t^2} dt

* *T*: any supported numeric type.


**Example**

```xml
<layer ... type="Erf">
<input>
<port id="0">
<dim>256</dim>
<dim>56</dim>
</port>
</input>
<output>
<port id="1">
<dim>256</dim>
<dim>56</dim>
</port>
</output>
</layer>
```
.. code-block:: cpp

<layer ... type="Erf">
<input>
<port id="0">
<dim>256</dim>
<dim>56</dim>
</port>
</input>
<output>
<port id="1">
<dim>256</dim>
<dim>56</dim>
</port>
</output>
</layer>

@endsphinxdirective

Loading

0 comments on commit 175e169

Please sign in to comment.