More docstring edits #1636

oleksandr-pavlyk · 2024-04-05T13:27:01Z

Docstring edits for dpctl.memory and dpctl.utils namespaces.

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?

github-actions · 2024-04-05T14:00:37Z

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

coveralls · 2024-04-05T14:04:46Z

coverage: 88.049% (-0.03%) from 88.076%
when pulling e3bc17f on more-docstring-edits
into ca59c3d on master.

github-actions · 2024-04-05T14:08:55Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_202 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

github-actions · 2024-04-05T18:41:10Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_203 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Updated docstrings for __dlpack__, __dlpack_device__, real, imag properties, and for shape, strides, _pointer, _element_offset, _byte_bounds.

github-actions · 2024-04-05T21:17:21Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_203 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

github-actions · 2024-04-05T22:36:49Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_204 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

There is no longer a class ``sycl::cpu_selector``. Instead there is a callable functor ``sycl::cpu_selector_v`` which ``sycl::device`` constructor takes as an argument.

github-actions · 2024-04-07T00:01:42Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_206 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Made them uniform, specify return type, fix references to SYCL 2020 spec document.

github-actions · 2024-04-07T14:49:28Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_206 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Also added examples to some aspect properties.

Added examples for few properties that return enums.

Added docstrings with return type for properties. Added few examples.

Added examples and return types for some properties.

Added docstrings for submit, submit_async, _submit_keep_args_alive, submit_barrier methods.

Also used double quotes for proper rendering of variables in docstrings of reduction functions.

…thod Also added docstring for __init__ special method.

github-actions · 2024-04-09T15:09:56Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_215 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

dpctl/_sycl_device.pyx

dpctl/_sycl_queue.pyx

dpctl/tensor/_usmarray.pyx

dpctl/tensor/_ctors.py

dpctl/utils/_compute_follows_data.pyx

github-actions · 2024-04-09T22:22:09Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_219 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

dpctl/tensor/_usmarray.pyx

dpctl/utils/_compute_follows_data.pyx

github-actions · 2024-04-09T22:52:41Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_220 ran successfully.
Passed: 870
Failed: 8
Skipped: 92

dpctl/_sycl_platform.pyx

dpctl/program/_program.pyx

github-actions · 2024-04-10T03:44:00Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_222 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

github-actions · 2024-04-10T12:32:21Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_224 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

github-actions · 2024-04-10T14:45:20Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_225 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Indentation fixed for item list, usm_array.device -> usm_ndarray.device Used double back-quotes instead of single for proper rendering in HTML

github-actions · 2024-04-11T16:38:29Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_226 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Since resulting docstrings are long, added flake8 exceptions

github-actions · 2024-04-11T17:28:22Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_228 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

ndgrigorian

LGTM, thank you @oleksandr-pavlyk, this is a huge number of changes to the docstrings.

oleksandr-pavlyk · 2024-04-11T17:41:59Z

Thank you @ndgrigorian and @antonwolfy for the review. Merging this batch, and will open a new PR should more changes be needed.

github-actions · 2024-04-11T17:45:26Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_229 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

oleksandr-pavlyk added 2 commits April 4, 2024 21:48

Fix docstrings for functions in program/_program.pyx

e4e8c92

Edits docstrings for functions in dpctl.utils namespace

b1ab254

Docstring changes for usm_ndarray

100aba9

Updated docstrings for __dlpack__, __dlpack_device__, real, imag properties, and for shape, strides, _pointer, _element_offset, _byte_bounds.

oleksandr-pavlyk force-pushed the more-docstring-edits branch from 84aaeb0 to 100aba9 Compare April 5, 2024 20:40

Docstring edits for array creation functions.

da24ba3

Changed docstrings for select_*_device per changes in SYCL spec

dcee243

There is no longer a class ``sycl::cpu_selector``. Instead there is a callable functor ``sycl::cpu_selector_v`` which ``sycl::device`` constructor takes as an argument.

Update to properties and methods of SyclDevice

4562db9

Made them uniform, specify return type, fix references to SYCL 2020 spec document.

oleksandr-pavlyk force-pushed the more-docstring-edits branch from 9efc4d9 to 4562db9 Compare April 7, 2024 14:11

oleksandr-pavlyk requested a review from ndgrigorian April 8, 2024 03:31

