applied pr comments

Author: soheilshahrouz

README.developers.md

@@ -395,7 +395,7 @@ Implementation Quality Metrics:
 | crit_path_routed_wirelength     | The routed wirelength at the relaxed channel width                           | Medium      |
 | NoC_agg_bandwidth\**            | The total link bandwidth utilized by all traffic flows                       | Low         |
 | NoC_latency\**                  | The total time of traffic flow data transfer (summed over all traffic flows) | Low         |
-| NoC_latency_constraints_cost\** | The total number of traffic flow latency constraints                         | Low           |
+| NoC_latency_constraints_cost\** | Total number of traffic flows that meet their latency constraints            | Low         |
 
 \* By default, VPR attempts to find the minimum routable channel width; it then performs routing at a relaxed (e.g. 1.3x minimum) channel width. At minimum channel width routing congestion can distort the true timing/wirelength characteristics. Combined with the fact that most FPGA architectures are built with an abundance of routing, post-routing metrics are usually only evaluated at the relaxed channel width.
 

vtr_flow/benchmarks/noc/Large_Designs/MLP/Readme.txt

@@ -72,6 +72,7 @@ Running the benchmarks:
 	Running VTR tasks:
         - All synthetic benchmarks can be run as VTR tasks. Example tasks are provided in vtr_flow/tasks/noc_qor
         - Instructions on how to run VTR tasks to measure QoR for NoC benchmarks in available in VTR Developer Guide.
+        - Link to VTR Developer Guide: https://docs.verilogtorouting.org/en/latest/README.developers/#example-noc-benchmarks-qor-measurements
 
 	Expected run time:
 		- These benchmarks are quite large so the maximum expected run time for a single run is a few hours

vtr_flow/benchmarks/noc/Synthetic_Designs/Readme.txt

@@ -49,6 +49,7 @@ Running the benchmarks:
     Running VTR tasks:
         - All synthetic benchmarks can be run as VTR tasks. Example tasks are provided in vtr_flow/tasks/noc_qor
         - Instructions on how to run VTR tasks to measure QoR for NoC benchmarks in available in VTR Developer Guide.
+        - Link to VTR Developer Guide: https://docs.verilogtorouting.org/en/latest/README.developers/#example-noc-benchmarks-qor-measurements
 
 	Expected run time:
 		- These benchmarks are quite small so the maximum expected run time for a single run is ~30 minutes

vtr_flow/scripts/python_libs/vtr/task.py

@@ -476,6 +476,11 @@ def create_jobs(args, configs, after_run=False) -> List[Job]:
     """
     jobs = []
     for config in configs:
+        # A task usually runs the CAD flow for a cartesian product of circuits and architectures.
+        # NoC traffic flow files might need to be specified per circuit. If this is the case,
+        # circuits and traffic flow files are paired. Otherwise, a cartesian product is performed
+        # between circuits and traffic flow files. In both cases, the result is cartesian multiplied
+        # with given architectures.
         if config.noc_traffic_list_type == "outer_product":
             combinations = list(itertools.product(config.circuits, config.noc_traffics))
         elif config.noc_traffic_list_type == "per_circuit":

vtr_flow/tasks/noc_qor/MLP/config/config.txt

@@ -11,7 +11,10 @@ archs_dir=arch/noc/mesh_noc_topology
 # Path to directory of NoC Traffic Patterns to use
 noc_traffics_dir=benchmarks/noc/Large_Designs/MLP/traffic_flow_files/
 
-# Traffic flow files are added per circuit
+# Traffic flow files are added per circuit.
+# By default, the task performs a cartesian product between circuits and traffic flow files.
+# Since each circuit is compatible with specific traffic flow files, we need to specify
+# traffic flow files for each circuit separately.
 noc_traffic_list_type=per_circuit
 
 # Add circuits to list to sweep

vtr_flow/tasks/noc_qor/large_complex_synthetic/config/config.txt

@@ -11,7 +11,10 @@ archs_dir=arch/noc/mesh_noc_topology
 # Path to directory of NoC Traffic Patterns to use
 noc_traffics_dir=benchmarks/noc/Synthetic_Designs/traffic_flow_files/
 
-# Traffic flow files are added per circuit
+# Traffic flow files are added per circuit.
+# By default, the task performs a cartesian product between circuits and traffic flow files.
+# Since each circuit is compatible with specific traffic flow files, we need to specify
+# traffic flow files for each circuit separately.
 noc_traffic_list_type=per_circuit
 
 # Add circuits and traffic flows to list to sweep

vtr_flow/tasks/noc_qor/large_simple_synthetic/config/config.txt

@@ -11,7 +11,10 @@ archs_dir=arch/noc/mesh_noc_topology
 # Path to directory of NoC Traffic Patterns to use
 noc_traffics_dir=benchmarks/noc/Synthetic_Designs/traffic_flow_files/
 
-# Traffic flow files are added per circuit
+# Traffic flow files are added per circuit.
+# By default, the task performs a cartesian product between circuits and traffic flow files.
+# Since each circuit is compatible with specific traffic flow files, we need to specify
+# traffic flow files for each circuit separately.
 noc_traffic_list_type=per_circuit
 
 # Add circuits and traffic flows to list to sweep

vtr_flow/tasks/noc_qor/small_complex_synthetic/config/config.txt

@@ -11,7 +11,10 @@ archs_dir=arch/noc/mesh_noc_topology
 # Path to directory of NoC Traffic Patterns to use
 noc_traffics_dir=benchmarks/noc/Synthetic_Designs/traffic_flow_files/
 
-# Traffic flow files are added per circuit
+# Traffic flow files are added per circuit.
+# By default, the task performs a cartesian product between circuits and traffic flow files.
+# Since each circuit is compatible with specific traffic flow files, we need to specify
+# traffic flow files for each circuit separately.
 noc_traffic_list_type=per_circuit
 
 # Add circuits and traffic flows to list to sweep

vtr_flow/tasks/noc_qor/small_simple_synthetic/config/config.txt

@@ -11,7 +11,10 @@ archs_dir=arch/noc/mesh_noc_topology
 # Path to directory of NoC Traffic Patterns to use
 noc_traffics_dir=benchmarks/noc/Synthetic_Designs/traffic_flow_files/
 
-# Traffic flow files are added per circuit
+# Traffic flow files are added per circuit.
+# By default, the task performs a cartesian product between circuits and traffic flow files.
+# Since each circuit is compatible with specific traffic flow files, we need to specify
+# traffic flow files for each circuit separately.
 noc_traffic_list_type=per_circuit
 
 # Add circuits and traffic flows to list to sweep