-
Notifications
You must be signed in to change notification settings - Fork 17
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
Address #400 #401
Address #400 #401
Conversation
Codecov Report
@@ Coverage Diff @@
## main #401 +/- ##
==========================================
+ Coverage 94.37% 94.40% +0.02%
==========================================
Files 83 83
Lines 5053 5056 +3
==========================================
+ Hits 4769 4773 +4
+ Misses 284 283 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
# with the package. | ||
|
||
|
||
"""Lists of functions to be wrapped in scico.numpy.""" |
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.
some additional explanatory text might help:
"These are intended to be the functions in jax.numpy (https://jax.readthedocs.io/en/latest/jax.numpy.html) that should either (1) map over the blocks of a block array (for math functions); (2) map over a tuple of tuples to create a block array (for creation functions); or (3) reduce a block array to a scalar (for reductions).
The links to the numpy docs in the comments are useful for telling these three cases apart, but include extra functions that are not in jax.numpy and should not be listed here.
"
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.
Docs updated.
Address #400.