IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

FloorMod operation specification refactoring. (#4569)

Browse Source 
* FloorMod operation specification refactoring.

* Add dummy broadcast_rules.md.

* Minor fixes, e.g. capitalize operation names, typos.

* Add comment about division by zero.

* Fix division by zero sentence.

Co-authored-by: Szymon Durawa <szymon.durawa@intel.com>
This commit is contained in:
Jozef Daniecki 2021-03-10 07:58:58 +01:00 committed by GitHub
parent 4791f3bfd7
commit f8ccc4f39e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/ops/arithmetic/FloorMod_1.md
View File

@ -4,9 +4,16 @@
**Category**: Arithmetic binary operation **Category**: Arithmetic binary operation
**Short description**: *FloorMod* returns an element-wise division reminder with two given tensors applying multi-directional broadcast rules. **Short description**: *FloorMod* performs an element-wise floor modulo operation with two given tensors applying broadcasting rule specified in the *auto_broadcast* attribute.
The result here is consistent with a flooring divide (like in Python programming language): `floor(x / y) * y + mod(x, y) = x`.
The sign of the result is equal to a sign of the divisor. **Detailed description**
As a first step input tensors *a* and *b* are broadcasted if their shapes differ. Broadcasting is performed according to `auto_broadcast` attribute specification. As a second step *FloorMod* operation is computed element-wise on the input tensors *a* and *b* according to the formula below:
\f[
o_{i} = a_{i} % b_{i}
\f]
*FloorMod* operation computes a reminder of a floored division. It is the same behaviour like in Python programming language: `floor(x / y) * y + floor_mod(x, y) = x`. The sign of the result is equal to a sign of a dividend. The result of division by zero is undefined.
**Attributes**: **Attributes**:
@ -14,20 +21,20 @@ The sign of the result is equal to a sign of the divisor.
* **Description**: specifies rules used for auto-broadcasting of input tensors. * **Description**: specifies rules used for auto-broadcasting of input tensors.
* **Range of values**: * **Range of values**:
* *none* - no auto-broadcasting is allowed, all input shapes should match * *none* - no auto-broadcasting is allowed, all input shapes must match
* *numpy* - numpy broadcasting rules, aligned with ONNX Broadcasting. Description is available in <a href="https://github.com/onnx/onnx/blob/master/docs/Broadcasting.md">ONNX docs</a>. * *numpy* - numpy broadcasting rules, description is available in [Broadcast Rules For Elementwise Operations](../broadcast_rules.md)
* **Type**: string * **Type**: string
* **Default value**: "numpy" * **Default value**: "numpy"
* **Required**: *no* * **Required**: *no*
**Inputs** **Inputs**
* **1**: A tensor of type T. Required. * **1**: A tensor of type T and arbitrary shape. Required.
* **2**: A tensor of type T. Required. * **2**: A tensor of type T and arbitrary shape. Required.
**Outputs** **Outputs**
* **1**: The element-wise division reminder. A tensor of type T. * **1**: The result of element-wise floor modulo operation. A tensor of type T with shape equal to broadcasted shape of two inputs.
**Types** **Types**
@ -35,10 +42,11 @@ The sign of the result is equal to a sign of the divisor.
**Examples** **Examples**
*Example 1* *Example 1 - no broadcasting*
```xml ```xml
<layer ... type="FloorMod"> <layer ... type="FloorMod">
<data auto_broadcast="none"/>
<input> <input>
<port id="0"> <port id="0">
<dim>256</dim> <dim>256</dim>
@ -58,9 +66,10 @@ The sign of the result is equal to a sign of the divisor.
</layer> </layer>
``` ```
*Example 2: broadcast* *Example 2: numpy broadcasting*
```xml ```xml
<layer ... type="FloorMod"> <layer ... type="FloorMod">
<data auto_broadcast="numpy"/>
<input> <input>
<port id="0"> <port id="0">
<dim>8</dim> <dim>8</dim>