Merge pull request #109 from Xilinx/feature/validation_steps_clean

Feature/validation steps (clean)

build/bnn-pynq/build.py

@@ -44,6 +44,8 @@
     "cnv-w2a2",
 ]
 
+verif_en = os.getenv("VERIFICATION_EN", "0")
+
 # which platforms to build the networks for
 zynq_platforms = ["Pynq-Z1", "Ultra96", "ZCU104"]
 alveo_platforms = ["U250"]
@@ -86,15 +88,33 @@ def platform_to_shell(platform):
             board=platform_name,
             shell_flow_type=shell_flow_type,
             vitis_platform=vitis_platform,
-            generate_outputs=[build_cfg.DataflowOutputType.BITFILE],
+            generate_outputs=[
+                build_cfg.DataflowOutputType.BITFILE,
+                build_cfg.DataflowOutputType.STITCHED_IP,
+            ],
             save_intermediate_models=True,
             default_swg_exception=True,
             specialize_layers_config_file="specialize_layers_config/%s_specialize_layers.json"
             % model_name,
         )
         model_file = "models/%s.onnx" % model_name
-        # launch FINN compiler to build
-        build.build_dataflow_cfg(model_file, cfg)
+
+        if verif_en == "1":
+            # Build the model with verification
+            import sys
+
+            sys.path.append(os.path.abspath(os.getenv("FINN_EXAMPLES_ROOT") + "/ci/"))
+            from verification_funcs import init_verif, verify_build_output
+
+            cfg.verify_steps, cfg.verify_input_npy, cfg.verify_expected_output_npy = init_verif(
+                model_name
+            )
+            build.build_dataflow_cfg(model_file, cfg)
+            verify_build_output(cfg, model_name)
+        else:
+            # Build the model without verification
+            build.build_dataflow_cfg(model_file, cfg)
+
         # copy bitfiles into release dir if found
         bitfile_gen_dir = cfg.output_dir + "/bitfile"
         files_to_check_and_copy = [

build/cybersecurity-mlp/build.py

@@ -32,6 +32,11 @@
 import os
 import shutil
 
+# Define model name
+model_name = "unsw_nb15-mlp-w2a2"
+
+verif_en = os.getenv("VERIFICATION_EN", "0")
+
 # Which platforms to build the networks for
 zynq_platforms = ["Pynq-Z1", "Ultra96", "ZCU104"]
 alveo_platforms = []
@@ -50,9 +55,6 @@ def platform_to_shell(platform):
         raise Exception("Unknown platform, can't determine ShellFlowType")
 
 
-# Define model name
-model_name = "unsw_nb15-mlp-w2a2"
-
 # Create a release dir, used for finn-examples release packaging
 os.makedirs("release", exist_ok=True)
 
@@ -85,13 +87,28 @@ def platform_to_shell(platform):
             build_cfg.DataflowOutputType.ESTIMATE_REPORTS,
             build_cfg.DataflowOutputType.BITFILE,
             build_cfg.DataflowOutputType.DEPLOYMENT_PACKAGE,
+            build_cfg.DataflowOutputType.STITCHED_IP,
         ],
-        save_intermediate_models=True,
     )
 
     model = "models/%s.onnx" % model_name
     # Launch FINN compiler to generate bitfile
-    build.build_dataflow_cfg(model, cfg)
+    if verif_en == "1":
+        # Build the model with verification
+        import sys
+
+        sys.path.append(os.path.abspath(os.getenv("FINN_EXAMPLES_ROOT") + "/ci/"))
+        from verification_funcs import init_verif, verify_build_output
+
+        cfg.verify_steps, cfg.verify_input_npy, cfg.verify_expected_output_npy = init_verif(
+            model_name
+        )
+        build.build_dataflow_cfg(model, cfg)
+        verify_build_output(cfg, model_name)
+    else:
+        # Build the model without verification
+        build.build_dataflow_cfg(model, cfg)
+
     # Copy bitfiles into release dir if found
     bitfile_gen_dir = cfg.output_dir + "/bitfile"
     filtes_to_check_and_copy = ["finn-accel.bit", "finn-accel.hwh", "finn-accel.xclbin"]

build/gtsrb/build.py

@@ -28,20 +28,25 @@
 
 import finn.builder.build_dataflow as build
 import finn.builder.build_dataflow_config as build_cfg
