Skip to content

Update description of out keyword for ufuncs #1881

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 15, 2024
Merged

Update description of out keyword for ufuncs #1881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9cdf2b
Update docstrings for ufuncs
antonwolfy Jun 14, 2024
57c6019
Merge branch 'master' into update-ufunc-docstrings
antonwolfy Jun 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions dpnp/dpnp_iface_bitwise.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have integer or boolean data
type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -137,12 +137,12 @@
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have integer or boolean data
type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -199,12 +199,12 @@
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have integer or boolean data
type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -261,12 +261,12 @@
----------
x : {dpnp.ndarray, usm_ndarray}
Input array, expected to have integer or boolean data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -331,12 +331,12 @@
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have integer data type.
Each element must be greater than or equal to 0.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
out : dpnp.ndarray
Expand Down Expand Up @@ -389,12 +389,12 @@
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have integer data type.
Each element must be greater than or equal to 0.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down
53 changes: 27 additions & 26 deletions dpnp/dpnp_iface_logic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,12 +317,12 @@ def any(x, /, axis=None, out=None, keepdims=False, *, where=True):
First input array, expected to have numeric data type.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -386,12 +386,12 @@ def any(x, /, axis=None, out=None, keepdims=False, *, where=True):
First input array, expected to have numeric data type.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -449,12 +449,12 @@ def any(x, /, axis=None, out=None, keepdims=False, *, where=True):
First input array, expected to have numeric data type.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -553,12 +553,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
----------
x : {dpnp.ndarray, usm_ndarray}
Input array, expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -612,12 +612,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
----------
x : {dpnp.ndarray, usm_ndarray}
Input array, expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -665,12 +665,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
----------
x : {dpnp.ndarray, usm_ndarray}
Input array, expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -722,12 +722,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
First input array, expected to have numeric data type.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand All @@ -739,6 +739,7 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
-----------
Parameters `where` and `subok` are supported with their default values.
Otherwise ``NotImplementedError`` exception will be raised.
See Also
--------
:obj:`dpnp.greater` : Return the truth value of (x1 > x2) element-wise.
Expand Down Expand Up @@ -784,12 +785,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
First input array, expected to have numeric data type.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -847,12 +848,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
First input array.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -909,12 +910,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
----------
x : {dpnp.ndarray, usm_ndarray}
Input array.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -964,12 +965,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
First input array.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -1029,12 +1030,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
First input array.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -1092,12 +1093,12 @@ def isclose(x1, x2, rtol=1e-05, atol=1e-08, equal_nan=False):
First input array, expected to have numeric data type.
x2 : {dpnp.ndarray, usm_ndarray}
Second input array, also expected to have numeric data type.
out : {None, dpnp.ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.
Default: "K".
Default: ``"K"``.
Returns
-------
Expand Down
Loading
Loading