oleksandr-pavlyk added 7 commits April 8, 2024 17:00

Edits to docstring of SyclDevice.create_sub_devices

e11146c

Also added examples to some aspect properties.

Fixed indentation in SyclDevice docstring

6dc33ce

Added examples for few properties that return enums.

Fixed indents in SyclEvent class

88b83b2

Added docstrings with return type for properties. Added few examples.

Fixed indents in SyclPlatform docstring

4a11004

Added examples and return types for some properties.

Corrected indents in docstring of SyclQueue class

94293ce

Added docstrings for submit, submit_async, _submit_keep_args_alive, submit_barrier methods.

Fix indentation in item list to resolve Sphinx warnings

8e2f1f4

Also used double quotes for proper rendering of variables in docstrings of reduction functions.

Fix indents for docstring of SyclTimer, populated docstring for dt me…

629f6e2

…thod Also added docstring for __init__ special method.

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/_sycl_device.pyx Outdated Show resolved Hide resolved

oleksandr-pavlyk added 2 commits April 9, 2024 13:59

thi -> this typo fixed

ae33ff6

Corrected indents for SyclContext class docstrings

67466d4

antonwolfy reviewed Apr 9, 2024

View reviewed changes

Fix typos found during review

20de762

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/tensor/_usmarray.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/tensor/_usmarray.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/utils/_compute_follows_data.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/utils/_compute_follows_data.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/utils/_compute_follows_data.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/utils/_compute_follows_data.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/_sycl_platform.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/program/_program.pyx Outdated Show resolved Hide resolved

ndgrigorian reviewed Apr 9, 2024

View reviewed changes

dpctl/program/_program.pyx Outdated Show resolved Hide resolved

oleksandr-pavlyk added 2 commits April 9, 2024 22:03

Edits per PR review

e85eb4e

Edits per PR review

9d00c03

oleksandr-pavlyk added 2 commits April 10, 2024 06:51

Fixed typo and grammar in docstrings caught in review

af77217

Fixed typos foundn in review

49046c7

oleksandr-pavlyk added 2 commits April 10, 2024 09:06

Clarified type of input arguments, that it can be list or tuple

df39f8c

Fixed item list indentations in docstrings from dpctl.utils

e398caa

Docstring edits for _array_api

dd46535

Indentation fixed for item list, usm_array.device -> usm_ndarray.device Used double back-quotes instead of single for proper rendering in HTML

oleksandr-pavlyk added 2 commits April 11, 2024 11:50

Fixed docstrings of inspection API class and methods

19f8059

Since resulting docstrings are long, added flake8 exceptions

More fixes in _array_api, missed in previous commit

e3bc17f

ndgrigorian approved these changes Apr 11, 2024

View reviewed changes

oleksandr-pavlyk merged commit 10b831c into master Apr 11, 2024

oleksandr-pavlyk deleted the more-docstring-edits branch April 11, 2024 19:56

More docstring edits #1636

More docstring edits #1636

Uh oh!

Conversation

oleksandr-pavlyk commented Apr 5, 2024

Uh oh!

github-actions bot commented Apr 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Apr 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 5, 2024

Uh oh!

github-actions bot commented Apr 5, 2024

Uh oh!

github-actions bot commented Apr 5, 2024

Uh oh!

github-actions bot commented Apr 5, 2024

Uh oh!

github-actions bot commented Apr 7, 2024

Uh oh!

github-actions bot commented Apr 7, 2024

Uh oh!

github-actions bot commented Apr 9, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 9, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 9, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 10, 2024

Uh oh!

github-actions bot commented Apr 10, 2024

Uh oh!

github-actions bot commented Apr 10, 2024

Uh oh!

github-actions bot commented Apr 11, 2024

Uh oh!

github-actions bot commented Apr 11, 2024

Uh oh!

ndgrigorian left a comment

Choose a reason for hiding this comment

Uh oh!

oleksandr-pavlyk commented Apr 11, 2024

Uh oh!

github-actions bot commented Apr 11, 2024

Uh oh!

Uh oh!

github-actions bot commented Apr 5, 2024 •

edited

Loading

coveralls commented Apr 5, 2024 •

edited

Loading