initial scaffold - add jsonargparse

Signed-off-by: Jack Luar <[email protected]>

Author: luarss

docs/user/CLIGuideAutotuner.md

@@ -0,0 +1,69 @@
+# Autotuner CLI Guide
+
+AutoTuner may be triggered by specifying a configuration path instead of
+typing every single argument one-by-one.
+
+## Motivation of Configuration files
+
+Why configuration files?
+- Improve CLI user experience - less typing, less mistakes.
+- Greatly simplify the reproducibility of experiments - share your configuration
+file for easier experiment tracking!
+
+Previously for a command like tune, you might have had to do:
+
+```shell
+openroad_autotuner --design gcd --platform sky130hd --experiment abcdef \
+                   --verbose \
+                   --jobs 4 --openroad_threads 16 \
+                   tune \
+                   --config ../../flow/designs/sky130hd/gcd/autotuner.json \
+                   --samples 5 --iterations 1 --algorithm hyperopt \
+                   --resources_per_trial 1.0 --seed 42
+```
+
+With our new approach all you have to do is specify a YAML document `test.yaml`
+
+```yaml
+---
+# Common
+design: gcd
+platform: sky130hd
+experiment: test
+verbose: 0
+config: ../../flow/designs/sky130hd/gcd/autotuner.json
+
+# Workload
+jobs: 4 
+openroad_threads: 16
+
+# Tune-specific (set these if mode is tune)
+tune:
+  algorithm: hyperopt
+  eval: default
+  samples: 10
+  iterations: 1
+  resources_per_trial: 1.0
+  reference: null
+  perturbation: 25
+  seed: 42
+```
+
+and run:
+
+```bash
+openroad_autotuner --yaml test.yaml
+```
+
+## How to generate new config files
+
+```bash
+openroad_autotuner --design gcd --platform sky130hd --experiment abcdef \
+                   --verbose \
+                   --jobs 4 --openroad_threads 16 \
+                   --print_config \
+                   tune \
+                   --config ../../flow/designs/sky130hd/gcd/autotuner.json \
+                   --samples 5 --iterations 1 --algorithm hyperopt \
+                   --resources_per_trial 1.0 --seed 42 > new_test.yaml
+```

docs/user/InstructionsForAutoTuner.md

@@ -104,6 +104,9 @@ The `autotuner.distributed` module uses [Ray's](https://docs.ray.io/en/latest/in
 fully utilize available hardware resources from a single server 
 configuration, on-premise or over the cloud with multiple CPUs.
 
+For advanced users, we have provided a configuration file, please
+refer to [this guide](./CLIGuideAutotuner.md).
+
 The two modes of operation:
 - `sweep`, where every possible parameter combination in the search space is tested
 - `tune`, where we use Ray's Tune feature to intelligently search the space and optimize hyperparameters using one of the algorithms listed above.

tools/AutoTuner/cli.yaml

@@ -0,0 +1,29 @@
+---
+# Common
+design: gcd
+platform: sky130hd
+experiment: test
+timeout: null
+verbose: 0
+
+# Workload
+jobs: 4 
+openroad_threads: 16
+server: null
+port: 10001
+
+# Tune-specific
+tune:
+  config: ../../flow/designs/sky130hd/gcd/autotuner.json
+  algorithm: hyperopt
+  eval: default
+  samples: 10
+  iterations: 1
+  resources_per_trial: 1.0
+  reference: null
+  perturbation: 25
+  seed: 42
+
+# Sweep-specific
+sweep:
+  config: ./src/autotuner/distributed-sweep-example.json

tools/AutoTuner/requirements.txt

@@ -11,3 +11,4 @@ SQLAlchemy==1.4.17
 urllib3>=1.26.17
 matplotlib==3.10.0
 pyyaml==6.0.1
+jsonargparse==4.3.8

tools/AutoTuner/src/autotuner/distributed.py

@@ -106,6 +106,9 @@
 )
 # Global variable for args
 args = None
+design = None
+platform = None
+config = None
 
 
 class AutoTunerBase(tune.Trainable):
@@ -124,7 +127,7 @@ def setup(self, config):
         self.parameters = parse_config(
             config=config,
             base_dir=self.repo_dir,
-            platform=args.platform,
+            platform=platform,
             sdc_original=SDC_ORIGINAL,
             constraints_sdc=CONSTRAINTS_SDC,
             fr_original=FR_ORIGINAL,
@@ -579,13 +582,13 @@ def main():
     # Read config and original files before handling where to run in case we
     # need to upload the files.
     config_dict, SDC_ORIGINAL, FR_ORIGINAL = read_config(
-        os.path.abspath(args.config), args.mode, getattr(args, "algorithm", None)
+        os.path.abspath(config), args.mode, getattr(args, "algorithm", None)
     )
 
     LOCAL_DIR, ORFS_FLOW_DIR, INSTALL_PATH = prepare_ray_server(args)
 
     if args.mode == "tune":
-        best_params = set_best_params(args.platform, args.design)
+        best_params = set_best_params(platform, design)
         search_algo = set_algorithm(
             args.algorithm,
             args.experiment,