Move numeric_types.py from fud/verilator to calyx-py (another a…

…ttempt at #1715 ) (#1719) * refactor numeric types * moved test * changed error location * fix test location --------- Co-authored-by: Rachit Nigam <[email protected]>
calyxir · Feb 16, 2024 · 9973656 · 9973656
1 parent 6fab070
commit 9973656
Show file tree

Hide file tree

Showing 15 changed files with 54 additions and 80 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -185,7 +185,7 @@ jobs:
 
     - name: Run Python Tests
       working-directory: /home/calyx
-      run: pytest fud/fud/stages/verilator/tests/numeric_types.py
+      run: pytest calyx-py/test/numeric_types.py
 
   evaluation:
     name: Polybench Integration

diff --git a/calyx-py/calyx/gen_exp.py b/calyx-py/calyx/gen_exp.py
@@ -8,9 +8,8 @@
 )
 from calyx.utils import float_to_fixed_point
 from math import factorial, log2
-from fud.stages.verilator import numeric_types
+from calyx.numeric_types import FixedPoint
 from calyx.gen_ln import generate_ln
-
 from calyx.builder import (
     Builder,
     ComponentBuilder,
@@ -19,7 +18,6 @@
     if_with,
     invoke,
     CellBuilder,
-    ExprBuilder,
     const,
     HI,
     par,
@@ -52,7 +50,7 @@ def generate_fp_pow_component(
 
     # groups
     with comp.group("init") as init:
-        pow.in_ = numeric_types.FixedPoint(
+        pow.in_ = FixedPoint(
             "1.0", width, int_width, is_signed=is_signed
         ).unsigned_integer()
         pow.write_en = 1
@@ -105,14 +103,12 @@ def generate_cells(
     comp.const(
         "one",
         width,
-        numeric_types.FixedPoint(
-            "1.0", width, int_width, is_signed=is_signed
-        ).unsigned_integer(),
+        FixedPoint("1.0", width, int_width, is_signed=is_signed).unsigned_integer(),
     )
     comp.const(
         "e",
         width,
-        numeric_types.FixedPoint(
+        FixedPoint(
             str(float_to_fixed_point(2.7182818284, frac_width)),
             width,
             int_width,
@@ -124,7 +120,7 @@ def generate_cells(
         comp.const(
             "negative_one",
             width,
-            numeric_types.FixedPoint(
+            FixedPoint(
                 "-1.0", width, int_width, is_signed=is_signed
             ).unsigned_integer(),
         )
@@ -168,7 +164,7 @@ def generate_cells(
     # reciprocal factorials
     for i in range(2, degree + 1):
         fixed_point_value = float_to_fixed_point(1.0 / factorial(i), frac_width)
-        value = numeric_types.FixedPoint(
+        value = FixedPoint(
             str(fixed_point_value), width, int_width, is_signed=is_signed
         ).unsigned_integer()
         comp.const(f"reciprocal_factorial{i}", width, value)
@@ -540,9 +536,7 @@ def gen_constant_cell(
     return comp.const(
         name,
         width,
-        numeric_types.FixedPoint(
-            value, width, int_width, is_signed=is_signed
-        ).unsigned_integer(),
+        FixedPoint(value, width, int_width, is_signed=is_signed).unsigned_integer(),
     )
 
 
@@ -571,16 +565,12 @@ def generate_fp_pow_full(
     const_one = comp.const(
         "one",
         width,
-        numeric_types.FixedPoint(
-            "1.0", width, int_width, is_signed=is_signed
-        ).unsigned_integer(),
+        FixedPoint("1.0", width, int_width, is_signed=is_signed).unsigned_integer(),
     )
     const_zero = comp.const(
         "zero",
         width,
-        numeric_types.FixedPoint(
-            "0.0", width, int_width, is_signed=is_signed
-        ).unsigned_integer(),
+        FixedPoint("0.0", width, int_width, is_signed=is_signed).unsigned_integer(),
     )
     mult = comp.cell(
         "mult",
@@ -597,7 +587,7 @@ def generate_fp_pow_full(
         const_neg_one = comp.const(
             "neg_one",
             width,
-            numeric_types.FixedPoint(
+            FixedPoint(
                 "-1.0", width, int_width, is_signed=is_signed
             ).unsigned_integer(),
         )

diff --git a/calyx-py/calyx/gen_ln.py b/calyx-py/calyx/gen_ln.py
@@ -6,7 +6,7 @@
     Import,
 )
 from calyx.utils import float_to_fixed_point
-from fud.stages.verilator import numeric_types
+from calyx import numeric_types
 from calyx.gen_msb import gen_msb_calc
 
 from calyx.builder import Builder, ComponentBuilder, CellBuilder, HI, par, invoke

diff --git a/calyx-py/calyx/gen_msb.py b/calyx-py/calyx/gen_msb.py
@@ -1,26 +1,11 @@
 from typing import List
 from calyx.py_ast import (
-    Connect,
-    CompVar,
-    Cell,
-    Group,
-    ConstantPort,
-    CompPort,
     Stdlib,
     Component,
-    ThisPort,
-    HolePort,
-    PortDef,
-    SeqComp,
-    Enable,
-    While,
-    Control,
-    CombGroup,
 )
 from calyx.builder import (
     Builder,
     CellAndGroup,
-    ComponentBuilder,
     const,
     HI,
     while_with,

diff --git a/fud/fud/stages/verilator/numeric_types.py → calyx-py/calyx/numeric_types.py b/fud/fud/stages/verilator/numeric_types.py → calyx-py/calyx/numeric_types.py
@@ -5,11 +5,20 @@
 from fractions import Fraction
 from dataclasses import dataclass
 from decimal import Decimal, getcontext
-from fud.errors import InvalidNumericType
 import math
 import logging as log
 
 
+class InvalidNumericType(Exception):
+    """
+    An error raised when an invalid numeric type is provided.
+    """
+
+    def __init__(self, msg):
+        msg = f"""Invalid Numeric Type: {msg}"""
+        super().__init__(msg)
+
+
 @dataclass
 class NumericType:
     """Interface for a numeric type.

diff --git a/...d/stages/verilator/tests/numeric_types.py → calyx-py/test/numeric_types.py b/...d/stages/verilator/tests/numeric_types.py → calyx-py/test/numeric_types.py
@@ -1,6 +1,5 @@
 from random import randint
-from fud.stages.verilator.numeric_types import FixedPoint, Bitnum
-from fud.errors import InvalidNumericType
+from calyx.numeric_types import FixedPoint, Bitnum, InvalidNumericType
 from hypothesis import given, strategies as st  # type: ignore
 import numpy as np
 import pytest  # type: ignore

diff --git a/frontends/relay/relay_visitor.py b/frontends/relay/relay_visitor.py
@@ -24,7 +24,7 @@
     Component,
 )
 from calyx.utils import float_to_fixed_point
-from fud.stages.verilator import numeric_types
+from calyx import numeric_types
 from dahlia_impl import emit_components
 
 calyx_keywords_list = ["input"]

diff --git a/frontends/systolic-lang/convert-mems.py b/frontends/systolic-lang/convert-mems.py
@@ -1,6 +1,6 @@
 import argparse
 import json
-from fud.stages.verilator import numeric_types
+from calyx import numeric_types
 
 
 if __name__ == "__main__":

diff --git a/frontends/systolic-lang/gen_array_component.py b/frontends/systolic-lang/gen_array_component.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 from gen_pe import pe, PE_NAME, BITWIDTH
-import calyx.builder as cb
+from calyx import builder as cb
 from calyx import py_ast
 from calyx.utils import bits_needed
 from systolic_arg_parser import SystolicConfiguration

diff --git a/frontends/systolic-lang/gen_post_op.py b/frontends/systolic-lang/gen_post_op.py
@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 
-import calyx.builder as cb
+from calyx import builder as cb
 from calyx import py_ast
 from gen_array_component import NAME_SCHEME
 from gen_pe import BITWIDTH, INTWIDTH, FRACWIDTH
-from fud.stages.verilator import numeric_types
+from calyx import numeric_types
 from calyx.utils import float_to_fixed_point
 from systolic_arg_parser import SystolicConfiguration
 from calyx.utils import bits_needed

diff --git a/fud/fud/errors.py b/fud/fud/errors.py
@@ -255,16 +255,6 @@ def __init__(self, path):
         super().__init__(msg)
 
 
-class InvalidNumericType(FudError):
-    """
-    An error raised when an invalid numeric type is provided.
-    """
-
-    def __init__(self, msg):
-        msg = f"""Invalid Numeric Type: {msg}"""
-        super().__init__(msg)
-
-
 class Malformed(FudError):
     """
     An error raised when the input to a stage is malformed in some manner.

diff --git a/fud/fud/stages/interpreter.py b/fud/fud/stages/interpreter.py
@@ -3,8 +3,7 @@
 from pathlib import Path
 import simplejson as sjson
 import numpy as np
-from fud.stages.verilator.numeric_types import FixedPoint, Bitnum
-from fud.errors import InvalidNumericType
+from calyx.numeric_types import FixedPoint, Bitnum, InvalidNumericType
 from fud.stages.verilator.json_to_dat import parse_fp_widths, float_to_fixed
 from fud.utils import shell, TmpDir, unwrap_or, transparent_shell
 from fud import config as cfg
@@ -88,8 +87,9 @@ def _is_data_converter(self):
 
     def _define_steps(self, input_data, builder, config):
         script = config["stages", self.name, "exec"]
-        data_path_exists: bool = (config["stages", "verilog", "data"] or
-                                  config.get(["stages", "mrxl", "data"]))
+        data_path_exists: bool = config["stages", "verilog", "data"] or config.get(
+            ["stages", "mrxl", "data"]
+        )
 
         cmd = [
             script,
@@ -118,7 +118,9 @@ def mktmp() -> SourceType.Directory:
             """
             return TmpDir()
 
-        @builder.step(description="Dynamically retrieve the value of stages.verilog.data")
+        @builder.step(
+            description="Dynamically retrieve the value of stages.verilog.data"
+        )
         def get_verilog_data() -> SourceType.Path:
             data_path = config.get(["stages", "verilog", "data"])
             path = Path(data_path) if data_path else None
@@ -197,9 +199,7 @@ def parse_output(
         data_path = get_verilog_data()
 
         if data_path_exists:
-            convert_json_to_interp_json(
-                tmpdir, data_path
-            )
+            convert_json_to_interp_json(tmpdir, data_path)
 
         if self._is_data_converter():
             if data_path_exists:
@@ -213,9 +213,7 @@ def parse_output(
             result = interpret(input_data, tmpdir)
 
             if "--raw" in cmd:
-                return parse_output(
-                    result, data_path, tmpdir
-                )
+                return parse_output(result, data_path, tmpdir)
             else:
                 return result
 

diff --git a/fud/fud/stages/verilator/json_to_dat.py b/fud/fud/stages/verilator/json_to_dat.py
@@ -1,8 +1,8 @@
 import simplejson as sjson
 import numpy as np
-from .numeric_types import FixedPoint, Bitnum
+from calyx.numeric_types import FixedPoint, Bitnum, InvalidNumericType
 from pathlib import Path
-from fud.errors import InvalidNumericType, Malformed
+from fud.errors import Malformed
 import logging as log
 
 

diff --git a/fud/fud/stages/verilator/tables.py b/fud/fud/stages/verilator/tables.py
@@ -1,6 +1,6 @@
 from itertools import product
 from decimal import Decimal
-from fud.stages.verilator.numeric_types import FixedPoint
+from calyx.numeric_types import FixedPoint
 
 
 def compute_exp_frac_table(frac_width: int):

diff --git a/fud/fud/xclrun.py b/fud/fud/xclrun.py
@@ -36,7 +36,7 @@
 from typing import Mapping, Any, Dict
 from pathlib import Path
 from fud.stages.verilator.json_to_dat import parse_fp_widths, float_to_fixed
-from fud.errors import InvalidNumericType
+from calyx.numeric_types import InvalidNumericType
 
 
 def mem_to_buf(mem):
@@ -96,8 +96,9 @@ def run(xclbin: Path, data: Mapping[str, Any]) -> Dict[str, Any]:
     # Collect the output data.
     for buf in buffers:
         buf.sync_from_device()
-    mems = {name: buf_to_mem(data[name]["format"], buf)
-            for name, buf in zip(data, buffers)}
+    mems = {
+        name: buf_to_mem(data[name]["format"], buf) for name, buf in zip(data, buffers)
+    }
 
     # PYNQ recommends explicitly freeing its resources.
     del buffers
@@ -118,14 +119,16 @@ def _dtype(fmt) -> np.dtype:
 def xclrun():
     # Parse command-line arguments.
     parser = argparse.ArgumentParser(
-        description='run a compiled XRT program',
+        description="run a compiled XRT program",
+    )
+    parser.add_argument("bin", metavar="XCLBIN", help="the .xclbin binary file to run")
+    parser.add_argument("data", metavar="DATA", help="the JSON input data file")
+    parser.add_argument(
+        "--out",
+        "-o",
+        metavar="FILE",
+        help="write JSON results to a file instead of stdout",
     )
-    parser.add_argument('bin', metavar='XCLBIN',
-                        help='the .xclbin binary file to run')
-    parser.add_argument('data', metavar='DATA',
-                        help='the JSON input data file')
-    parser.add_argument('--out', '-o', metavar='FILE',
-                        help='write JSON results to a file instead of stdout')
     args = parser.parse_args()
 
     # Load the input JSON data file.
@@ -136,7 +139,7 @@ def xclrun():
     out_data = run(Path(args.bin), in_data)
 
     # Dump the output JSON data.
-    outfile = open(args.out, 'w') if args.out else sys.stdout
+    outfile = open(args.out, "w") if args.out else sys.stdout
     sjson.dump(out_data, outfile, indent=2, use_decimal=True)