Skip to content
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

Documentation: Add doc page for dpctl.tensor._flags.Flags class #1794

Merged
merged 4 commits into from
Aug 8, 2024

Conversation

ndgrigorian
Copy link
Collaborator

This PR adds a new documentation page for the Flags helper class which also lists the values its __getitem__ method will accept for dictionary-like access.

  • 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?

Copy link

github-actions bot commented Aug 8, 2024

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

@coveralls
Copy link
Collaborator

coveralls commented Aug 8, 2024

Coverage Status

coverage: 87.93%. remained the same
when pulling f289dd9 on document-usm-ndarray-flags-obj
into 1a789e7 on master.

Copy link

github-actions bot commented Aug 8, 2024

Array API standard conformance tests for dpctl=0.18.0dev0=py310ha798474_261 ran successfully.
Passed: 895
Failed: 0
Skipped: 119

This makes it link to the new flags documentation
@ndgrigorian ndgrigorian force-pushed the document-usm-ndarray-flags-obj branch from 0f41c4d to 93d8f48 Compare August 8, 2024 06:15
Copy link

github-actions bot commented Aug 8, 2024

Array API standard conformance tests for dpctl=0.18.0dev0=py310ha798474_261 ran successfully.
Passed: 894
Failed: 1
Skipped: 119

Copy link

github-actions bot commented Aug 8, 2024

Array API standard conformance tests for dpctl=0.18.0dev0=py310ha798474_262 ran successfully.
Passed: 894
Failed: 1
Skipped: 119

Copy link
Collaborator

@oleksandr-pavlyk oleksandr-pavlyk left a comment

Choose a reason for hiding this comment

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

Looks good to me overall with some nits

@oleksandr-pavlyk
Copy link
Collaborator

Perhaps the docstring of the Flags class can be rectified:

Helper class to represent memory layout flags of dpctl.tensor.usm_ndarray

Flags go beyond memory layout information now.

@ndgrigorian
Copy link
Collaborator Author

Perhaps the docstring of the Flags class can be rectified:

Helper class to represent memory layout flags of dpctl.tensor.usm_ndarray

Flags go beyond memory layout information now.

I've pushed a change to address this

Copy link

github-actions bot commented Aug 8, 2024

Array API standard conformance tests for dpctl=0.18.0dev0=py310ha798474_267 ran successfully.
Passed: 894
Failed: 1
Skipped: 119

@ndgrigorian ndgrigorian merged commit dea8b83 into master Aug 8, 2024
42 of 49 checks passed
@ndgrigorian ndgrigorian deleted the document-usm-ndarray-flags-obj branch August 8, 2024 19:43
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.

3 participants