Skip to content

Commit

Permalink
Generate README.pdf for Zenodo preview
Browse files Browse the repository at this point in the history
  • Loading branch information
AlienKevin committed Oct 10, 2023
1 parent eb72ce7 commit 8b2957e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
Binary file added README.pdf
Binary file not shown.
11 changes: 6 additions & 5 deletions README.md → README_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,19 @@ In this artifact, we included the implementation of our web automation program s

# Benchmarks
We collected 131 real-world benchmarks on web-automation tasks, with each benchmark stored in a folder with name WxTx. Each benchmark contains the following files/folder:
* *.program: the ground truth web automation program.
* script.py: the selenium program used to record the action trace and doms of the simulated user interactions on the doms.
* trace.json: the json file contains a list of actions for completing the benchmark task. Each action contains its type, corresponding selectors, and the data if applicable.
* doms/: the folder contain all website dom indexed from the starting website dom before applying the first action to the last website dom after applying the last action.

- *.program: the ground truth web automation program.
- script.py: the selenium program used to record the action trace and doms of the simulated user interactions on the doms.
- trace.json: the json file contains a list of actions for completing the benchmark task. Each action contains its type, corresponding selectors, and the data if applicable.
- doms/: the folder contain all website dom indexed from the starting website dom before applying the first action to the last website dom after applying the last action.

# Evaluation Instructions
We packaged all code and data into a cross-platform Docker container that works for both x86 and arm host machines.

## Setup Docker Desktop
1. Install Docker Desktop if you haven't already from https://www.docker.com/products/docker-desktop/

2. Change the allocated disk space to **200GB** in the preferences (Settings -> Resources -> Disk). Docker won't necessarily use all 200GB but this amount is required to prevent out of memory errors. See the below screenshot for steps:
2. Change the allocated disk space to **200GB** in the preferences (Settings -> Resources -> Disk). Docker won't necessarily use all 200GB but this amount is required to prevent out of memory errors. See Figure 1 on the next page for the steps.

![Docker Desktop Configuration](media/configure-docker-desktop.png)

Expand Down
13 changes: 13 additions & 0 deletions build.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,16 @@ docker buildx build --push --platform linux/amd64,linux/arm64 -t alienkevin/arbo
```
docker buildx build --load --platform linux/arm64 -t arborist .
```

# Convert README_source.md to PDF
1. Install pandoc (steps taken from https://gist.github.com/dcchambers/9761c71880114cc604c902b30b2e06c8?permalink_comment_id=4533368#gistcomment-4533368)
```
brew install pandoc
brew install basictex --cask
eval "$(/usr/libexec/path_helper)"
```

2. Generate PDF
```
pandoc README_source.md -o README.pdf -V geometry:margin=1in
```

0 comments on commit 8b2957e

Please sign in to comment.