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.

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

Add API Reference for numba-dpex to the documentation site #1111

Open
1 of 2 tasks
Tracked by #1084
ZzEeKkAa opened this issue Aug 11, 2023 · 0 comments
Open
1 of 2 tasks
Tracked by #1084

Add API Reference for numba-dpex to the documentation site #1111

ZzEeKkAa opened this issue Aug 11, 2023 · 0 comments
Assignees
@ZzEeKkAa
Labels
documentation Improvements or additions to documentation
Milestone
0.23

Comments

@ZzEeKkAa
Copy link
Contributor

ZzEeKkAa commented Aug 11, 2023 •
edited by diptorupd
Loading

Currently, numba-dpex provides no API reference in the documentation page. The lack of API documentation is a serious gap in terms of usability and for new users to explore the product.

An incomplete list of things that should be added:

  • User API: All user-level interfaces that includes decorators, kernel API functions, supported dpnp functions
  • Developer API: kernel api implementation, dpjit implementation, core
@ZzEeKkAa ZzEeKkAa self-assigned this Aug 11, 2023
@diptorupd diptorupd added this to the 0.23 milestone Dec 20, 2023
@diptorupd diptorupd added the documentation Improvements or additions to documentation label Dec 20, 2023
@diptorupd diptorupd mentioned this issue Jan 8, 2024
Closed
2 tasks
@diptorupd diptorupd changed the title Add API Reference automation design Add API Reference for numba-dpex to the documentation site Jan 8, 2024
@diptorupd diptorupd mentioned this issue Jan 8, 2024
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ZzEeKkAa ZzEeKkAa

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.23
Development

No branches or pull requests
2 participants
@diptorupd @ZzEeKkAa