Skip to content

Add a note for description of axis in accumulation functions #1631

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 1 commit into from
Apr 3, 2024

Conversation

antonwolfy
Copy link
Collaborator

@antonwolfy antonwolfy commented Apr 3, 2024

The PR proposes to add a note for description of axis in accumulation functions as per Python array API for cumulative_sum documentation.
Without the note in the description it might not be clear that axis keyword is required (rather than optional) in some use cases.

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

@antonwolfy antonwolfy self-assigned this Apr 3, 2024
Copy link

github-actions bot commented Apr 3, 2024

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

@coveralls
Copy link
Collaborator

Coverage Status

coverage: 87.974%. remained the same
when pulling 654f64f on docstring-axis-cumulative_sum
into 03c7615 on master.

Copy link

github-actions bot commented Apr 3, 2024

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_162 ran successfully.
Passed: 839
Failed: 0
Skipped: 92

Copy link
Contributor

@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.

The added wording is straight from array API spec. LGTM! Thank you @antonwolfy

@antonwolfy antonwolfy merged commit fda9837 into master Apr 3, 2024
@antonwolfy antonwolfy deleted the docstring-axis-cumulative_sum branch April 3, 2024 14:05
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