Adds element-wise functions `angle` and `reciprocal` #1474

ndgrigorian · 2023-11-24T08:47:14Z

This pull request implements two new element-wise functions, dpctl.tensor.angle and dpctl.tensor.reciprocal.

To support the inclusion of reciprocal, an acceptance function argument to the UnaryElementwiseFunc class is added to align the behavior of reciprocal and divide.

This pull request also slips in bug fixes to usm_ndarray -- namely, the real and imag properties.

imag was not allocating to the same queue as the original array for real-valued types, and would raise an exception for real-valued 0D arrays.

Both real and imag would return None for float16 arrays as a result of incorrect logic in the typenum checks.

Have you provided a meaningful PR description?
Have you added a test, reproducer or referred to an issue with a reproducer?
Have you tested your changes locally for CPU and GPU devices?
Have you made sure that new changes do not introduce compiler warnings?
Have you checked performance impact of proposed changes?
If this PR is a work in progress, are you opening the PR as a draft?

This change was made to mirror promotion behavior of divide in reciprocal Adds getter method for the acceptance function Adds tests for reciprocal

_zero_like did not have logic accounting for 0D arrays, so `x.imag` failed for 0D x

This prevents unexpected behavior when calling `imag` i.e., for x with a real-valued data type `dpctl.tensor.atan2(x.imag, x.real)` would not work prior to this change

The logic in these properties did not work for float16 data types, returning None instead of `self` or an array of zeros

github-actions · 2023-11-24T09:19:07Z

View rendered docs @ https://intelpython.github.io/dpctl/pulls/1474/index.html

coveralls · 2023-11-24T09:20:33Z

coverage: 85.979% (+0.04%) from 85.942%
when pulling f8536c1 on elementwise-angle-reciprocal
into 5ec9fd5 on master.

github-actions · 2023-11-24T09:44:49Z

Array API standard conformance tests for dpctl=0.15.1dev2=py310h15de555_26 ran successfully.
Passed: 1019
Failed: 55
Skipped: 59

github-actions · 2023-11-24T09:48:37Z

Array API standard conformance tests for dpctl=0.15.1dev2=py310h15de555_27 ran successfully.
Passed: 1019
Failed: 55
Skipped: 59

github-actions · 2023-11-27T18:02:39Z

Array API standard conformance tests for dpctl=0.15.1dev2=py310h15de555_27 ran successfully.
Passed: 876
Failed: 55
Skipped: 59

dpctl/tensor/_elementwise_common.py

oleksandr-pavlyk · 2023-11-29T21:44:38Z

dpctl/tensor/_usmarray.pyx

@@ -698,7 +699,8 @@ cdef class usm_ndarray:
        """ Returns imaginary component for arrays with complex data-types
        and returns zero array for all other data-types.
        """
-        if (self.typenum_ < UAR_CFLOAT):
+        # explicitly check for UAR_HALF, which is greater than UAR_CFLOAT
+        if (self.typenum_ < UAR_CFLOAT or self.typenum_ == UAR_HALF):


Good catch!

oleksandr-pavlyk

Module the renaming suggestion this PR is in perfect shape. The renaming can be addressed in a separate PR though.

`_acceptance_fn_default1` and `_acceptance_fn_default2` are now `_acceptance_fn_default_unary` and `_acceptance_fn_default_binary`

ndgrigorian · 2023-11-29T21:59:30Z

Module the renaming suggestion this PR is in perfect shape. The renaming can be addressed in a separate PR though.

I noticed a typo in the rsqrt docstring, so I went ahead and added the acceptance function naming change as well.

github-actions · 2023-11-29T23:00:55Z

Array API standard conformance tests for dpctl=0.15.1dev2=py310h15de555_29 ran successfully.
Passed: 875
Failed: 56
Skipped: 59

ndgrigorian · 2023-11-30T00:07:35Z

Internal CI failures are not related to this PR and will be investigated separately

I will merge this

