Skip to content

Updated from_dlpack docstring #1919

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

Jump to bottom
Merged
merged 2 commits into from
Dec 3, 2024
Merged

Updated from_dlpack docstring #1919

merged 2 commits into from
Dec 3, 2024

Conversation

oleksandr-pavlyk
Copy link
Contributor

@oleksandr-pavlyk oleksandr-pavlyk commented Dec 3, 2024 •
edited
Loading

Closes gh-1917.

The change to docstring documents that tensor.from_dlpack may return numpy.ndarray or tensor.usm_ndarray and stipulates when that may happen.

  • 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?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?
  • If this PR is a work in progress, are you opening the PR as a draft?

@oleksandr-pavlyk
Updated from_dlpack docstring
34296a8 
Closes gh-1917.

The change to docstring documents that `tensor.from_dlpack` may return
numpy.ndarray or tensor.usm_ndarray and stipulates when that may happen.
ndgrigorian
ndgrigorian reviewed Dec 3, 2024
View reviewed changes
ndgrigorian
ndgrigorian reviewed Dec 3, 2024
View reviewed changes
ndgrigorian
ndgrigorian reviewed Dec 3, 2024
View reviewed changes
antonwolfy
antonwolfy reviewed Dec 3, 2024
View reviewed changes
@oleksandr-pavlyk
Fixed typos pointed in PR feedback
ef407d2 
Removed duplicated statements clarifying type of the return object
from entries describing supported device keyword values to the
paragraph describing the return type.

Moved the note pertaining to the SYCL queue of the returned
usm_ndarray there as well.
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 3, 2024 •
edited
Loading

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 3, 2024

Array API standard conformance tests for dpctl=0.19.0dev0=py310hdf72452_288 ran successfully.
Passed: 894
Failed: 2
Skipped: 118

@coveralls
Copy link
Collaborator

Coverage Status

coverage: 87.671%. remained the same
when pulling ef407d2 on update-from-dlpack-docs
into 631d4c3 on master.

ndgrigorian
ndgrigorian approved these changes Dec 3, 2024
View reviewed changes
Copy link
Collaborator

@ndgrigorian ndgrigorian left a comment

Choose a reason for hiding this comment

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

LGTM!

antonwolfy
antonwolfy approved these changes Dec 3, 2024
View reviewed changes
Copy link
Collaborator

@antonwolfy antonwolfy left a comment

Choose a reason for hiding this comment

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

Thank you @oleksandr-pavlyk, LGTM!

@oleksandr-pavlyk oleksandr-pavlyk merged commit 4c077ac into master Dec 3, 2024
50 of 53 checks passed
@oleksandr-pavlyk oleksandr-pavlyk deleted the update-from-dlpack-docs branch December 3, 2024 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndgrigorian ndgrigorian ndgrigorian approved these changes

@antonwolfy antonwolfy antonwolfy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

dpctl.tensor.from_dlpack returns numpy.ndarray
4 participants
@oleksandr-pavlyk @coveralls @ndgrigorian @antonwolfy