Merge pull request #23 from graphcore-research/ival-to-code

Rename "ival" to "code"

Author: awf

docs/source/01-decode.ipynb

@@ -45,7 +45,7 @@
     {
      "data": {
       "text/plain": [
-       "FormatInfo(name='format_info_ocp_e5m2', k=8, precision=3, emax=15, has_nz=True, has_infs=True, num_high_nans=3, has_subnormals=True, is_signed=True, is_twos_complement=False)"
+       "FormatInfo(name='ocp_e5m2', k=8, precision=3, emax=15, has_nz=True, has_infs=True, num_high_nans=3, has_subnormals=True, is_signed=True, is_twos_complement=False)"
       ]
      },
      "execution_count": 2,
@@ -100,7 +100,7 @@
        "      <th>fclass</th>\n",
        "    </tr>\n",
        "    <tr>\n",
-       "      <th>ival</th>\n",
+       "      <th>code</th>\n",
        "      <th></th>\n",
        "      <th></th>\n",
        "      <th></th>\n",
@@ -228,7 +228,7 @@
       ],
       "text/plain": [
        "              fval  exp  expval  significand  fsignificand  signbit  \\\n",
-       "ival                                                                  \n",
+       "code                                                                  \n",
        "0     0.000000e+00    0     -14            0          0.00        0   \n",
        "1     1.525879e-05    0     -14            1          0.25        0   \n",
        "2     3.051758e-05    0     -14            2          0.50        0   \n",
@@ -242,7 +242,7 @@
        "255            NaN   31      16            3          1.75        1   \n",
        "\n",
        "                    fclass  \n",
-       "ival                        \n",
+       "code                        \n",
        "0          FloatClass.ZERO  \n",
        "1     FloatClass.SUBNORMAL  \n",
        "2     FloatClass.SUBNORMAL  \n",
@@ -266,7 +266,7 @@
    "source": [
     "fmt = format_info_ocp_e5m2\n",
     "vals = [decode_float(fmt, i) for i in range(256)]\n",
-    "DataFrame(vals).set_index(\"ival\")"
+    "DataFrame(vals).set_index(\"code\")"
    ]
   },
   {
@@ -393,7 +393,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.10.0"
   }
  },
  "nbformat": 4,

docs/source/03-value-tables.ipynb

@@ -187,7 +187,7 @@
     "    text = []\n",
     "\n",
     "    # 0x45 0_1000_101\n",
-    "    text.append(f\"0x{fv.ival:02x} {str_bits_with_underscores(fi, fv)}\")\n",
+    "    text.append(f\"0x{fv.code:02x} {str_bits_with_underscores(fi, fv)}\")\n",
     "\n",
     "    finite_nonzero = np.isfinite(fv.fval) and fv.fval != 0\n",
     "\n",
@@ -212,7 +212,7 @@
     "    return \" = \".join(text)\n",
     "\n",
     "\n",
-    "for fi in (format_info_p3109(4), format_info_p3109(1)):\n",
+    "for fi in (format_info_p3109(3), format_info_p3109(1)):\n",
     "    print(fi.name)\n",
     "    for i in (\n",
     "        0x00,\n",

src/gfloat/round.py

@@ -222,6 +222,6 @@ def encode_float(fi: FormatInfo, v: float) -> int:
         isig = (1 << t) - isig
 
     # Pack values into a single integer
-    ival = (sign << (k - 1)) | (biased_exp << t) | (isig << 0)
+    code = (sign << (k - 1)) | (biased_exp << t) | (isig << 0)
 
-    return ival
+    return code

src/gfloat/types.py

