Add some convenience to simulation creation. #1904
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
Encapsulates 80% of cases: ```cxx rec = recipe() ctx = make_context() dec = partition_load_balance(rec, ctx) sim = simulation(rec, dec, ctx) ``` is now written as ```cxx rec = recipe() sim = simulation(rec) ``` In python we use keyword args to allow both to be specified separatly.
Helveg
approved these changes
Jun 9, 2022
brenthuisman
suggested changes
Jun 10, 2022
brenthuisman
suggested changes
Jun 13, 2022
brenthuisman
suggested changes
Jun 14, 2022
| decomp = arbor.partition_load_balance(recipe, context) | ||
| sim = arbor.simulation(recipe, decomp, context) | ||
| ctx = arbor.context("avail_threads") | ||
| sim = arbor.simulation(recipe, context=ctx) |
There was a problem hiding this comment.
Suggested change
| sim = arbor.simulation(recipe, context=ctx) | |
| sim = arbor.simulation(recipe, arbor.context("avail_threads")) |
There was a problem hiding this comment.
Robin requested the exact opposite ;)
There was a problem hiding this comment.
I'll argue my case:
- If argument order changes, which it just did, using explicitly named arguments obviates refactoring on the call site.
- It's more explicit, although
arbor.contextand the variable namectxmake it clear enough. It's not that WET either. You'll find many call sites have patterns liketree=tree, axe=axe, chop=chop
There was a problem hiding this comment.
The main thing I care about is that as of The Swap(tm) context= can be left out. I'd have peace with
Suggested change
| sim = arbor.simulation(recipe, context=ctx) | |
| sim = arbor.simulation(recipe, ctx) |
There was a problem hiding this comment.
So, I'll let you two battle that out, I'd chosen @brenthuisman 's suggestion and only change due to Robin's wishes.
Less typing is almost always to be preferred.
brenthuisman
approved these changes
Jun 21, 2022
brenthuisman
added a commit
to brenthuisman/arbor
that referenced
this pull request
Jun 24, 2022
- Mention arbor-contrib in a few relevant places - Correct some fallout from arbor-sim#1904 - A new hardware and profiling tutorial, and covers things moved out of other examples in arbor-sim#1904 - Various other documentation fixes
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.
Encapsulates 80% of cases:
is now written as
In python we use keyword args to allow
both to be specified separatly.
Partially fixes #1862