Add comments

Author: RattataKing

sharktuner/dispatch_tuner/dispatch_tuner.py

@@ -160,9 +160,7 @@ def main() -> None:
         print("Check the summary in:")
         print(summary_log_file.resolve())
 
-        output_csv_name = (
-            f"tuning_{args.dispatch_file.stem}.csv"
-        )
+        output_csv_name = f"tuning_{args.dispatch_file.stem}.csv"
         csv_path = libtuner.candidate_ordering.export_record_to_csv(
             dispatch_tuner.tuning_records, path_config.base_dir, output_csv_name
         )

sharktuner/sharktuner/candidate_ordering.py

@@ -113,8 +113,8 @@ def reorder_assignments(
 
 @dataclass
 class TuningRecord:
-    gen_id: int
-    candidate_id: int
+    gen_id: int  # Original index from candidate generation.
+    candidate_id: int  # Index in candidate_trackers after sorting.
     knob: Optional[common.KnobAssignment] = None
     to_compile: bool = False
     compile_status: bool = False