+from finn.util.basic import alveo_default_platform
 from finn.builder.build_dataflow_config import default_build_dataflow_steps
+from qonnx.transformation.insert_topk import InsertTopK
 from qonnx.core.datatype import DataType
 import os
 import shutil
 import numpy as np
 from onnx import helper as oh
 
-models = [
-    "cnv_1w1a_gtsrb",
-]
+
+model_name = "cnv_1w1a_gtsrb"
+model_file = "models/%s.onnx" % model_name
+
+verif_en = os.getenv("VERIFICATION_EN", "0")
 
 # which platforms to build the networks for
 zynq_platforms = ["Pynq-Z1"]
-platforms_to_build = zynq_platforms
+alveo_platforms = []
+platforms_to_build = zynq_platforms + alveo_platforms
 
 
 def custom_step_add_preproc(model, cfg):
@@ -63,16 +68,27 @@ def custom_step_add_preproc(model, cfg):
     model.graph.node[1].input[0] = new_in_name
     # set input dtype to uint8
     model.set_tensor_datatype(in_name, DataType["UINT8"])
+
     return model
 
 
-custom_build_steps = [custom_step_add_preproc] + default_build_dataflow_steps
+# Insert TopK node to get predicted Top-1 class
+def custom_step_add_postproc(model, cfg):
+    model = model.transform(InsertTopK(k=1))
+    return model
+
+
+custom_build_steps = (
+    [custom_step_add_preproc] + [custom_step_add_postproc] + default_build_dataflow_steps
+)
 
 
 # determine which shell flow to use for a given platform
 def platform_to_shell(platform):
     if platform in zynq_platforms:
         return build_cfg.ShellFlowType.VIVADO_ZYNQ
+    elif platform in alveo_platforms:
+        return build_cfg.ShellFlowType.VITIS_ALVEO
     else:
         raise Exception("Unknown platform, can't determine ShellFlowType")
 
@@ -82,45 +98,64 @@ def platform_to_shell(platform):
 
 for platform_name in platforms_to_build:
     shell_flow_type = platform_to_shell(platform_name)
-    vitis_platform = None
-    # for Zynq, use the board name as the release name
-    # e.g. ZCU104
-    release_platform_name = platform_name
+    if shell_flow_type == build_cfg.ShellFlowType.VITIS_ALVEO:
+        vitis_platform = alveo_default_platform[platform_name]
+        # for Alveo, use the Vitis platform name as the release name
+        # e.g. xilinx_u250_xdma_201830_2
+        release_platform_name = vitis_platform
+    else:
+        vitis_platform = None
+        # for Zynq, use the board name as the release name
+        # e.g. ZCU104
+        release_platform_name = platform_name
     platform_dir = "release/%s" % release_platform_name
     os.makedirs(platform_dir, exist_ok=True)