@@ -36,7 +36,7 @@ class FloatValue:
     A floating-point value decoded in great detail.
     """
 
-    ival: int  #: Integer code point
+    code: int  #: Integer code point
 
     #: Value. Assumed to be exactly round-trippable to python float.
     #: This is true for all <64bit formats known in 2023.

test/test_decode.py

@@ -14,8 +14,8 @@ def _isnegzero(x: float) -> bool:
 
 def test_spot_check_ocp_e5m2() -> None:
     fi = format_info_ocp_e5m2
-    dec = lambda ival: decode_float(fi, ival).fval
-    fclass = lambda ival: decode_float(fi, ival).fclass
+    dec = lambda code: decode_float(fi, code).fval
+    fclass = lambda code: decode_float(fi, code).fclass
     assert dec(0x01) == 2.0**-16
     assert dec(0x40) == 2.0
     assert _isnegzero(dec(0x80))
@@ -30,7 +30,7 @@ def test_spot_check_ocp_e5m2() -> None:
 
 def test_spot_check_ocp_e4m3() -> None:
     fi = format_info_ocp_e4m3
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert dec(0x40) == 2.0
     assert dec(0x01) == 2.0**-9
@@ -42,7 +42,7 @@ def test_spot_check_ocp_e4m3() -> None:
 
 def test_spot_check_p3109_p3() -> None:
     fi = format_info_p3109(3)
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert dec(0x01) == 2.0**-17
     assert dec(0x40) == 1.0
@@ -53,7 +53,7 @@ def test_spot_check_p3109_p3() -> None:
 
 def test_spot_check_p3109_p1() -> None:
     fi = format_info_p3109(1)
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert dec(0x01) == 2.0**-62
     assert dec(0x40) == 2.0
@@ -64,7 +64,7 @@ def test_spot_check_p3109_p1() -> None:
 
 def test_spot_check_binary16() -> None:
     fi = format_info_binary16
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert dec(0x3C00) == 1.0
     assert dec(0x3C01) == 1.0 + 2**-10
@@ -78,7 +78,7 @@ def test_spot_check_binary16() -> None:
 
 def test_spot_check_bfloat16() -> None:
     fi = format_info_bfloat16
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert dec(0x3F80) == 1
     assert dec(0x4000) == 2
@@ -92,7 +92,7 @@ def test_spot_check_bfloat16() -> None:
 def test_spot_check_ocp_e2m3() -> None:
     # Test against Table 4 in "OCP Microscaling Formats (MX) v1.0 Spec"
     fi = format_info_ocp_e2m3
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert fi.max == 7.5
     assert fi.smallest_subnormal == 0.125
@@ -109,7 +109,7 @@ def test_spot_check_ocp_e2m3() -> None:
 def test_spot_check_ocp_e3m2() -> None:
     # Test against Table 4 in "OCP Microscaling Formats (MX) v1.0 Spec"
     fi = format_info_ocp_e3m2
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert fi.max == 28.0
     assert fi.smallest_subnormal == 0.0625
@@ -126,7 +126,7 @@ def test_spot_check_ocp_e3m2() -> None:
 def test_spot_check_ocp_e2m1() -> None:
     # Test against Table 5 in "OCP Microscaling Formats (MX) v1.0 Spec"
     fi = format_info_ocp_e2m1
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert fi.max == 6.0
     assert fi.smallest_subnormal == 0.5
@@ -149,8 +149,8 @@ def test_spot_check_ocp_e2m1() -> None:
 def test_spot_check_ocp_e8m0() -> None:
     # Test against Table 7 in "OCP Microscaling Formats (MX) v1.0 Spec"
     fi = format_info_ocp_e8m0
-    dec = lambda ival: decode_float(fi, ival).fval
-    fclass = lambda ival: decode_float(fi, ival).fclass
+    dec = lambda code: decode_float(fi, code).fval
+    fclass = lambda code: decode_float(fi, code).fclass
     assert fi.expBias == 127
     assert fi.max == 2.0**127
     assert fi.smallest == 2.0**-127
@@ -168,7 +168,7 @@ def test_spot_check_ocp_e8m0() -> None:
 def test_spot_check_ocp_int8() -> None:
     # Test against Table TODO in "OCP Microscaling Formats (MX) v1.0 Spec"
     fi = format_info_ocp_int8
-    dec = lambda ival: decode_float(fi, ival).fval
+    dec = lambda code: decode_float(fi, code).fval
 
     assert fi.max == 1.0 + 63.0 / 64
     assert fi.smallest == 2.0**-6

test/test_encode.py

@@ -21,9 +21,9 @@ def test_encode(fi: FormatInfo) -> None:
 
     for i in range(0, 2**fi.bits, step):
         fv = decode_float(fi, i)
-        ival = encode_float(fi, fv.fval)
-        assert (i == ival) or np.isnan(fv.fval)
-        fv2 = decode_float(fi, ival)
+        code = encode_float(fi, fv.fval)
+        assert (i == code) or np.isnan(fv.fval)
+        fv2 = decode_float(fi, code)
         np.testing.assert_equal(fv2.fval, fv.fval)