Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add benchmark results processing and deployment #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/workflows/process-results.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Process benchmark results

on:
push:
branches:
- main
pull_request:
workflow_dispatch:

jobs:
run-benchmark-monitor:
runs-on: ubuntu-latest
steps:
- name: Checkout processing script
uses: actions/checkout@v3
with:
repository: cz4rs/benchmark_monitor
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
repository: cz4rs/benchmark_monitor
repository: kokkos/benchmark_monitor

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Original script: https://github.com/bensanmorris/benchmark_monitor
I have modified / customized it for our use case here: https://github.com/cz4rs/benchmark_monitor

I propose that we fork the original thing and I will deliver my changes with a pull request.

Copy link

Choose a reason for hiding this comment

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

I agree on forking this inside kokkos is the best option

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looking back at this, I think this whole step should be removed and benchmark_monitor.py script (plus the templates and requirements.txt) should be added to a subdirectory in this repo.

- name: Checkout
uses: actions/checkout@v3
with:
path: benchmark-results

- name: Process available benchmark results
run: |-
pip3 install -r requirements.txt
python3 benchmark_monitor.py -s 50 -d ./benchmark-results -o output

- name: Generate nojekyll file
working-directory: output
run: touch .nojekyll

- name: Deploy
if: ${{ github.ref == 'refs/heads/main' }}
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: output
branch: deploy-benchmarks
clean: true
single-commit: true

17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# kokkos-benchmark-results

Repository for storing performance benchmark results.

## Generate performance graphs locally
```sh
# get benchmark results and processing script
git clone [email protected]:kokkos/benchmark_monitor.git
git clone [email protected]:kokkos/kokkos-benchmark-results.git
cd benchmark_monitor
# create and activate virtual environment
python3 -m venv env
source env/bin/activate
# continue inside a virtual environment
pip install -r requirements.txt
python benchmark_monitor.py -d ../benchmark-results -o output
cz4rs marked this conversation as resolved.
Show resolved Hide resolved
```
This will generate `index.html` and the rest of files in `output` diectory.