-
Notifications
You must be signed in to change notification settings - Fork 13
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 new script for benchmarking #157
Add new script for benchmarking #157
Conversation
Codecov Report
@@ Coverage Diff @@
## master #157 +/- ##
==========================================
- Coverage 64.95% 63.05% -1.91%
==========================================
Files 27 28 +1
Lines 2802 2885 +83
==========================================
- Hits 1820 1819 -1
- Misses 982 1066 +84
Continue to review full report at Codecov.
|
…HealthyPear/protopipe into feature-add_protopipe_BENCHMARK
This is needed for the calibration notebook which is large and older versions of jupyter lab kill some Markdown cells
- script index - large scale analysis tutorial
- upgraded script - updated installation requirements
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.
looks good
Requirements
Description
This PR adds a script that can be called as
protopipe-BENCHMARK
which has 2 commands,list
, which lists all available benchmark notebooks underdocs/contribute/benchmarks
,launch
, that allows to launch 1 notebook viapapermill
(which is here added as a development dependency) and produce not only its executed version but also an HTML page.Using papermill allows to have default variables for input and optimizations, but the script can also read them from a configuration file
bechmarks.yaml
which should be copied with all the other ones by the interface (under testing in this PR).Variables can be also overwritten on the go via the CLI flag
--kwargs
.At the time of the first launch, a Jupyter Book template is filled, which pages are the single notebooks.
Such books are supposed to populate the new repository for the storage of performances.
TODO