Skip to content

Commit d0e0c50

Browse files
updated readme
1 parent 1f60a4c commit d0e0c50

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This artifact contains:
1010
- Benchmark test cases reproducing the results from the paper (Tables I-IV)
1111
- Interactive examples for exploring and extending the pipeline
1212

13+
Please start at the [Setup: Using Docker (Recommended)](#setup-using-docker-recommended) section.
14+
1315
## Artifact Overview
1416

1517
### Structure and Content
@@ -22,14 +24,18 @@ HOL4P4/
2224
├── COPYRIGHT # Copyright notice
2325
├── Makefile # Top-level build file (make hol/polygram/cake/test)
2426
├── cakeml/ # CakeML installation (vHOL-Trindemossen-2)
27+
├── HOL/ # HOL-Theorem-Prover (Trindemossen-2)
28+
29+
2530
├── hol/
31+
│ │
2632
│ ├── Holmakefile # HOL4 build file for HOL4P4 excerpt
2733
│ ├── p4Script.sml # HOL4P4 dependency
2834
│ ├── p4_auxScript.sml # HOL4P4 dependency
2935
│ └── polygram/
3036
│ ├── Holmakefile # HOL4 build file for PolyGram
3137
│ ├── bdd_genScript.sml # Generalized BDD framework
32-
│ ├── ... # Other files
38+
│ ├── ... # Other Theorems Files
3339
│ ├── bdd_gen_eliminateScript.sml # Elimination operation proofs
3440
│ ├── fwd_proofLib.sml # HOL4 EVAL pipeline
3541
│ ├── fwd_proof_cakeLib.sml # CakeML pipeline
@@ -219,6 +225,11 @@ Then run the steps in order:
219225
- `make cake` compiles the CakeML translation in `hol/polygram/bdd_cake_trans/`, after this command, there should be 2 sexp files in the repository `bdd_cake_test`, that we compile when testing next step, expected time: ~800s.
220226
- `make test` runs all benchmark test cases in `hol/polygram/policy_test_cases*/`, expected time: ~4000s or more.
221227
228+
> **Note:** For evaluation purposes, the timeout for the test cases is set here to 20 seconds (vs. 1200 seconds in the paper). If you feel like you want to change it, edit `prepp.sh` in folders `policy_test_cases_cakeml_worst/` `policy_test_cases_hol4_best/` `policy_test_cases_hol4_worst/` and update (20s to 1200s) in this line:
229+
> ```
230+
> timeout 20s Holmake "internet_firewall_${i}Theory.uo"
231+
> ```
232+
222233
223234
<br>
224235
<br>
@@ -259,7 +270,7 @@ The test case folders and the scripts they run are as follows:
259270
The following steps show how to inspect the compiled theories inside the Docker image.
260271
To inspect the contents of the files, we exemplify using `policy_test_cases_cakeml_best/internet_firewall_1.sml`, we add further instructions for other test case folders when needed:
261272
262-
273+
> **Note:** For evaluation purposes, the timeout for the test cases is set here to 20 seconds (vs. 1200 seconds in the paper).
263274
264275
265276
@@ -281,12 +292,6 @@ cd /HOL4P4/hol/polygram/policy_test_cases_cakeml_best
281292
Repeat for any other folder you want to test/inspect later (`policy_test_cases_mtbdd`, `policy_test_cases_eq`, `policy_test_cases_gen_policy`...`policy_test_cases_*`).
282293
283294
284-
> **Note:** For evaluation purposes, the timeout is set here to 20 seconds (vs. 1200 seconds in the paper). If you feel like you want to change it, edit `prepp.sh` and update (20s to 1200s) in this line:
285-
> ```
286-
> timeout 20s Holmake "internet_firewall_${i}Theory.uo"
287-
> ```
288-
289-
290295
291296
#### Step 2 - View the time logs
292297

0 commit comments

Comments
 (0)