Skip to content

Commit

Permalink
Update Documentation for running the evaluation with the Docker runtime
Browse files Browse the repository at this point in the history
  • Loading branch information
Munsio committed Jul 17, 2024
1 parent ba6ccfd commit 4d64691
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,23 +151,24 @@ Ensure that docker is installed on the system.
### Build or pull the image

```bash
docker build . -t eval-dev-quality
docker build . -t eval-dev-quality:dev
```

```bash
docker pull ghcr.io/symflower/eval-dev-quality:latest
docker pull ghcr.io/symflower/eval-dev-quality:main
```

### Run the evaluation either with the built or pulled image

The following command will run the model `symflower/symbolic-execution` and stores the the results of the run inside the local directory `evaluation`.

```bash
docker run -v ./:/home/ubuntu/evaluation --user $(id -u):$(id -g) eval-dev-quality:latest eval-dev-quality evaluate --model symflower/symbolic-execution --result-path /home/ubuntu/evaluation/%datetime%
eval-dev-quality evaluate --runtime docker --runtime-image eval-dev-quality:dev --model symflower/symbolic-execution
```

Omitting the `--runtime-image` parameter will default to the image from the `main` branch. `ghcr.io/symflower/eval-dev-quality:main`
```bash
docker run -v ./:/home/ubuntu/evaluation --user $(id -u):$(id -g) ghcr.io/symflower/eval-dev-quality:latest eval-dev-quality evaluate --model symflower/symbolic-execution --result-path /home/ubuntu/evaluation/%datetime%
eval-dev-quality evaluate --runtime docker --model symflower/symbolic-execution
```

## Kubernetes
Expand Down

0 comments on commit 4d64691

Please sign in to comment.