Allow processes to be named. #198
Merged
Conversation
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
Because of how R assigns names to stack frames, all processes in a typical individual simulation would end up being called `p`. This makes it difficult to interpret profiling results. R uses the name of the variable the called function is bound to. By dynamically creating a variable with a chosen name and using `eval` to execute that variable, we can get the stack frame to show up with any desired name. This uses this trick to allow the list of processes to be given names, and these names are used in the calls.
|
Based on some quick local benchmarking there doesn't seem to be any measurable difference in performance with this. I've kicked off a touchstone run on plietar/malariasimulation#13, waiting for results. |
giovannic
approved these changes
Jul 12, 2024
|
Note: we would want to update dev too. |
|
Yeah that was definitely aimed at dev, I keep forgetting to set the right target branch |
plietar
added a commit
to mrc-ide/malariasimulation
that referenced
this pull request
Jul 12, 2024
Thanks to [individual#198], processes in the simulation can now be named. This has no effect on the behaviour of the simulation but helps in debugging and profiling by labelling the call frames with the given names. While at it, I've fixed a typo in the name of the prevalence renderer. [individual#198]: mrc-ide/individual#198
plietar
added a commit
to mrc-ide/malariasimulation
that referenced
this pull request
Jul 12, 2024
Thanks to [individual#198], processes in the simulation can now be named. This has no effect on the behaviour of the simulation but helps in debugging and profiling by labelling the call frames with the given names. While at it, I've fixed a typo in the name of the prevalence renderer. [individual#198]: mrc-ide/individual#198
plietar
added a commit
to mrc-ide/malariasimulation
that referenced
this pull request
Jul 12, 2024
Thanks to [individual#198], processes in the simulation can now be named. This has no effect on the behaviour of the simulation but helps in debugging and profiling by labelling the call frames with the given names. While at it, I've fixed a typo in the name of the prevalence renderer. [individual#198]: mrc-ide/individual#198
plietar
added a commit
to mrc-ide/malariasimulation
that referenced
this pull request
Jul 22, 2024
Thanks to [individual#198], processes in the simulation can now be named. This has no effect on the behaviour of the simulation but helps in debugging and profiling by labelling the call frames with the given names. [individual#198]: mrc-ide/individual#198
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because of how R assigns names to stack frames, all processes in a typical individual simulation would end up being called
p. This makes it difficult to interpret profiling results.R uses the name of the variable the called function is bound to. By dynamically creating a variable with a chosen name and using
evalto execute that variable, we can get the stack frame to show up with any desired name.This uses this trick to allow the list of processes to be given names, and these names are used in the calls.
Below is a comparison of the before and after of looking at a malariasimulation profile. Instead of everything being grouped under a single
pnode, there are now distinct nodes for each process.