Standarize program augmentation APIs and their documentation #28
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.
This pull request introduces a new flag
_been_writen
to theState
class in thebrainstate
module and makes several updates to thebrainstate/augment/_mapping.py
file to improve context handling in graph transformations. The most important changes include adding the_been_writen
flag, updating methods to handle this new flag, and enhancing the graph transformation functions to support context tags.State Class Enhancements:
brainstate/_state.py
: Added_been_writen
flag to theState
class and updated methods likevalue
,update_from_ref
, andcopy
to utilize this flag. [1] [2] [3] [4] [5] [6] [7] [8]Graph Transformation Enhancements:
brainstate/augment/_mapping.py
: Modified theMapFn
class and related functions to includectxtag
for better context handling during graph transformations. [1] [2] [3] [4] [5]Testing Enhancements:
brainstate/augment/_mapping_test.py
: Added new test cases to validate the functionality ofvmap
with the new context handling and_been_writen
flag.Context Management Enhancements:
brainstate/graph/_graph_context.py
: Introducedupdate_context
and modified existing context management classes to supportctxtag
. [1] [2]