Merge pull request #22 from graphcore-research/formats-fix

Shorten format names

Author: awf

docs/source/01-decode.ipynb

@@ -45,7 +45,7 @@
     {
      "data": {
       "text/plain": [
-       "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)"
+       "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)"
       ]
      },
      "execution_count": 2,
@@ -288,6 +288,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
+      "Format                  ocp_e4m3             ocp_e5m2              p3109_p3\n",
       "Max exponent (emax)     8                    15                    15\n",
       "Exponent bias           7                    15                    16\n",
       "Infinities              0                    2                     2\n",
@@ -306,6 +307,7 @@
     "\n",
     "\n",
     "for prop, probe in (\n",
+    "    (\"Format                 \", lambda fi: fi.name.replace(\"format_info_\", \"\")),\n",
     "    (\"Max exponent (emax)    \", lambda fi: fi.emax),\n",
     "    (\"Exponent bias          \", lambda fi: fi.expBias),\n",
     "    (\"Infinities             \", lambda fi: 2 * int(fi.has_infs)),\n",

src/gfloat/formats.py

@@ -5,7 +5,7 @@
 
 #: FormatInfo for IEEE-754 Binary32 format
 format_info_binary32 = FormatInfo(
-    name="format_info_binary32",
+    name="binary32",
     k=32,
     precision=24,
     emax=127,
@@ -19,7 +19,7 @@
 
 #: FormatInfo for IEEE-754 Binary16 format
 format_info_binary16 = FormatInfo(
-    name="format_info_binary16",
+    name="binary16",
     k=16,
     precision=11,
     emax=15,
@@ -33,7 +33,7 @@
 
 #: FormatInfo for Google BFloat16 format
 format_info_bfloat16 = FormatInfo(
-    name="format_info_bfloat16",
+    name="bfloat16",
     k=16,
     precision=8,
     emax=127,
@@ -47,7 +47,7 @@
 
 #: FormatInfo for OCP E5M2 format
 format_info_ocp_e5m2 = FormatInfo(
-    name="format_info_ocp_e5m2",
+    name="ocp_e5m2",
     k=8,
     precision=3,
     emax=15,
@@ -61,7 +61,7 @@
 
 #: FormatInfo for OCP E4M3 format
 format_info_ocp_e4m3 = FormatInfo(
-    name="format_info_ocp_e4m3",
+    name="ocp_e4m3",
     k=8,
     precision=4,
     emax=8,
@@ -75,7 +75,7 @@
 
 #: FormatInfo for OCP MX E2M3 format
 format_info_ocp_e2m3 = FormatInfo(
-    name="format_info_ocp_e2m3",
+    name="ocp_e2m3",
     k=6,
     precision=4,
     emax=2,
@@ -89,7 +89,7 @@
 
 #: FormatInfo for OCP MX E3M2 format
 format_info_ocp_e3m2 = FormatInfo(
-    name="format_info_ocp_e3m2",
+    name="ocp_e3m2",
     k=6,
     precision=3,
     emax=4,
@@ -103,7 +103,7 @@
 
 #: FormatInfo for OCP MX E2M1 format
 format_info_ocp_e2m1 = FormatInfo(
-    name="format_info_ocp_e2m1",
+    name="ocp_e2m1",
     k=4,
     precision=2,
     emax=2,
@@ -117,7 +117,7 @@
 
 #: FormatInfo for OCP MX E8M0 format
 format_info_ocp_e8m0 = FormatInfo(
-    name="format_info_ocp_e8m0",
+    name="ocp_e8m0",
     k=8,
     precision=1,
     emax=127,
@@ -131,7 +131,7 @@
 
 #: FormatInfo for OCP MX INT8 format
 format_info_ocp_int8 = FormatInfo(
-    name="format_info_ocp_int8",
+    name="ocp_int8",
     k=8,
     precision=8,
     emax=0,
@@ -178,63 +178,63 @@ def format_info_p3109(precision: int) -> FormatInfo:
 
 
 # Collections of formats
-tiny_formats = [
+_tiny_formats = [
     format_info_ocp_e2m1,
     format_info_ocp_e2m3,
     format_info_ocp_e3m2,
 ]
 
 p3109_formats = [format_info_p3109(p) for p in range(1, 7)]
 
-fp8_formats = [
+_fp8_formats = [
     format_info_ocp_e4m3,
     format_info_ocp_e5m2,
     *p3109_formats,
 ]
 
-fp16_formats = [
+_fp16_formats = [
     format_info_binary16,
     format_info_bfloat16,
 ]
 
 all_formats = [
     format_info_ocp_e8m0,
     format_info_ocp_int8,
-    *tiny_formats,
-    *fp8_formats,
-    *fp16_formats,
+    *_tiny_formats,
+    *_fp8_formats,
+    *_fp16_formats,
     format_info_binary32,
 ]
 
 # ------
 # Block formats
 
 format_info_mxfp8_e5m2 = BlockFormatInfo(
-    "format_info_mxfp8_e5m2", format_info_ocp_e5m2, 32, format_info_ocp_e8m0
+    "mxfp8_e5m2", format_info_ocp_e5m2, 32, format_info_ocp_e8m0
 )
 
 format_info_mxfp8_e4m3 = BlockFormatInfo(
-    "format_info_mxfp8_e4m3", format_info_ocp_e4m3, 32, format_info_ocp_e8m0
+    "mxfp8_e4m3", format_info_ocp_e4m3, 32, format_info_ocp_e8m0
 )
 
 format_info_mxfp6_e3m2 = BlockFormatInfo(
-    "format_info_mxfp6_e3m2", format_info_ocp_e3m2, 32, format_info_ocp_e8m0
+    "mxfp6_e3m2", format_info_ocp_e3m2, 32, format_info_ocp_e8m0
 )
 
 format_info_mxfp6_e2m3 = BlockFormatInfo(
-    "format_info_mxfp6_e2m3", format_info_ocp_e2m3, 32, format_info_ocp_e8m0
+    "mxfp6_e2m3", format_info_ocp_e2m3, 32, format_info_ocp_e8m0
 )
 
 format_info_mxfp4_e2m1 = BlockFormatInfo(
-    "format_info_mxfp4_e2m1", format_info_ocp_e2m1, 32, format_info_ocp_e8m0
+    "mxfp4_e2m1", format_info_ocp_e2m1, 32, format_info_ocp_e8m0
 )
 
 format_info_mxfp4_e2m1 = BlockFormatInfo(
-    "format_info_mxfp4_e2m1", format_info_ocp_e2m1, 32, format_info_ocp_e8m0
+    "mxfp4_e2m1", format_info_ocp_e2m1, 32, format_info_ocp_e8m0
 )
 
 format_info_mxint8 = BlockFormatInfo(
-    "format_info_mxint8", format_info_ocp_int8, 32, format_info_ocp_e8m0
+    "mxint8", format_info_ocp_int8, 32, format_info_ocp_e8m0
 )
 
 all_block_formats = [