-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add benchmark script and testing (#158)
* add benchmark script and testing * add compat bounds * update CompatHelper * ignore benchmark for CI * format * adjust test values * soften tolerances * WIP: try include instead of trixi_include * uncomment all elixirs again * fix typo * instantiate * don't clutter terminal * don't activate in benchmarks.jl * add README * move develop after activate * use @__MODULE__ in trixi_include * test to include plot in comment * Apply suggestions from code review Co-authored-by: Hendrik Ranocha <[email protected]> * use braces * return to original version * try embedding link to artifact --------- Co-authored-by: Hendrik Ranocha <[email protected]>
- Loading branch information
1 parent
5734033
commit 17a3d77
Showing
10 changed files
with
147 additions
and
7 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| name: Benchmark a Pull Request | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
|
|
||
| permissions: | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| benchmark: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: julia-actions/setup-julia@v2 | ||
| with: | ||
| version: "1.10" | ||
| - uses: julia-actions/cache@v2 | ||
| - name: Extract Package Name from Project.toml | ||
| id: extract-package-name | ||
| run: | | ||
| PACKAGE_NAME=$(grep "^name" Project.toml | sed 's/^name = "\(.*\)"$/\1/') | ||
| echo "package_name=$PACKAGE_NAME" >> $GITHUB_OUTPUT | ||
| - name: Build AirspeedVelocity | ||
| env: | ||
| JULIA_NUM_THREADS: 2 | ||
| run: | | ||
| # Lightweight build step, as sometimes the runner runs out of memory: | ||
| julia -e 'ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0; import Pkg; Pkg.add("AirspeedVelocity")' | ||
| julia -e 'ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0; import Pkg; Pkg.build("AirspeedVelocity")' | ||
| - name: Add ~/.julia/bin to PATH | ||
| run: | | ||
| echo "$HOME/.julia/bin" >> $GITHUB_PATH | ||
| - name: Run benchmarks | ||
| run: | | ||
| echo $PATH | ||
| ls -l ~/.julia/bin | ||
| mkdir results | ||
| benchpkg ${{ steps.extract-package-name.outputs.package_name }} --rev="${{github.event.repository.default_branch}},${{github.event.pull_request.head.sha}}" --url=${{ github.event.repository.clone_url }} --bench-on="${{github.event.pull_request.head.sha}}" --output-dir=results/ --tune | ||
| - name: Create plots from benchmarks | ||
| run: | | ||
| mkdir -p plots | ||
| benchpkgplot ${{ steps.extract-package-name.outputs.package_name }} --rev="${{github.event.repository.default_branch}},${{github.event.pull_request.head.sha}}" --npart=10 --format=png --input-dir=results/ --output-dir=plots/ | ||
| - name: Upload plot as artifact | ||
| id: artifact-upload-step | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: plots | ||
| path: plots | ||
| - name: Create markdown table from benchmarks | ||
| run: | | ||
| benchpkgtable ${{ steps.extract-package-name.outputs.package_name }} --rev="${{github.event.repository.default_branch}},${{github.event.pull_request.head.sha}}" --input-dir=results/ --ratio > table.md | ||
| echo '### Benchmark Results' > body.md | ||
| echo '' >> body.md | ||
| echo '' >> body.md | ||
| cat table.md >> body.md | ||
| echo '' >> body.md | ||
| echo '' >> body.md | ||
| echo '### Benchmark Plots' >> body.md | ||
| echo 'A plot of the benchmark results have been uploaded as an artifact to the workflow run for this PR.' >> body.md | ||
| echo '' >> body.md | ||
| - name: Find Comment | ||
| uses: peter-evans/find-comment@v3 | ||
| id: fcbenchmark | ||
| with: | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| comment-author: 'github-actions[bot]' | ||
| body-includes: Benchmark Results | ||
|
|
||
| - name: Comment on PR | ||
| uses: peter-evans/create-or-update-comment@v4 | ||
| with: | ||
| comment-id: ${{ steps.fcbenchmark.outputs.comment-id }} | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| body-path: body.md | ||
| edit-mode: replace |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| [deps] | ||
| BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf" | ||
| OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed" | ||
| SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240" | ||
|
|
||
| [compat] | ||
| BenchmarkTools = "1" | ||
| OrdinaryDiffEq = "6.49.1" | ||
| SummationByPartsOperators = "0.5.63" |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Benchmarks | ||
|
|
||
| This directory contains some benchmark setups using [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl). | ||
| The file `benchmarks.jl` is run by a GitHub Action leveraging [AirspeedVelocity.jl](https://github.com/MilesCranmer/AirspeedVelocity.jl) | ||
| to generate a report on the performance of the package for each pull request. If you want to run the benchmarks locally, you can do so by running | ||
| `run_benchmarks.jl`, which returns a summary `results` of the benchmark results. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| using BenchmarkTools | ||
| using DispersiveShallowWater | ||
|
|
||
| const SUITE = BenchmarkGroup() | ||
|
|
||
| elixirs = [joinpath(examples_dir(), "bbm_1d", "bbm_1d_basic.jl"), | ||
| joinpath(examples_dir(), "bbm_1d", "bbm_1d_fourier.jl"), | ||
| joinpath(examples_dir(), "bbm_bbm_1d", "bbm_bbm_1d_dg.jl"), | ||
| joinpath(examples_dir(), "bbm_bbm_1d", "bbm_bbm_1d_relaxation.jl"), | ||
| joinpath(examples_dir(), "bbm_bbm_1d", "bbm_bbm_1d_upwind_relaxation.jl"), | ||
| joinpath(examples_dir(), "bbm_bbm_1d", "bbm_bbm_1d_basic_reflecting.jl"), | ||
| joinpath(examples_dir(), "hyperbolic_serre_green_naghdi_1d", | ||
| "hyperbolic_serre_green_naghdi_dingemans.jl"), | ||
| joinpath(examples_dir(), "serre_green_naghdi_1d", | ||
| "serre_green_naghdi_well_balanced.jl"), | ||
| joinpath(examples_dir(), "svaerd_kalisch_1d", | ||
| "svaerd_kalisch_1d_dingemans_relaxation.jl")] | ||
|
|
||
| for elixir in elixirs | ||
| benchname = joinpath(basename(dirname(elixir)), basename(elixir)) | ||
| println("Running $benchname...") | ||
| redirect_stdout(devnull) do | ||
| trixi_include(@__MODULE__, elixir, tspan = (0.0, 1e-10)) | ||
| end | ||
| SUITE[benchname] = @benchmarkable DispersiveShallowWater.rhs!($(similar(sol.u[end])), | ||
| $(copy(sol.u[end])), | ||
| $(semi), $(first(tspan))) | ||
| end |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| using Pkg | ||
| Pkg.activate(@__DIR__) | ||
| Pkg.develop(PackageSpec(path = dirname(@__DIR__))) | ||
| Pkg.instantiate() | ||
|
|
||
| include("benchmarks.jl") | ||
| tune!(SUITE) | ||
| result = run(SUITE) |
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