[WIP, Proposal] Improve argument annotations interface #10746
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
This comment was marked as outdated.
This comment was marked as outdated.
JeppeKlitgaard
force-pushed
the
consistent-arg-annotations
branch
5 times, most recently
from
66fe0cb
to
ed0c7fa
Compare
15 tasks
JeppeKlitgaard
force-pushed
the
consistent-arg-annotations
branch
10 times, most recently
from
a31ff31
to
94140c8
Compare
JeppeKlitgaard
force-pushed
the
consistent-arg-annotations
branch
from
94140c8
to
7414957
Compare
|
Read The Docs error seems unrelated (404 HTTP error on intersphinx with SciPy) |
|
The RTD failure should be fixed now |
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.
This PR introduces a container class with a bit of additional logic sprinkled on top in order to consistently handle argument annotations.
I propose argument annotations are parsed into an
ArgumentAnnotationobject as part of the input validation of all transformations (jit,grad, ...). These are then the objects that are passed around instead of tuples ofargnumsandargnames. These tuples can be accessed when needed by lower level functions.This enables an easy and idiomatic way of ensuring arguments are validated while simultaneously providing an easy way to implement backwards compatibility through a subclass (not yet done).