Skip to content

Commit

Permalink
ci: Refactor LC bench (#311)
Browse files Browse the repository at this point in the history
* ci: Improve automated benchmark report

* ci: Refactor automated benches into composite action

* Test e2e

* Prep for review
  • Loading branch information
samuelburnham authored Nov 1, 2024
1 parent 15b5678 commit a7ffd41
Show file tree
Hide file tree
Showing 6 changed files with 123 additions and 134 deletions.
87 changes: 87 additions & 0 deletions .github/actions/bench/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: Run a light client benchmark

description: Run benchmark and output a Markdown report

inputs:
light-client:
description: 'Light client to benchmark'
required: true
benchmark:
description: 'Benchmark to run'
required: true

outputs:
report:
description: "Markdown report"
value: ${{ steps.prep-report.outputs.report }}

runs:
using: "composite"
steps:
- name: Install jtbl
shell: bash
run: |
sudo apt-get update && sudo apt-get install -y python3-pip
pip3 --version
pip3 install --break-system-packages jtbl
echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.profile
source ~/.profile
which jtbl
- name: Run benchmarks
shell: bash
run: |
make bench-ci BENCH=${{ inputs.benchmark }} 2>&1 | tee out.txt
working-directory: ${{ github.workspace }}/${{ inputs.light-client }}/light-client
- name: Create report
shell: bash
run: |
grep 'cycles=' out.txt > cycles.txt
grep 'proving_time' out.txt > timings.txt
while IFS=$'\t' read -r f1 f2
do
num_cycles=$(echo "$f1" | grep -o 'cycles=[0-9]*' | awk -F'=' '{ print $2 }')
timings=$(echo "$f2" | jq '
to_entries |
map(
if .key == "proving_time" then
{key, value: (.value / 1000 | floor as $s | "\(($s / 60 | floor) | tostring)min\(($s % 60) | tostring)s")}
elif .key == "verifying_time" then
{key, value: ((.value / 1000 * 1000 | floor) / 1000 | tostring + "s")}
else
.
end
) |
from_entries
')
echo "$timings" | jq -c --argjson cycles "$num_cycles" '. += {cycles: $cycles}' >> summary.json
done < <(paste cycles.txt timings.txt)
COMMIT_SHORT=$(git rev-parse --short HEAD)
echo '# `${{ inputs.light-client }}` Benchmark Results' | tee -a summary.md
echo "Commit: \`$COMMIT_SHORT\`" | tee -a summary.md
echo '## `${{ inputs.benchmark }}` Proof' | tee -a summary.md
cat summary.json | jtbl -m | tee -a summary.md
echo "" | tee -a summary.md
echo "[Workflow URL](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})" | tee -a summary.md
working-directory: ${{ github.workspace }}/${{ inputs.light-client }}/light-client
- name: Write bench on commit comment
uses: peter-evans/commit-comment@v3
id: commit-comment
with:
body-path: ${{ github.workspace }}/${{ inputs.light-client }}/light-client/summary.md
- name: Prep report for Zulip
id: prep-report
shell: bash
run: |
COMMIT=$(git rev-parse HEAD)
ID=${{ steps.commit-comment.outputs.comment-id }}
echo "[Commit comment](https://github.com/${{ github.repository }}/commit/$COMMIT#commitcomment-$ID)" | tee -a summary.md
echo "report<<EOF" >> $GITHUB_OUTPUT
cat summary.md >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
working-directory: ${{ github.workspace }}/${{ inputs.light-client }}/light-client
154 changes: 28 additions & 126 deletions .github/workflows/bench.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Runs benchmarks on self-hosted infra via `workflow_dispatch` and scheduled on Mondays at 9am EST
# Runs benchmarks on self-hosted infra via `workflow_dispatch` and scheduled on Thursdays at 2pm UTC
#
# `workflow_dispatch` trigger
# The workflow can be run at https://github.com/argumentcomputer/zk-light-clients/actions/workflows/bench.yml
# The benchmark report can be found in the logs and as a comment on the latest commit on `dev`.
# The report can also be sent as a Zulip message to https://zulip.argument.xyz
#
# `schedule` trigger
# The workflow runs every week on Monday at 9am EST
# The workflow runs every week on Thursday at 2pm UTC
# It runs all light client benchmarks and sends them to Zulip
name: Light client benchmark
on:
Expand Down Expand Up @@ -69,7 +69,7 @@ concurrency:

jobs:
benchmark-manual:
name: Light client benchmark (manual)
name: LC bench (manual)
if: github.event_name == 'workflow_dispatch'
runs-on: warp-custom-r7iz-metal-32xl
steps:
Expand All @@ -80,14 +80,6 @@ jobs:
- uses: actions/checkout@v4
- name: Setup CI
uses: ./.github/actions/setup
- name: Install extra deps
run: |
sudo apt-get update && sudo apt-get install -y python3-pip
pip3 --version
pip3 install --break-system-packages jtbl
echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.profile
source ~/.profile
which jtbl
- name: Set env
run: |
# Default benchmark settings optimized for light clients, can be overwritten with `env` input
Expand Down Expand Up @@ -128,49 +120,12 @@ jobs:
echo "STREAM=$STREAM" | tee -a $GITHUB_ENV
echo "TOPIC=$TOPIC" | tee -a $GITHUB_ENV
fi
- name: Run benchmarks
run: |
make bench-ci BENCH=${{ inputs.bench-name }} 2>&1 | tee out.txt
working-directory: ${{ github.workspace }}/${{ inputs.light-client }}/light-client
- name: Create report
id: run-benchmarks
run: |
grep 'cycles=' out.txt > cycles.txt
grep 'proving_time' out.txt > timings.txt
while IFS=$'\t' read -r f1 f2
do
num_cycles=$(echo "$f1" | grep -o 'cycles=[0-9]*' | awk -F'=' '{ print $2 }')
timings=$(echo "$f2" | jq '
to_entries |
map(
if .key == "proving_time" or .key == "verifying_time" then
{key, value: (.value / 1000 | floor as $s | "\(($s / 60 | floor) | tostring)min\(($s % 60) | tostring)s")}
else
.
end
) |
from_entries
')
echo "$timings" | jq -c --argjson cycles "$num_cycles" '. += {cycles: $cycles}' >> summary.json
done < <(paste cycles.txt timings.txt)
echo '# `${{ inputs.light-client }}` Benchmark Results' | tee -a summary.md
echo '## `${{ inputs.bench-name }}` Prove' | tee -a summary.md
cat summary.json | jtbl -m | tee -a summary.md
echo "" | tee -a summary.md
echo "Workflow URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" | tee -a summary.md
echo "report<<EOF" >> $GITHUB_OUTPUT
cat summary.md >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
working-directory: ${{ github.workspace }}/${{ inputs.light-client }}/light-client
- name: Write bench on commit comment
uses: peter-evans/commit-comment@v3
- name: Run benchmark and create report
id: run-benchmark
uses: ./.github/actions/bench
with:
body-path: ${{ github.workspace }}/${{ inputs.light-client }}/light-client/summary.md
light-client: ${{ inputs.light-client }}
benchmark: ${{ inputs.bench-name }}
- name: Send report to Zulip
if: inputs.zulip
uses: zulip/github-actions-zulip/send-message@v1
Expand All @@ -182,29 +137,28 @@ jobs:
type: "${{ env.TYPE }}"
# Ignored if `type: private`
topic: "${{ env.TOPIC }}"
content: "${{ steps.run-benchmarks.outputs.report }}"
content: "${{ steps.run-benchmark.outputs.report }}"

benchmark-scheduled:
name: Light client bench (scheduled)
name: LC bench (scheduled)
if: github.event_name == 'schedule'
runs-on: warp-custom-r7iz-metal-32xl
strategy:
fail-fast: false
matrix:
light-client: [ aptos, ethereum, kadena ]
include:
- benchmark: inclusion
light-client: aptos
- benchmark: epoch_change
light-client: aptos
- benchmark: inclusion
light-client: ethereum
- benchmark: committee_change
light-client: ethereum
- benchmark: spv
light-client: kadena
- benchmark: longest_chain
light-client: kadena
- light-client: aptos
benchmark: inclusion
- light-client: aptos
benchmark: epoch_change
- light-client: ethereum
benchmark: inclusion
- light-client: ethereum
benchmark: committee_change
- light-client: kadena
benchmark: spv
- light-client: kadena
benchmark: longest_chain
steps:
- uses: actions/checkout@v4
with:
Expand All @@ -213,14 +167,6 @@ jobs:
- uses: actions/checkout@v4
- name: Setup CI
uses: ./.github/actions/setup
- name: Install extra deps
run: |
sudo apt-get update && sudo apt-get install -y python3-pip
pip3 --version
pip3 install --break-system-packages jtbl
echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.profile
source ~/.profile
which jtbl
- name: Set env
run: |
# Default benchmark settings optimized for light clients, can be overwritten with `env` input
Expand All @@ -230,61 +176,17 @@ jobs:
echo "RECONSTRUCT_COMMITMENTS=false" | tee -a $GITHUB_ENV
echo "SHARD_CHUNKING_MULTIPLIER=1" | tee -a $GITHUB_ENV
echo "MODE=SNARK" | tee -a $GITHUB_ENV
IFS=',' read -ra ENV_VARS <<< "ethereum"
for VAR in "${ENV_VARS[@]}"; do
VAR_NAME="${VAR%%=*}"
VAR_VALUE="${VAR#*=}"
echo "${VAR_NAME}=${VAR_VALUE}" | tee -a $GITHUB_ENV
done
- name: Set Zulip env
run: |
echo "TYPE=stream" | tee -a $GITHUB_ENV
echo "STREAM=light-client" | tee -a $GITHUB_ENV
echo "TOPIC=Benchmark Reports" | tee -a $GITHUB_ENV
- name: Run benchmarks
run: |
make bench-ci BENCH=${{ matrix.benchmark }} 2>&1 | tee out.txt
working-directory: ${{ github.workspace }}/${{ matrix.light-client }}/light-client
- name: Create report
id: run-benchmarks
run: |
grep 'cycles=' out.txt > cycles.txt
grep 'proving_time' out.txt > timings.txt
while IFS=$'\t' read -r f1 f2
do
num_cycles=$(echo "$f1" | grep -o 'cycles=[0-9]*' | awk -F'=' '{ print $2 }')
timings=$(echo "$f2" | jq '
to_entries |
map(
if .key == "proving_time" or .key == "verifying_time" then
{key, value: (.value / 1000 | floor as $s | "\(($s / 60 | floor) | tostring)min\(($s % 60) | tostring)s")}
else
.
end
) |
from_entries
')
echo "$timings" | jq -c --argjson cycles "$num_cycles" '. += {cycles: $cycles}' >> summary.json
done < <(paste cycles.txt timings.txt)
echo '# `${{ matrix.light-client }}` Benchmark Results' | tee -a summary.md
echo '## `${{ matrix.benchmark }}` Prove' | tee -a summary.md
cat summary.json | jtbl -m | tee -a summary.md
echo "" | tee -a summary.md
echo "Workflow URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" | tee -a summary.md
echo "report<<EOF" >> $GITHUB_OUTPUT
cat summary.md >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
working-directory: ${{ github.workspace }}/${{ matrix.light-client }}/light-client
- name: Write bench on commit comment
uses: peter-evans/commit-comment@v3
- name: Run benchmark and create report
id: run-benchmark
uses: ./.github/actions/bench
with:
body-path: ${{ github.workspace }}/${{ matrix.light-client }}/light-client/summary.md
light-client: ${{ matrix.light-client }}
benchmark: ${{ matrix.benchmark }}
- name: Send report to Zulip
uses: zulip/github-actions-zulip/send-message@v1
with:
Expand All @@ -295,4 +197,4 @@ jobs:
type: "${{ env.TYPE }}"
# Ignored if `type: private`
topic: "${{ env.TOPIC }}"
content: "${{ steps.run-benchmarks.outputs.report }}"
content: "${{ steps.run-benchmark.outputs.report }}"
4 changes: 2 additions & 2 deletions ethereum/light-client/benches/committee_change.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ impl BenchmarkAssets {
#[derive(Debug, Clone, Serialize)]
struct BenchResults {
proving_time: u128,
verification_time: u128,
verifying_time: u128,
}

fn main() {
Expand Down Expand Up @@ -114,7 +114,7 @@ fn main() {
// Print results
let results = BenchResults {
proving_time: proving_time.as_millis(),
verification_time: verifying_time.as_millis(),
verifying_time: verifying_time.as_millis(),
};

let json_output = serde_json::to_string(&results).unwrap();
Expand Down
4 changes: 2 additions & 2 deletions ethereum/light-client/benches/inclusion.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ impl BenchmarkAssets {
#[derive(Debug, Clone, Serialize)]
struct BenchResults {
proving_time: u128,
verification_time: u128,
verifying_time: u128,
}

fn main() {
Expand Down Expand Up @@ -125,7 +125,7 @@ fn main() {
// Print results
let results = BenchResults {
proving_time: proving_time.as_millis(),
verification_time: verifying_time.as_millis(),
verifying_time: verifying_time.as_millis(),
};

let json_output = serde_json::to_string(&results).unwrap();
Expand Down
4 changes: 2 additions & 2 deletions kadena/light-client/benches/longest_chain.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ impl BenchmarkAssets {
#[derive(Debug, Clone, Serialize)]
struct BenchResults {
proving_time: u128,
verification_time: u128,
verifying_time: u128,
}

fn main() {
Expand Down Expand Up @@ -65,7 +65,7 @@ fn main() {
// Print results
let results = BenchResults {
proving_time: proving_time.as_millis(),
verification_time: verifying_time.as_millis(),
verifying_time: verifying_time.as_millis(),
};

println!("{}", serde_json::to_string(&results).unwrap());
Expand Down
4 changes: 2 additions & 2 deletions kadena/light-client/benches/spv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ impl BenchmarkAssets {
#[derive(Debug, Clone, Serialize)]
struct BenchResults {
proving_time: u128,
verification_time: u128,
verifying_time: u128,
}

fn main() {
Expand Down Expand Up @@ -75,7 +75,7 @@ fn main() {
// Print results
let results = BenchResults {
proving_time: proving_time.as_millis(),
verification_time: verifying_time.as_millis(),
verifying_time: verifying_time.as_millis(),
};

println!("{}", serde_json::to_string(&results).unwrap());
Expand Down

1 comment on commit a7ffd41

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aptos Benchmark Results

Commit: a7ffd41

epoch_change Proof

proving_time verifying_time cycles
7min42s 0.11s 8674366

Workflow URL

Please sign in to comment.