-
Notifications
You must be signed in to change notification settings - Fork 0
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 support for profiling with Scalene #60
Conversation
@@ -5,21 +5,30 @@ All notable changes to this project will be documented in this file. | |||
The format is based on [Keep a Changelog], and this project adheres to | |||
[Semantic Versioning]. | |||
|
|||
## [0.6.2] - 2023-12-05 |
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.
Interesting, did you manually drop the dates from the release versions? or was that an auto-formatting? isn't against semantic versioning to included - because they seem useful.
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.
I removed them from the file for 2 reasons: (1) each is a guess based on when we think the actual release will be made (so it is possible to be wrong), and (2) they are redundant because github automatically adds the release date to the releases page
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.
But that would require a user to go dig into the Github releases and cross reference. It's much nicer to just have it in the log for humans to read.
bin/conda-prefix.sh
Outdated
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.
Need to Document what this file's purpose is, comment at top would suffice.
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.
Will do.
bin/delete-algorithm.sh
Outdated
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.
What's the expected method for executing this script and it's relatives?
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.
The delete-algorithm and register-algorithm scripts are referenced in CONTRIBUTING.md. The describe-algorithm script is not described because it is not really intended to be used directly. The other 2 scripts call it.
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.
I made some suggestions and asked a few clarifying questions. Nothing is a blocker that I can see, but I would like the readability for regular users addressed before approving.
7dad6e6
to
a5d7c84
Compare
Added a new input (
scalene_args
) to allow users to run the algorithm via Scalene to produce a profiling (mem+cpu) report. The input value is simply a string of command-line options to pass toscalene
to launch the algorithm within the existingsubset.sh
run script.In addition, added/modified the following to address various inconveniences along the way:
build.sh
script that installs deps into the conda environmentbin/generate-lock-file.sh
script for conveniently regenerating the conda lock file after changes are made to eitherenvironment.yml
orenvironment-dev.yml
algorithm_config.yaml
to match new structure/naming implemented on the MAAP API sidealgorithm_config.yaml
file:bin/describe-algorithm.sh
bin/register-algorithm.sh
bin/delete-algorithm.sh
docs/MAAP_USAGE.md
accordinglyHere are 2 example profile outputs in the ADE, both using the same algo inputs, but one is a "reduced" profile:
~/shared-buckets/dschuck/gedi-subset/profile.html
~/shared-buckets/dschuck/gedi-subset/profile-reduced.html