Skip to content

Add a table in dpctl's documentation comparing which SYCL classes and functions are supported #233

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

Closed
diptorupd opened this issue Dec 20, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@diptorupd
Copy link
Contributor

diptorupd commented Dec 20, 2020

DpCtl implements to various degrees the main SYCL runtime classes (ref Section 4.6.4 of SYCL 2020 spec). We need to add a table in our documentation noting what Sycl functions are supported by dpCtl's C and Python APIs and also noting any limitations or unsupported features.

This information is vital to drive adoption of dpCtl as a Python interface to the core SYCL classes.

Something like:

Class device

SYCL Function dpCtl C-API function Python API function Notes
get_info<info::device::driver_version> DPCTLDevice_GetDriverInfo get_driver_version
@diptorupd diptorupd added the documentation Improvements or additions to documentation label Dec 20, 2020
@diptorupd diptorupd added this to the 1.0 milestone Feb 20, 2021
@diptorupd diptorupd changed the title Add a table in dpCtl's documentation comparing which SYCL classes and functions are supported Add a table in dpctl's documentation comparing which SYCL classes and functions are supported Apr 16, 2021
@diptorupd
Copy link
Contributor Author

diptorupd commented Jan 8, 2022

Closing as maintaining such a table manually is extremely cumbersome and fragile. Instead, docstrings for libsyclinterface and Python functions should have a link to the parent sycl function specification. I will open a separate ticket for that purpose (#742).

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

No branches or pull requests

1 participant