Merge pull request #134 from jurevreca12/rounding_mode_new

Rounding mode new

docs/qonnx-custom-ops/quant_op.md

@@ -21,7 +21,7 @@ This operator is not part of the ONNX standard and is not currently versioned.
 <dt><tt>narrow</tt> : int (default is 0)</dt>
 <dd>Defines if the value range should be interpreted as narrow, when signed=1. E.g. at 8b regular=[-128, 127] vs narrow=[-127, 127].</dd>
 <dt><tt>rounding_mode</tt> : string (default is "ROUND")</dt>
-<dd>Defines how rounding should be applied during quantization. Currently available modes are: "ROUND", "CEIL" and "FLOOR". Here "ROUND" implies a round-to-even operation. Lowercase variants for the rounding mode string are also supported: "round", "ceil", "floor".</dd>
+<dd>Defines how rounding should be applied during quantization. Avaiable options are ROUND, CEIL, FLOOR, UP, DOWN, HALF_UP, HALF_DOWN. The rounding modes are described in the table bellow. The names of rounding modes can be upper case or lower case.</dd>
 </dl>
 
 #### Inputs
@@ -46,6 +46,24 @@ This operator is not part of the ONNX standard and is not currently versioned.
 </dl>
 
 
+#### Rounding modes
+<details>
+<summary>rounding modes</summary>
+
+| **Number \ ROUNDING_MODE** | ROUND=HALF_EVEN | CEIL | FLOOR | UP | DOWN | HALF_UP | HALF_DOWN |
+|----------------------------|-----------------|------|-------|----|------|---------|-----------|
+| 5.5                        | 6               | 6    | 5     | 6  | 5    | 6       | 5         |
+| 2.5                        | 2               | 3    | 2     | 3  | 2    | 3       | 2         |
+| 1.6                        | 2               | 2    | 1     | 2  | 1    | 2       | 2         |
+| 1.1                        | 1               | 2    | 1     | 2  | 1    | 1       | 1         |
+| 1.0                        | 1               | 1    | 1     | 1  | 1    | 1       | 1         |
+| -1.0                       | -1              | -1   | -1    | -1 | -1   | -1      | -1        |
+| -1.1                       | -1              | -1   | -2    | -2 | -1   | -1      | -1        |
+| -1.6                       | -2              | -1   | -2    | -2 | -1   | -2      | -2        |
+| -2.5                       | -2              | -2   | -3    | -3 | -2   | -3      | -2        |
+| -5.5                       | -6              | -5   | -6    | -6 | -5   | -6      | -5        |
+</details>
+
 #### Examples
 <details>
 <summary>Quant</summary>

src/qonnx/custom_op/general/quant.py

@@ -135,12 +135,32 @@ def resolve_rounding_mode(mode_string):
     """Resolve the rounding mode string of Quant and Trunc ops
     to the corresponding numpy functions."""
     normalized_mode_string = mode_string.upper()
-    if normalized_mode_string == "ROUND":
+    if normalized_mode_string == "ROUND" or normalized_mode_string == "HALF_EVEN":
         return np.round
     elif normalized_mode_string == "CEIL":
         return np.ceil
     elif normalized_mode_string == "FLOOR":
         return np.floor
+    elif normalized_mode_string == "UP":
+
+        def round_up(x):
+            return np.sign(x) * np.ceil(np.abs(x))
+
+        return round_up
+    elif normalized_mode_string == "DOWN":
+        return np.fix
+    elif normalized_mode_string == "HALF_UP":
+
+        def round_half_up(x):
+            return np.sign(x) * np.floor(np.abs(x) + 0.5)
+
+        return round_half_up
+    elif normalized_mode_string == "HALF_DOWN":
+
+        def round_half_down(x):
+            return np.sign(x) * np.ceil(np.abs(x) - 0.5)
+
+        return round_half_down
     else:
         raise ValueError(f"Could not resolve rounding mode called: {normalized_mode_string}")
 

tests/custom_op/test_runding_mode.py

@@ -0,0 +1,23 @@
+import pytest
+
+import numpy as np
+
+from qonnx.custom_op.general.quant import resolve_rounding_mode
+
+
+@pytest.mark.parametrize(
+    "rmode,exp",
+    [
+        ("ROUND", np.array([6, 2, 2, 1, 1, -1, -1, -2, -2, -6])),
+        ("CEIL", np.array([6, 3, 2, 2, 1, -1, -1, -1, -2, -5])),
+        ("FLOOR", np.array([5, 2, 1, 1, 1, -1, -2, -2, -3, -6])),
+        ("UP", np.array([6, 3, 2, 2, 1, -1, -2, -2, -3, -6])),
+        ("DOWN", np.array([5, 2, 1, 1, 1, -1, -1, -1, -2, -5])),
+        ("HALF_UP", np.array([6, 3, 2, 1, 1, -1, -1, -2, -3, -6])),
+        ("HALF_DOWN", np.array([5, 2, 2, 1, 1, -1, -1, -2, -2, -5])),
+    ],
+)
+def test_rounding_modes(rmode, exp):
+    test_array = np.array([5.5, 2.5, 1.6, 1.1, 1.0, -1.0, -1.1, -1.6, -2.5, -5.5])
+    rounding_fn = resolve_rounding_mode(rmode)
+    assert np.array_equal(rounding_fn(test_array), exp)