forked from openvm-org/openvm
-
Notifications
You must be signed in to change notification settings - Fork 0
231 lines (212 loc) · 8.76 KB
/
benchmark-call.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
name: "Benchmark: running individual benchmarks"
on:
workflow_dispatch:
inputs:
benchmark_name:
type: string
required: true
description: The name of the benchmark to run
instance_type:
type: string
required: false
description: The type of runner to start ({1,2,4,8,16,32,48,64}cpu-linux-{arm64,x64})
default: 64cpu-linux-arm64
memory_allocator:
type: string
required: false
description: Memory allocator to use (mimalloc or jemalloc)
default: mimalloc
app_log_blowup:
type: number
required: false
description: Application level log blowup
default: 2
agg_log_blowup:
type: number
required: false
description: Aggregation (leaf) level log blowup
default: 2
root_log_blowup:
type: number
required: false
description: Root level log blowup (only for e2e)
default: 2
internal_log_blowup:
type: number
required: false
description: Internal level log blowup (only for e2e)
default: 2
max_segment_length:
type: number
required: false
description: Max segment length for continuations, must be larger than 524288
default: 1048476
e2e_bench:
type: boolean
required: true
description: Whether to run the e2e benchmark
workflow_call:
inputs:
benchmark_name:
type: string
required: true
description: The name of the benchmark to run
benchmark_id:
type: string
required: true
description: The id of the benchmark to run, must be unique within matrix
instance_type:
type: string
required: false
description: The type of runner to start ({1,2,4,8,16,32,48,64}cpu-linux-{arm64,x64})
default: 64cpu-linux-arm64
memory_allocator:
type: string
required: false
description: Memory allocator to use (mimalloc or jemalloc)
default: mimalloc
app_log_blowup:
type: number
required: false
description: Application level log blowup
default: 2
agg_log_blowup:
type: number
required: false
description: Aggregation (leaf) level log blowup
default: 2
root_log_blowup:
type: number
required: false
description: Root level log blowup (only for e2e)
default: 2
internal_log_blowup:
type: number
required: false
description: Internal level log blowup (only for e2e)
default: 2
max_segment_length:
type: number
required: false
description: Max segment length for continuations, must be larger than 524288
default: 1048476
e2e_bench:
type: boolean
required: true
description: Whether to run the e2e benchmark
env:
S3_METRICS_PATH: s3://openvm-public-data-sandbox-us-east-1/benchmark/github/metrics
FEATURE_FLAGS: "bench-metrics,parallel,nightly-features"
CMD_ARGS: ""
INPUT_ARGS: ""
CARGO_NET_GIT_FETCH_WITH_CLI: "true"
permissions:
contents: write
jobs:
bench-new:
name: Run benchmark on workflow ref/branch
runs-on:
- runs-on
- runner=${{ inputs.instance_type }}
- run-id=${{ github.run_id }}
- family=m7
- tag=bench-${{ inputs.benchmark_name }}-${{ github.run_id }}-${{ github.run_number }}-${{ github.run_attempt }}
steps:
##########################################################################
# Environment setup #
##########################################################################
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha || github.sha }}
repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
- uses: dtolnay/rust-toolchain@nightly
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: true
- name: Install architecture specific tools
run: |
source ci/scripts/utils.sh
install_s5cmd
- name: Display workflow inputs
run: echo "${{ toJSON(inputs) }}"
- name: Feature flags
if: contains(github.event.pull_request.labels.*.name, 'run-benchmark') || (github.event_name == 'push' && github.ref == 'refs/heads/main')
run: |
echo "Adding aggregation feature flag"
echo "FEATURE_FLAGS=${FEATURE_FLAGS},aggregation" >> $GITHUB_ENV
- name: Setup e2e (halo2 and arguments)
run: |
E2E_BENCH=${{ inputs.e2e_bench }}
echo "E2E_BENCH=${E2E_BENCH}" >> $GITHUB_ENV
if [[ "${E2E_BENCH}" == "true" ]]; then
ROOT_ARG="--root_log_blowup ${{ inputs.root_log_blowup }}"
INTERNAL_ARG="--internal_log_blowup ${{ inputs.internal_log_blowup }}"
echo "INPUT_ARGS=${ROOT_ARG} ${INTERNAL_ARG} ${INPUT_ARGS}" >> $GITHUB_ENV
bash ./extensions/native/recursion/trusted_setup_s3.sh
export PARAMS_DIR=$(pwd)/params
fi
- name: Set BIN_NAME and CMD_ARGS
run: |
CMD_ARGS="--features ${FEATURE_FLAGS}"
echo "CMD_ARGS=${CMD_ARGS}" >> $GITHUB_ENV
echo "BIN_NAME=${{ inputs.benchmark_name }}" >> $GITHUB_ENV
- name: Set working directory
id: set-working-dir
run: |
WORKING_DIR=$(jq -r --arg name "${{ inputs.benchmark_name }}" '
.benchmarks[] |
select(.name == $name) |
.working_directory
' ./ci/benchmark-config.json)
RELATIVE_PATH=$(python3 -c "import os.path; print(os.path.relpath('.', '$WORKING_DIR'))")
echo "working_dir=$WORKING_DIR" >> $GITHUB_OUTPUT
echo "relative_path=$RELATIVE_PATH" >> $GITHUB_OUTPUT
# Metric name is unique within a run (matrix)
# When uploading to S3, use ${METRIC_NAME}-${current_sha}.[md/json]
- name: Set metric name
run: |
METRIC_NAME=${{ inputs.benchmark_id || inputs.benchmark_name }}
echo "METRIC_NAME=${METRIC_NAME}" >> $GITHUB_ENV
METRIC_PATH=".bench_metrics/${METRIC_NAME}.json"
echo "METRIC_PATH=${METRIC_PATH}" >> $GITHUB_ENV
- name: Set input args
run: |
INSTANCE_TYPE="--instance_type ${{ inputs.instance_type }}"
MEMORY_ALLOCATOR="--memory_allocator ${{ inputs.memory_allocator }}"
APP_ARG="--app_log_blowup ${{ inputs.app_log_blowup }}"
AGG_ARG="--agg_log_blowup ${{ inputs.agg_log_blowup }}"
MAX_SEGMENT_LENGTH="--max_segment_length ${{ inputs.max_segment_length }}"
OUTPUT_PATH="--output_path $METRIC_PATH"
echo "INPUT_ARGS=${INSTANCE_TYPE} ${MEMORY_ALLOCATOR} ${APP_ARG} ${AGG_ARG} ${MAX_SEGMENT_LENGTH} ${OUTPUT_PATH} ${INPUT_ARGS}" >> $GITHUB_ENV
##########################################################################
# Find working directory based on benchmark_name and run the benchmark #
##########################################################################
- name: Run benchmark
working-directory: ${{ steps.set-working-dir.outputs.working_dir }}
run: |
python3 ${{ steps.set-working-dir.outputs.relative_path }}/ci/scripts/bench.py $BIN_NAME $CMD_ARGS $INPUT_ARGS
##########################################################################
# Store metric json file to S3 #
##########################################################################
- name: Upload metric json and compute diff with previous to generate markdown
run: |
current_sha=$(git rev-parse HEAD)
echo "Current SHA: $current_sha"
echo "current_sha=${current_sha}" >> $GITHUB_ENV
s5cmd cp $METRIC_PATH ${{ env.S3_METRICS_PATH }}/${METRIC_NAME}-${current_sha}.json
# - name: Install inferno-flamegraph
# run: cargo install inferno
# - name: Generate flamegraphs
# run: |
# if [[ -f $METRIC_PATH ]]; then
# python3 ci/scripts/metric_unify/flamegraph.py $METRIC_PATH
# s5cmd cp '.bench_metrics/flamegraphs/*.svg' "${{ env.PUBLIC_S3_PATH }}/${current_sha}/"
# echo "UPLOAD_FLAMEGRAPHS=1" >> $GITHUB_ENV
# fi
##########################################################################
# Update s3 for latest main metrics upon a push event #
##########################################################################
- name: Update latest main result in s3
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: |
s5cmd cp $METRIC_PATH "${{ env.S3_METRICS_PATH }}/main-${METRIC_NAME}.json"