Expanded doc-string of dpctl.tensor.usm_ndarray.to_device

[oleksandr-pavlyk]

Expanded doc-string for to_device method of usm_ndarray class.

• Have you provided a meaningful PR description?

[github-actions]

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

[coveralls]

Coverage increased (+0.01%) to 81.963% when pulling 335afd5 on expand-to_device-docstring into ea4e009 on master.

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_5 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[oleksandr-pavlyk]

The failure of pre-commit workflow is being addressed in #991

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

[antonwolfy]

I've checked the generated page and it looks that:

1. The copyright year is not updated:

 Copyright 2020-21, Intel Corp..

2. The link below from usm_ndarray.usm_type description isn't working:

USM type of underlying memory. Can be ‘device’, ‘shared’, or ‘host’.

See: https://docs.oneapi.com/versions/latest/dpcpp/iface/usm.html

[antonwolfy]

I've tried the example, but got an exception:

In [1]: import dpctl
   ...: import dpctl.tensor as dpt
   ...:
   ...: x = dpt.full(10**6, 2, dtype="int64")
   ...: q_prof = dpctl.SyclQueue(
   ...:     x.sycl_device, property="enable_profiling")
   ...: # return a view with profile-enabled queue
   ...: y = x.to_device(q_prof)
   ...: timer = dpctl.SyclTimer()
   ...: with timer(q_prof):
   ...:     z = y * y
   ...: print(timer.dt)
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
Input In [1], in <cell line: 10>()
      9 timer = dpctl.SyclTimer()
     10 with timer(q_prof):
---> 11     z = y * y
     12 print(timer.dt)

TypeError: unsupported operand type(s) for *: 'dpctl.tensor._usmarray.usm_ndarray' and 'dpctl.tensor._usmarray.usm_ndarray'

but if I add import dpnp and run exactly the same code again, it will pass:

In [2]: import dpnp

In [3]: import dpctl
   ...: import dpctl.tensor as dpt
   ...:
   ...: x = dpt.full(10**6, 2, dtype="int64")
   ...: q_prof = dpctl.SyclQueue(
   ...:     x.sycl_device, property="enable_profiling")
   ...: # return a view with profile-enabled queue
   ...: y = x.to_device(q_prof)
   ...: timer = dpctl.SyclTimer()
   ...: with timer(q_prof):
   ...:     z = y * y
   ...: print(timer.dt)
(0.10838821064680815, 0.10794714400000001)

since, as I've got, dpctl will dispatch to dpnp.multiply then.
I believe import dpnp is missing in the example.

[oleksandr-pavlyk]

Yes, this example presently requires dpnp, because dpctl.tensor.__mul__ falls back to dpnp if present or returns NotImplemented. This is transient and support for Python arithmetic operations is coming soon.

For the purpose of illustrating usm_ndarray.to_device I probably should have used z = foo(y) to emphasize that any offloading routine we want to time could be used.

[oleksandr-pavlyk]

Merging. Will update copyright years with a tool in a separate commit.

[github-actions]

Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞

[github-actions]

Array API standard conformance tests for dpctl=0.14.0rc2=py310h8c27c75_7 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138