Better Documentaiton, Tutorials and Tests

[Aaron-Zhao123]

The current documetnation of MASE is somehow a bit dated, so I am thinking of having a collective effort to bring it to a more usable state, this is related to the fix/tests branch.

What we need to do for passes.rst

On a high-level, we want to achieve:

• Each pass has its associated test, this is for both testing and also for users to have an example to play around. This is reflected in passes.rst as a table. In the usage example column, we put in the test code that has exercised this implemented pass.

• Each pass should have its documentation on how to set up the pass_args, an example is prune, we should include a python code block to clarify things like

  .. code-block:: python
  
      pass_config = {
          "weight" : {
              "scope": "local", # ["local, "global"] are available
              "granularity": "element", # ["element"] are available
              "method": "l1", # ["l1", "random"] are available
              "sparsity": 0.5, # a float between 0.0 and 1.0
          }
          "activation" : {
              "scope": "local", # ["local, "global"] are available
              "granularity": "element", # ["element"] are available
              "method": "l1", # ["l1", "random"] are available
              "sparsity": 0.5, # a float between 0.0 and 1.0
      }
  

Module analysis passes

• [x] calculate_avg_bitwidth @Aaron-Zhao123

Module transform passes

• [x] quantize @Aaron-Zhao123

Graph analysis passes

• [x] init_metadata_analysis @Aaron-Zhao123
• [x] add_common_metadata @Aaron-Zhao123
• [x] add_software_metadata @Aaron-Zhao123
• [ ] add_hardware_metadata @jianyicheng @pgimenes
• [x] report_graph_analysis_pass @Aaron-Zhao123
• [x] report_node_hardware_type_analysis_pass @Aaron-Zhao123
• [x] report_node_meta_param_analysis_pass @Aaron-Zhao123
• [x] report_node_shape_analysis_pass @Aaron-Zhao123
• [x] report_node_type_analysis_pass @Aaron-Zhao123
• [ ] profile_statistics_analysis_pass @ChengZhang-98
• [ ] calculate_avg_bits_mg_analysis_pass @ChengZhang-98
• [x] add_natural_sparsity_metadata_analysis_pass @Aaron-Zhao123
• [x] add_pruning_metadata_analysis_pass @Aaron-Zhao123
• [x] hook_inspection_analysis_pass @Aaron-Zhao123
• [ ] runtime_analysis_pass @firemountain154B
• [ ] verify_metadata @jianyicheng
• [ ] verify_common_metadata @jianyicheng
• [ ] verify_software_metadata @jianyicheng
• [ ] verify_hardware_metadata @jianyicheng

Graph transform passes

• [x] prune_transform_pass @Aaron-Zhao123
• [x] prune_detach_hook_transform_pass @Aaron-Zhao123
• [x] quantize_transform_pass @Aaron-Zhao123
• [x] summarize_quantization_analysis_pass @Aaron-Zhao123
• [x] conv_bn_fusion_transform_pass @Aaron-Zhao123
• [x] logicnets_fusion_transform_pass @Aaron-Zhao123
• [x] onnx_annotate_transform_pass @Aaron-Zhao123
• [ ] emit_verilog_top_transform_pass @jianyicheng @pgimenes
• [ ] emit_verilog_tb_transform_pass @jianyicheng @pgimenes
• [ ] emit_bram_transform_pass @jianyicheng
• [ ] emit_mlir_hls_transform_pass @jianyicheng
• [ ] emit_internal_rtl_transform_pass @jianyicheng
• [ ] tensorrt_fake_quantize_transform_pass @firemountain154B
• [ ] tensorrt_calibrate_transform_pass @firemountain154B
• [ ] tensorrt_fine_tune_transform_pass @firemountain154B Maybe consider drop this pass

Graph interface passes

• [ ] load_mase_graph_interface_pass @ChengZhang-98
• [ ] save_mase_graph_interface_pass @ChengZhang-98
• [ ] save_node_meta_param_interface_pass @Aaron-Zhao123 @ChengZhang-98
• [ ] load_node_meta_param_interface_pass @Aaron-Zhao123 @ChengZhang-98
• [ ] tensorrt_engine_interface_pass @firemountain154B
• [ ] onnx_runtime_interface_pass @firemountain154B

What we need to do for tutorials.rst

• [ ] BERT tutorial @pgimenes
• [x] Pass system tutorial @Aaron-Zhao123