ndgrigorian added 10 commits November 22, 2023 16:41

Implements elementwise reciprocal

2beca15

Fixes typo in kernels/elementwise_functions/proj.hpp

7217ffc

Implements elementwise angle

4e2440e

UnaryElementwiseFunc class now takes an acceptance function

3f24ef2

This change was made to mirror promotion behavior of divide in reciprocal Adds getter method for the acceptance function Adds tests for reciprocal

Small bugfix in _zero_like

434015f

_zero_like did not have logic accounting for 0D arrays, so `x.imag` failed for 0D x

_zero_like now allocates using the same sycl_queue

871646b

This prevents unexpected behavior when calling `imag` i.e., for x with a real-valued data type `dpctl.tensor.atan2(x.imag, x.real)` would not work prior to this change

Fixes bugs in real and imag properties

1388283

The logic in these properties did not work for float16 data types, returning None instead of `self` or an array of zeros

Adds tests for angle

72520b7

Adds tests for fixes to real/imag properties

19ca014

Adds test that real, imag use the same queue

64ced5c

ndgrigorian requested review from oleksandr-pavlyk and vtavana November 24, 2023 08:52

ndgrigorian marked this pull request as ready for review November 24, 2023 19:02

oleksandr-pavlyk reviewed Nov 29, 2023

View reviewed changes

dpctl/tensor/_elementwise_common.py Outdated Show resolved Hide resolved

oleksandr-pavlyk reviewed Nov 29, 2023

View reviewed changes

oleksandr-pavlyk previously approved these changes Nov 29, 2023

View reviewed changes

ndgrigorian added 2 commits November 29, 2023 13:54

Correction to rsqrt docstring

0018dfa

Change acceptance function names per feedback

f8536c1

`_acceptance_fn_default1` and `_acceptance_fn_default2` are now `_acceptance_fn_default_unary` and `_acceptance_fn_default_binary`

ndgrigorian dismissed oleksandr-pavlyk’s stale review via f8536c1 November 29, 2023 21:58

oleksandr-pavlyk approved these changes Nov 29, 2023

View reviewed changes

ndgrigorian merged commit b3ba5ac into master Nov 30, 2023
37 of 43 checks passed

ndgrigorian deleted the elementwise-angle-reciprocal branch November 30, 2023 18:06

oleksandr-pavlyk mentioned this pull request Jan 26, 2024

Populated changelog of new features since 0.15.0 release #1510

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds element-wise functions `angle` and `reciprocal` #1474

Adds element-wise functions `angle` and `reciprocal` #1474

ndgrigorian commented Nov 24, 2023

github-actions bot commented Nov 24, 2023

coveralls commented Nov 24, 2023 •

edited

Loading

github-actions bot commented Nov 24, 2023

github-actions bot commented Nov 24, 2023

github-actions bot commented Nov 27, 2023

oleksandr-pavlyk Nov 29, 2023

oleksandr-pavlyk left a comment

ndgrigorian commented Nov 29, 2023

github-actions bot commented Nov 29, 2023

ndgrigorian commented Nov 30, 2023

Adds element-wise functions angle and reciprocal #1474

Adds element-wise functions angle and reciprocal #1474

Conversation

ndgrigorian commented Nov 24, 2023

github-actions bot commented Nov 24, 2023

coveralls commented Nov 24, 2023 • edited Loading

github-actions bot commented Nov 24, 2023

github-actions bot commented Nov 24, 2023

github-actions bot commented Nov 27, 2023

oleksandr-pavlyk Nov 29, 2023

Choose a reason for hiding this comment

oleksandr-pavlyk left a comment

Choose a reason for hiding this comment

ndgrigorian commented Nov 29, 2023

github-actions bot commented Nov 29, 2023

ndgrigorian commented Nov 30, 2023

Adds element-wise functions `angle` and `reciprocal` #1474

Adds element-wise functions `angle` and `reciprocal` #1474

coveralls commented Nov 24, 2023 •

edited

Loading