FFT benchmarks #62
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Run FFT benchmarks on an AWS instance and return parsed results to Slab CI bot. | |
| name: FFT benchmarks | |
| env: | |
| CARGO_TERM_COLOR: always | |
| ACTION_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} | |
| RESULTS_FILENAME: parsed_benchmark_results_${{ github.sha }}.json | |
| RUST_BACKTRACE: "full" | |
| SLACK_CHANNEL: ${{ secrets.SLACK_CHANNEL }} | |
| SLACK_ICON: https://pbs.twimg.com/profile_images/1274014582265298945/OjBKP9kn_400x400.png | |
| SLACK_USERNAME: ${{ secrets.BOT_USERNAME }} | |
| SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }} | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - "main" | |
| schedule: | |
| # Job will be triggered each Thursday at 11p.m. | |
| - cron: '0 23 * * 4' | |
| jobs: | |
| setup-ec2: | |
| name: Setup EC2 instance (fft-benchmarks) | |
| runs-on: ubuntu-latest | |
| outputs: | |
| runner-name: ${{ steps.start-instance.outputs.label }} | |
| instance-id: ${{ steps.start-instance.outputs.ec2-instance-id }} | |
| steps: | |
| - name: Start instance | |
| id: start-instance | |
| uses: zama-ai/slab-github-runner@ab65ad70bb9f9e9251e4915ea5612bcad23cd9b1 | |
| with: | |
| mode: start | |
| github-token: ${{ secrets.SLAB_ACTION_TOKEN }} | |
| slab-url: ${{ secrets.SLAB_BASE_URL }} | |
| job-secret: ${{ secrets.JOB_SECRET }} | |
| profile: bench | |
| fft-benchmarks: | |
| name: Execute FFT benchmarks in EC2 | |
| needs: setup-ec2 | |
| concurrency: | |
| group: ${{ github.workflow }}_${{ github.ref }} | |
| cancel-in-progress: true | |
| runs-on: ${{ needs.setup-ec2.outputs.runner-name }} | |
| steps: | |
| - name: Get benchmark date | |
| run: | | |
| echo "BENCH_DATE=$(date --iso-8601=seconds)" >> "${GITHUB_ENV}" | |
| - name: Checkout tfhe-rs repo with tags | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up home | |
| # "Install rust" step require root user to have a HOME directory which is not set. | |
| run: | | |
| echo "HOME=/home/ubuntu" >> "${GITHUB_ENV}" | |
| - name: Install build dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y m4 | |
| - name: Install rust | |
| uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af | |
| with: | |
| toolchain: nightly | |
| override: true | |
| - name: Run benchmarks | |
| run: | | |
| make bench | |
| - name: Parse results | |
| run: | | |
| COMMIT_DATE="$(git --no-pager show -s --format=%cd --date=iso8601-strict ${{ github.sha }})" | |
| COMMIT_HASH="$(git describe --tags --dirty)" | |
| python3 ./ci/benchmark_parser.py target/criterion ${{ env.RESULTS_FILENAME }} \ | |
| --database concrete_fft \ | |
| --hardware "hpc7a.96xlarge" \ | |
| --project-version "${COMMIT_HASH}" \ | |
| --branch ${{ github.ref_name }} \ | |
| --commit-date "${COMMIT_DATE}" \ | |
| --bench-date "${{ env.BENCH_DATE }}" | |
| rm -rf target/criterion benchmarks_parameters/ | |
| - name: Run benchmarks with AVX512 | |
| run: | | |
| make AVX512_SUPPORT=ON bench | |
| - name: Parse AVX512 results | |
| run: | | |
| python3 ./ci/benchmark_parser.py target/criterion ${{ env.RESULTS_FILENAME }} \ | |
| --name-suffix avx512 \ | |
| --append-results | |
| rm -rf target/criterion benchmarks_parameters/ | |
| - name: Run benchmarks with FFT128 | |
| run: | | |
| make FFT128_SUPPORT=ON bench | |
| - name: Parse FFT128 results | |
| run: | | |
| python3 ./ci/benchmark_parser.py target/criterion ${{ env.RESULTS_FILENAME }} \ | |
| --name-suffix fft128 \ | |
| --append-results | |
| rm -rf target/criterion benchmarks_parameters/ | |
| - name: Run benchmarks with FFT128 + AVX512 | |
| run: | | |
| make AVX512_SUPPORT=ON FFT128_SUPPORT=ON bench | |
| - name: Parse FFT128 + AVX512 results | |
| run: | | |
| python3 ./ci/benchmark_parser.py target/criterion ${{ env.RESULTS_FILENAME }} \ | |
| --name-suffix fft128_avx512 \ | |
| --append-results | |
| - name: Upload parsed results artifact | |
| uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce | |
| with: | |
| name: ${{ github.sha }}_fft | |
| path: ${{ env.RESULTS_FILENAME }} | |
| - name: Checkout Slab repo | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c | |
| with: | |
| repository: zama-ai/slab | |
| path: slab | |
| token: ${{ secrets.FHE_ACTIONS_TOKEN }} | |
| - name: Send data to Slab | |
| shell: bash | |
| run: | | |
| echo "Computing HMac on downloaded artifact" | |
| SIGNATURE="$(slab/scripts/hmac_calculator.sh ${{ env.RESULTS_FILENAME }} '${{ secrets.JOB_SECRET }}')" | |
| echo "Sending results to Slab..." | |
| curl -v -k \ | |
| -H "Content-Type: application/json" \ | |
| -H "X-Slab-Repository: ${{ github.repository }}" \ | |
| -H "X-Slab-Command: store_data_v2" \ | |
| -H "X-Hub-Signature-256: sha256=${SIGNATURE}" \ | |
| -d @${{ env.RESULTS_FILENAME }} \ | |
| ${{ secrets.SLAB_URL }} | |
| - name: Slack Notification | |
| if: ${{ failure() }} | |
| continue-on-error: true | |
| uses: rtCamp/action-slack-notify@b24d75fe0e728a4bf9fc42ee217caa686d141ee8 | |
| env: | |
| SLACK_COLOR: ${{ job.status }} | |
| SLACK_MESSAGE: "concrete-fft benchmarks failed. (${{ env.ACTION_RUN_URL }})" | |
| teardown-ec2: | |
| name: Teardown EC2 instance (fft-benchmarks) | |
| if: ${{ always() && needs.setup-ec2.result != 'skipped' }} | |
| needs: [ setup-ec2, fft-benchmarks ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Stop instance | |
| id: stop-instance | |
| uses: zama-ai/slab-github-runner@ab65ad70bb9f9e9251e4915ea5612bcad23cd9b1 | |
| with: | |
| mode: stop | |
| github-token: ${{ secrets.SLAB_ACTION_TOKEN }} | |
| slab-url: ${{ secrets.SLAB_BASE_URL }} | |
| job-secret: ${{ secrets.JOB_SECRET }} | |
| profile: bench | |
| label: ${{ needs.setup-ec2.outputs.runner-name }} | |
| - name: Slack Notification | |
| if: ${{ failure() }} | |
| continue-on-error: true | |
| uses: rtCamp/action-slack-notify@b24d75fe0e728a4bf9fc42ee217caa686d141ee8 | |
| env: | |
| SLACK_COLOR: ${{ job.status }} | |
| SLACK_MESSAGE: "EC2 teardown (fft-benchmarks) failed. (${{ env.ACTION_RUN_URL }})" |