make arg required and update docs

Signed-off-by: luarss <jluar@precisioninno.com>
The-OpenROAD-Project · Oct 10, 2024 · 3c61f40 · 3c61f40
1 parent b01453b
commit 3c61f40
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/docs/user/InstructionsForAutoTuner.md b/docs/user/InstructionsForAutoTuner.md
@@ -148,8 +148,9 @@ python3 distributed.py --design gcd --platform sky130hd \
 
 #### Plot images
 
-After running the autotuner experiments, you can visualize the results as follows.
-Currently, we support the following metrics:
+After running an AutoTuner experiment, you can generate a graph to understand the results better.
+The graph will show one of the metrics listed below progression over the execution of the experiment.
+
 - QoR
 - Runtime per trial
 - Clock Period

diff --git a/tools/AutoTuner/src/autotuner/utils/plot.py b/tools/AutoTuner/src/autotuner/utils/plot.py
@@ -93,10 +93,7 @@ def main(results_dir: str):
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Plot AutoTuner results.")
     parser.add_argument(
-        "results_dir",
-        type=str,
-        help="Directory containing the results.",
-        default="../../../../../flow/logs/asap7/gcd/test-tune-2024-09-17-12-00-44",
+        "results_dir", type=str, help="Directory containing the results.", required=True
     )
     args = parser.parse_args()
     main(args.results_dir)