Refactor directory structure

README.md

@@ -4,7 +4,7 @@
 
 Completed for [CS252R: Program Synthesis](https://synthesis.metareflection.club/) at the Harvard John A. Paulson School of Engineering and Applied Sciences, taught Fall 2023 by Prof. Nada Amin.
 
-## 🛠️ Inductive Synthesis
+## 🛠️ Background
 
 The following notes are adapted from [*Introduction to Program Synthesis*](http://people.csail.mit.edu/asolar/SynthesisCourse/TOC.htm) by Armando Solar-Lezama.
 
@@ -25,6 +25,30 @@ Synthesize(inputs, outputs):
 
 Here, we implement the non-ML subset of BUSTLE, the algorithm proposed by Odena *et al.* (2021). That is, we implement bottom-up enumerative search for simple compound expressions, excluding conditionals, recursion and loops.
 
+To run the program, run `synthesizer.py` with the following arguments:
+```
+usage: synthesizer.py [-h] --domain {arithmetic,string} --examples {addition,subtraction,multiplication,division}
+                      [--max_weight MAX_WEIGHT]
+
+Bottom-up enumerative synthesis in Python.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --domain {arithmetic,string}
+                        Domain of synthesis (either "arithmetic" or "string").
+  --examples {addition,subtraction,multiplication,division}
+                        Examples to synthesize program from. Must be a valid key in the "examples" dictionary.
+  --max_weight MAX_WEIGHT
+                        Maximum weight of programs to consider before terminating search.
+```
+
+For example, to synthesize programs in the arithmetic domain from the addition examples, run:
+```
+python3 synthesizer.py --domain arithmetic --examples addition
+```
+
+To add additional input-output examples, modify `examples.py`. Add a new key to the dictionary `examples`` and set the value to be a list of tuples.
+
 ## 🙏🏽 Acknowledgements
 
 I thank [Tyler Holloway](mailto:tylerholloway@g.harvard.edu), teaching fellow in CS252R, for her guidance in completing this implementation of bottom-up enumerative program synthesis.

project_config.py → config.py

@@ -20,6 +20,6 @@ else:
     PROJECT_DIR = Path('/Users/an583/Library/CloudStorage/OneDrive-Personal/Academic/College/Junior Year/Fall Term/COMPSCI 252R/cs252r')
 
 # define project configuration variables
-DATA_DIR = PROJECT_DIR / 'Data'
-RESULTS_DIR = PROJECT_DIR / 'Results'
+# DATA_DIR = PROJECT_DIR / 'Data'
+# RESULTS_DIR = PROJECT_DIR / 'Results'
 SEED = 42

Code/demonstration.ipynb → demonstration.ipynb

@@ -28,11 +28,7 @@
     "# import arithmetic module\n",
     "# from arithmetic import *\n",
     "from examples import examples\n",
-    "\n",
-    "# import project config file\n",
-    "import sys\n",
-    "sys.path.append('..')\n",
-    "import project_config"
+    "import config"
    ]
   },
   {
@@ -51,7 +47,7 @@
     "domain = \"arithmetic\"\n",
     "examples_key = \"addition\"\n",
     "examples = examples[examples_key]\n",
-    "max_level = 3"
+    "max_weight = 3"
    ]
   },
   {

Code/synthesizer.py → synthesizer.py

@@ -13,11 +13,7 @@ import argparse
 
 # import examples
 from examples import examples
-
-# import project config file
-import sys
-sys.path.append('..')
-import project_config
+import config
 
 
 def parse_args(examples):
@@ -39,7 +35,8 @@ def parse_args(examples):
                         choices=examples.keys(),
                         help='Examples to synthesize program from. Must be a valid key in the "examples" dictionary.')
     
-    parser.add_argument('--max_levels', type=int, required=False, default=3)
+    parser.add_argument('--max_weight', type=int, required=False, default=3,
+                        help='Maximum weight of programs to consider before terminating search.')
 
     args = parser.parse_args()
     return args
@@ -51,7 +48,7 @@ if __name__ == '__main__':
     args = parse_args(examples)
     print(args.domain)
     print(args.examples_key)
-    print(args.max_levels)
+    print(args.max_weight)
 
     # run bottom-up enumerative synthesis
     # run_synthesizer(args)