Skip to content

Edits to documentation per review feedback #936

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

Merged
merged 3 commits into from
Oct 27, 2022

Conversation

oleksandr-pavlyk
Copy link
Contributor

@oleksandr-pavlyk oleksandr-pavlyk commented Oct 17, 2022

Made explicit the intended use of event to ensure completion of submitted operation from host side of the application.

Removed note that dpctl.lsplatform() is new in dpctl 0.7

  • Have you provided a meaningful PR description?

Closes #937
Closes #938

@alexandraepan

@github-actions
Copy link

@coveralls
Copy link
Collaborator

coveralls commented Oct 17, 2022

Coverage Status

Coverage remained the same at 82.058% when pulling a604592 on docs-review-edits into 9e934b2 on master.

@github-actions
Copy link

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

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.0dev0=py310h8c27c75_170 ran successfully.
Passed: 32
Failed: 802
Skipped: 3138

Copy link
Contributor

@diptorupd diptorupd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oleksandr-pavlyk Since the doc is being touched, can you add a short few lines to address #937. I will be good to have @alexandraepan review them in this PR itself.

@github-actions
Copy link

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

@github-actions
Copy link

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

@oleksandr-pavlyk oleksandr-pavlyk force-pushed the docs-review-edits branch 2 times, most recently from 9b673b8 to 15206e3 Compare October 26, 2022 18:59
oleksandr-pavlyk and others added 2 commits October 26, 2022 14:01
Made intended use of event to ensure completion of submitted
operation from host side of the application explicit.

Removed note that lsplatform is new in dpctl 0.7

Update docs/docfiles/user_guides/QuickStart.rst

Streamlined notice about GPU drivers per PR review feedback.

Co-authored-by: Alexandra <[email protected]>
Adds mention of dpctl.tensor, usm_ndarray and array API standard in
intro.rst.

Also adds URL to array API standard.
@github-actions
Copy link

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

1 similar comment
@github-actions
Copy link

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

Dpctl implements N-dimensional array Python object :class:`dpctl.tensor.usm_ndarray` to
logically address USM memory allocations, and contains growing implementation of
operations on such objects confofrming :array_api:`array API specification <>` in
:class:`dpctl.tensor` namespace.

Dpctl also supports the DPCPP :oneapi_filter_selection:`oneapi::filter_selector <>` extension and has
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us change to DPC++ here too.

using SYCL USM memory. It makes it possible to create Python objects that are
backed by SYCL USM memory.

Dpctl implements N-dimensional array Python object :class:`dpctl.tensor.usm_ndarray` to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

"Dpctl also includes a reference implementation for :array_api:array API specification <> using DPC++ and USM memory allocation under the :class:dpctl.tensor sub-module. The :class:dpctl.tensor sub-module provides an N-dimensional array Python object :class:dpctl.tensor.usm_ndarray and a growing implementation of :array_api:array API specification <> complaint operations on instances of the array class. "

@github-actions
Copy link

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

@oleksandr-pavlyk oleksandr-pavlyk merged commit 36c8f71 into master Oct 27, 2022
@oleksandr-pavlyk oleksandr-pavlyk deleted the docs-review-edits branch October 27, 2022 17:18
@github-actions
Copy link

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

@github-actions
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

User manual should have a section on dpctl.tensor Update opening paragraph of dpctl docs
4 participants