-
Notifications
You must be signed in to change notification settings - Fork 41
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
Generate Kani Metrics #235
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM modulo minor fixes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for holding off the merge. I don't think we should upload images to our repo to avoid unnecessarily growing its size. Per our offline discussion, I think we can keep running this weekly job to collect the metrics, and we can plot those metrics as part of building our book.
@celinval I've made these changes. The Separately, the "Build Book" workflow reads from that file, plots the data, then puts it in the book. See the book on my fork to see what it'll look like. |
.github/workflows/book.yml
Outdated
- name: Generate Metrics Graphs | ||
run: | | ||
cd scripts/kani-std-analysis/ | ||
python kani_std_analysis.py --plot-only | ||
cd ../.. | ||
mv scripts/kani-std-analysis/*.png doc/src/metrics/kani/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a mdbook pre-processor. Can you make sure we can still build the book if the png
files are not there?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done (sort of). I got it working for mdbook build doc
but not mdbook build
inside the doc/
directory. At the moment, I can't really see a way around it because we need to pass a --manifest-path
to the preprocessor (this is how the example does it too).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See my fork book.
Add a new "Kani Metrics" workflow (that runs every week) that calls
./scripts/run-kani --run metrics
, then creates a pull request to this repository with the computed metrics. See here for an example of what the pull request will look like. Also update our "Build Book" workflow to publish graphs of the metrics.Callouts:
kani_std_analysis.py
for other callouts.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.