[Docs] Add documentation for dpctl enums#2019

Merged

ndgrigorian merged 7 commits intomasterfrom

document-dpctl-enum-types

Mar 19, 2025

Collaborator

ndgrigorian commented Feb 27, 2025 •

edited by vtavana

Loading

This PR adds generated documentation for dpctl enums (i.e., device_type, backend_type, etc.)

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?

github-actions bot commented Feb 27, 2025 •

edited

Loading

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

github-actions bot commented Feb 27, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_5 ran successfully.
Passed: 894
Failed: 3
Skipped: 125

Collaborator

coveralls commented Feb 27, 2025 •

edited

Loading

coverage: 87.677% (+0.03%) from 87.652%
when pulling 0984620 on document-dpctl-enum-types
into c3e6952 on master.

ndgrigorian added 2 commits

March 14, 2025 14:39


          Add generated documentation for enumerated types in dpctl

b4d3f8d


          Document enum values for dpctl enums directly in docstring

3a459ee

Better and more accurate formatting

ndgrigorian force-pushed the document-dpctl-enum-types branch from c4bae75 to 7e8f2cf Compare

March 14, 2025 21:39

github-actions bot commented Mar 14, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

ndgrigorian force-pushed the document-dpctl-enum-types branch from 7e8f2cf to cf203fa Compare

March 14, 2025 23:11

github-actions bot commented Mar 14, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

ndgrigorian force-pushed the document-dpctl-enum-types branch from cf203fa to b87710a Compare

March 15, 2025 01:57

github-actions bot commented Mar 15, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

ndgrigorian force-pushed the document-dpctl-enum-types branch 2 times, most recently from 48fdce3 to 61c0558 Compare

March 15, 2025 03:24

github-actions bot commented Mar 15, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

github-actions bot commented Mar 15, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 894
Failed: 3
Skipped: 126


          Add constants.rst for documenting dpctl constants

aa7a0b0

Also adds custom formatting for Enums into `index.rst`

ndgrigorian force-pushed the document-dpctl-enum-types branch from 61c0558 to aa7a0b0 Compare

March 15, 2025 05:20

ndgrigorian marked this pull request as ready for review

March 15, 2025 05:45

ndgrigorian requested review from antonwolfy, vlad-perevezentsev and vtavana as code owners

March 15, 2025 05:45

github-actions bot commented Mar 15, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_49 ran successfully.
Passed: 895
Failed: 2
Skipped: 126


          Reorder constants page

This way it matches the order on the index page for `dpctl` module

github-actions bot commented Mar 15, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_50 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

vtavana reviewed

View reviewed changes

docs/doc_sources/api_reference/dpctl/constants.rst Outdated Show resolved Hide resolved


          Tweaks to examples in dpctl enum docstrings

Remove unnecessary `print()` of the enums

github-actions bot commented Mar 17, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_51 ran successfully.
Passed: 895
Failed: 2
Skipped: 126


          Small tweaks to dpctl and dpctl.tensor constants pages

69dbd2a

ndgrigorian requested a review from vtavana

March 18, 2025 17:50

vtavana previously approved these changes

View reviewed changes

github-actions bot commented Mar 18, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_64 ran successfully.
Passed: 895
Failed: 2
Skipped: 126

antonwolfy previously approved these changes

View reviewed changes

docs/doc_sources/api_reference/dpctl/index.rst Outdated Show resolved Hide resolved

dpctl/enum_types.py Outdated Show resolved Hide resolved


          Fix extra space in docstring for global_mem_cache_type enums

ndgrigorian dismissed stale reviews from antonwolfy and vtavana via

March 18, 2025 20:09

ndgrigorian requested review from antonwolfy and vtavana

March 18, 2025 20:51

github-actions bot commented Mar 18, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_65 ran successfully.
Passed: 896
Failed: 1
Skipped: 126

vtavana approved these changes

View reviewed changes

ndgrigorian merged commit 59e7d4d into master

70 of 72 checks passed

ndgrigorian deleted the document-dpctl-enum-types branch

March 19, 2025 00:19

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

vlad-perevezentsev Awaiting requested review from vlad-perevezentsev vlad-perevezentsev is a code owner

antonwolfy Awaiting requested review from antonwolfy antonwolfy is a code owner

1 more reviewer

vtavana vtavana approved these changes

Labels

None yet