-    for model_name in models:
-        # set up the build configuration for this model
-        cfg = build_cfg.DataflowBuildConfig(
-            output_dir="output_%s_%s" % (model_name, release_platform_name),
-            target_fps=3000,
-            synth_clk_period_ns=10.0,
-            board=platform_name,
-            steps=custom_build_steps,
-            folding_config_file="folding_config/gtsrb_folding_config.json",
-            shell_flow_type=shell_flow_type,
-            vitis_platform=vitis_platform,
-            generate_outputs=[
-                build_cfg.DataflowOutputType.ESTIMATE_REPORTS,
-                build_cfg.DataflowOutputType.STITCHED_IP,
-                build_cfg.DataflowOutputType.RTLSIM_PERFORMANCE,
-                build_cfg.DataflowOutputType.BITFILE,
-                build_cfg.DataflowOutputType.DEPLOYMENT_PACKAGE,
-                build_cfg.DataflowOutputType.PYNQ_DRIVER,
-            ],
-            specialize_layers_config_file="specialize_layers_config/gtsrb_specialize_layers.json",
+    # set up the build configuration for this model
+    cfg = build_cfg.DataflowBuildConfig(
+        output_dir="output_%s_%s" % (model_name, release_platform_name),
+        target_fps=3000,
+        synth_clk_period_ns=10.0,
+        board=platform_name,
+        steps=custom_build_steps,
+        folding_config_file="folding_config/gtsrb_folding_config.json",
+        specialize_layers_config_file="specialize_layers_config/gtsrb_specialize_layers.json",
+        shell_flow_type=shell_flow_type,
+        vitis_platform=vitis_platform,
+        generate_outputs=[
+            build_cfg.DataflowOutputType.ESTIMATE_REPORTS,
+            build_cfg.DataflowOutputType.STITCHED_IP,
+            build_cfg.DataflowOutputType.RTLSIM_PERFORMANCE,
+            build_cfg.DataflowOutputType.BITFILE,
+            build_cfg.DataflowOutputType.DEPLOYMENT_PACKAGE,
+            build_cfg.DataflowOutputType.PYNQ_DRIVER,
+        ],
+    )
+    # launch FINN compiler to build
+    if verif_en == "1":
+        # Build the model with verification
+        import sys
+
+        sys.path.append(os.path.abspath(os.getenv("FINN_EXAMPLES_ROOT") + "/ci/"))
+        from verification_funcs import init_verif, verify_build_output
+
+        cfg.verify_steps, cfg.verify_input_npy, cfg.verify_expected_output_npy = init_verif(
+            model_name
         )
-        model_file = "models/%s.onnx" % model_name
-        # launch FINN compiler to build
         build.build_dataflow_cfg(model_file, cfg)
-        # copy bitfiles into release dir if found
-        bitfile_gen_dir = cfg.output_dir + "/bitfile"
-        files_to_check_and_copy = [
-            "finn-accel.bit",
-            "finn-accel.hwh",
-            "finn-accel.xclbin",
-        ]
-        for f in files_to_check_and_copy:
-            src_file = bitfile_gen_dir + "/" + f
-            dst_file = platform_dir + "/" + f.replace("finn-accel", model_name)
-            if os.path.isfile(src_file):
-                shutil.copy(src_file, dst_file)
+        verify_build_output(cfg, model_name)
+    else:
+        # Build the model without verification
+        build.build_dataflow_cfg(model_file, cfg)
+
+    # copy bitfiles into release dir if found
+    bitfile_gen_dir = cfg.output_dir + "/bitfile"
+    files_to_check_and_copy = [
+        "finn-accel.bit",
+        "finn-accel.hwh",
+        "finn-accel.xclbin",
+    ]
+    for f in files_to_check_and_copy:
+        src_file = bitfile_gen_dir + "/" + f
+        dst_file = platform_dir + "/" + f.replace("finn-accel", model_name)
+        if os.path.isfile(src_file):
+            shutil.copy(src_file, dst_file)

build/kws/build.py

@@ -41,6 +41,11 @@
 import os
 import shutil
 
+model_name = "MLP_W3A3_python_speech_features_pre-processing_QONNX_opset-11"
+model_file = "models/" + model_name + ".onnx"
+
+verif_en = os.getenv("VERIFICATION_EN", "0")
+
 
 # Inject the preprocessing step into FINN to enable json serialization later on
 def step_preprocess(model: ModelWrapper, cfg: DataflowBuildConfig):
@@ -60,21 +65,6 @@ def step_preprocess(model: ModelWrapper, cfg: DataflowBuildConfig):
     build_cfg.DataflowOutputType.BITFILE,
     build_cfg.DataflowOutputType.DEPLOYMENT_PACKAGE,
 ]
-verification_steps = [
-    build_cfg.VerificationStepType.QONNX_TO_FINN_PYTHON,
-    build_cfg.VerificationStepType.TIDY_UP_PYTHON,
-    build_cfg.VerificationStepType.STREAMLINED_PYTHON,
-    build_cfg.VerificationStepType.FOLDED_HLS_CPPSIM,
-]
-
-model_name = "MLP_W3A3_python_speech_features_pre-processing_QONNX_opset-11"
-model_file = "models/" + model_name + ".onnx"
-
-# Change the ONNX opset from version 9 to 11, which adds support for the TopK node
-model = ModelWrapper(model_file)
-model.model.opset_import[0].version = 11
-model_file = model_file.replace(".onnx", "_opset-11.onnx")
-model.save(model_file)
 
 
 # create a release dir, used for finn-examples release packaging
