-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Fix example and docs typos for objmode
context manager.
#3577
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -120,15 +120,15 @@ def mutate_with_body(self, func_ir, blocks, blk_start, blk_end, | |
class _ObjModeContextType(WithContext): | ||
"""Creates a contextmanager to be used inside jitted functions to enter | ||
*object-mode* for using interpreter features. The body of the with-context | ||
is lifted into a function that is compiled into *object-mode*. This | ||
transformation process is limitated and cannot process all possible | ||
is lifted into a function that is compiled in *object-mode*. This | ||
transformation process is limited and cannot process all possible | ||
Python code. However, users can wrap complicated logic in another | ||
Python function, which will then be executed by the interpreter. | ||
|
||
Use this as a function that takes keyword arguments only. | ||
The argument names must correspond to the output variables from the | ||
with-block. Their respective values are strings representing the expected | ||
types. When exiting the with-context, the output variables are casted | ||
types. When exiting the with-context, the output variables are cast | ||
to the expected nopython types according to the annotation. This process | ||
is the same as passing Python objects into arguments of a nopython | ||
function. | ||
|
@@ -140,20 +140,20 @@ class _ObjModeContextType(WithContext): | |
|
||
def bar(x): | ||
# This code is executed by the interpreter. | ||
return np.asarray(list(reversed(x.tolist())) | ||
return np.asarray(list(reversed(x.tolist()))) | ||
|
||
@njit | ||
def foo(): | ||
x = np.arange(5) | ||
y = np.arange(5) | ||
with objmode(y='intp[:]'): # annotate return type | ||
# this region is executed by object-mode. | ||
y += bar(x) | ||
y += bar(y) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we don't have to change this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed in eacd307 |
||
return y | ||
|
||
.. note:: Known limitation: | ||
.. note:: Known limitations: | ||
|
||
- with-block cannot use incoming list object. | ||
- with-block cannot use incoming function object. | ||
- with-block cannot use incoming list objects. | ||
- with-block cannot use incoming function objects. | ||
- with-block cannot ``yield``, ``break``, ``return`` or ``raise`` \ | ||
such that the execution will leave the with-block immediately. | ||
- with-block cannot contain `with` statements. | ||
|
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.
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.
We should change it so that we allocate
y = np.zeros_like(x)
and leavex
as is. We want to show that input arrays do not need to be annotated.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.
Ah yes, thanks, fixed in eacd307