@@ -88,8 +78,6 @@ def step_preprocess(model: ModelWrapper, cfg: DataflowBuildConfig):
     last_output_dir = "output_%s_%s" % (model_name, release_platform_name)
     # Configure build
     cfg = build_cfg.DataflowBuildConfig(
-        # steps=estimate_steps, generate_outputs=estimate_outputs,
-        verify_steps=verification_steps,
         steps=build_steps,
         generate_outputs=build_outputs,
         output_dir=last_output_dir,
@@ -98,11 +86,24 @@ def step_preprocess(model: ModelWrapper, cfg: DataflowBuildConfig):
         board=platform_name,
         shell_flow_type=build_cfg.ShellFlowType.VIVADO_ZYNQ,
         stitched_ip_gen_dcp=True,
-        verify_save_full_context=True,
         specialize_layers_config_file="specialize_layers_config/kws_specialize_layers.json",
     )
-    # Build the model
-    build.build_dataflow_cfg(model_file, cfg)
+
+    if verif_en == "1":
+        # Build the model with verification
+        import sys
+
+        sys.path.append(os.path.abspath(os.getenv("FINN_EXAMPLES_ROOT") + "/ci/"))
+        from verification_funcs import init_verif, verify_build_output
+
+        cfg.verify_steps, cfg.verify_input_npy, cfg.verify_expected_output_npy = init_verif(
+            model_name
+        )
+        build.build_dataflow_cfg(model_file, cfg)
+        verify_build_output(cfg, model_name)
+    else:
+        # Build the model without verification
+        build.build_dataflow_cfg(model_file, cfg)
 
     # copy bitfiles and runtime weights into release dir if found
     bitfile_gen_dir = cfg.output_dir + "/bitfile"
@@ -117,7 +118,6 @@ def step_preprocess(model: ModelWrapper, cfg: DataflowBuildConfig):
         if os.path.isfile(src_file):
             shutil.copy(src_file, dst_file)
 
-
 # Export quantized inputs
 print("Quantizing validation dataset.")
 parent_model = ModelWrapper(last_output_dir + "/intermediate_models/dataflow_parent.onnx")

build/mobilenet-v1/build.py

@@ -43,6 +43,10 @@
 )
 
 model_name = "mobilenetv1-w4a4"
+model_file = "models/%s_pre_post_tidy_opset-11.onnx" % model_name
+
+verif_en = os.getenv("VERIFICATION_EN", "0")
+
 
 # which platforms to build the networks for
 zynq_platforms = ["ZCU104", "ZCU102"]
@@ -101,6 +105,7 @@ def select_build_steps(platform):
             "step_hw_codegen",
             "step_hw_ipgen",
             "step_set_fifo_depths",
+            "step_create_stitched_ip",
             step_mobilenet_slr_floorplan,
             "step_synthesize_bitfile",
             "step_make_pynq_driver",
@@ -111,7 +116,6 @@ def select_build_steps(platform):
 # create a release dir, used for finn-examples release packaging
 os.makedirs("release", exist_ok=True)
 
-
 for platform_name in platforms_to_build:
     shell_flow_type = platform_to_shell(platform_name)
     if shell_flow_type == build_cfg.ShellFlowType.VITIS_ALVEO:
@@ -144,12 +148,28 @@ def select_build_steps(platform):
             build_cfg.DataflowOutputType.ESTIMATE_REPORTS,
             build_cfg.DataflowOutputType.BITFILE,
             build_cfg.DataflowOutputType.DEPLOYMENT_PACKAGE,
+            build_cfg.DataflowOutputType.STITCHED_IP,
         ],
         specialize_layers_config_file="specialize_layers_config/%s_specialize_layers.json"
         % platform_name,
     )
-    model_file = "models/%s_pre_post_tidy_opset-11.onnx" % model_name
-    build.build_dataflow_cfg(model_file, cfg)
+    if verif_en == "1":
+        # Build the model with verification
+        import sys
+
+        sys.path.append(os.path.abspath(os.getenv("FINN_EXAMPLES_ROOT") + "/ci/"))
+        from verification_funcs import init_verif, verify_build_output
+
+        cfg.verify_steps, cfg.verify_input_npy, cfg.verify_expected_output_npy = init_verif(
+            model_name
+        )
+        if "stitched_ip_rtlsim" in cfg.verify_steps:
+            cfg.verify_steps.remove("stitched_ip_rtlsim")
+        build.build_dataflow_cfg(model_file, cfg)
+        verify_build_output(cfg, model_name)
+    else:
+        # Build the model without verification
+        build.build_dataflow_cfg(model_file, cfg)
 
     # copy bitfiles and runtime weights into release dir if found
     bitfile_gen_dir = cfg.output_dir + "/bitfile"