Skip to content

Add cuda_bindings/docs/source/module/nvvm.rst #445

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
Merged
merged 4 commits into from
Feb 12, 2025
Merged

Add cuda_bindings/docs/source/module/nvvm.rst #445

merged 4 commits into from
Feb 12, 2025

Conversation

rwgk
Copy link
Collaborator

@rwgk rwgk commented Feb 12, 2025

TODO

@rwgk
Add cuda_bindings/docs/source/module/nvvm.rst
9fa68fa 
This files was put together manually based on
    cuda_bindings/cuda/bindings/nvvm.pxd
and using
    cuda_bindings/docs/source/module/nvjitlink.rst
as a starting point.
@copy-pr-bot copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Feb 12, 2025

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@rwgk
Copy link
Collaborator Author

rwgk commented Feb 12, 2025

/ok to test

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@rwgk
Lower-case nvvm in top title, so that "nvvm" blends in under the API …
d487d66 
…submenu on the main web page. Also try removing empty lines to make nvvm.rst a little nicer.
@rwgk
Copy link
Collaborator Author

rwgk commented Feb 12, 2025

/ok to test

@rwgk
Copy link
Collaborator Author

rwgk commented Feb 12, 2025

@leofang Do we want to mention nvvmError in nvvm.rst?

cuda-python/cuda_bindings/cuda/bindings/nvvm.pyx

Line 38 in acff0c5

class nvvmError(Exception):

nvvmError only appears in nvvm.pyx, not in nvvm.pyd.

I'm also wondering about Program, which appears in nvvm.pyd but not in nvvm.rst:

cuda-python/cuda_bindings/cuda/bindings/nvvm.pxd

Line 16 in acff0c5

ctypedef nvvmProgram Program

@leofang
Copy link
Member

leofang commented Feb 12, 2025

Looks good! Could you also add a release note entry? We need to touch 3 files:

  • cuda_bindings/docs/source/release/12.X.Y-notes.rst (do not mention the version yet; also make it a .rst instead of .md)
  • cuda_bindings/docs/source/release/11.8.7-notes.rst
  • cuda_bindings/docs/source/release.rst

@rwgk rwgk marked this pull request as ready for review February 12, 2025 19:24
@copy-pr-bot copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Feb 12, 2025

Auto-sync is disabled for ready for review pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@rwgk
Copy link
Collaborator Author

rwgk commented Feb 12, 2025

Looks good! Could you also add a release note entry? We need to touch 3 files:

  • cuda_bindings/docs/source/release/12.X.Y-notes.rst (do not mention the version yet; also make it a .rst instead of .md)
  • cuda_bindings/docs/source/release/11.8.7-notes.rst
  • cuda_bindings/docs/source/release.rst

Done: 71267d1

@rwgk
Copy link
Collaborator Author

rwgk commented Feb 12, 2025

/ok to test

@rwgk
Copy link
Collaborator Author

rwgk commented Feb 12, 2025

@leofang The generated documentation looks good to me. I clicked on all the links, API and Release notes. From my viewpoint this is ready for merging.

@rwgk rwgk requested a review from leofang February 12, 2025 20:05
@leofang
Copy link
Member

leofang commented Feb 12, 2025

Do we want to mention nvvmError in nvvm.rst?

That's a good question. Maybe we should? (We did not have this luxury for driver/runtime/nvrtc, but we do now for nvjitlink and nvvm, due to the different binding generation approach.)

I'm also wondering about Program, which appears in nvvm.pyd but not in nvvm.rst:

Let's not mention this.

@leofang leofang assigned leofang and rwgk and unassigned leofang Feb 12, 2025
@leofang leofang added documentation Improvements or additions to documentation P0 High priority - Must do! cuda.bindings Everything related to the cuda.bindings module labels Feb 12, 2025
@leofang leofang added this to the cuda-python 12-next, 11-next milestone Feb 12, 2025
@leofang leofang enabled auto-merge February 12, 2025 20:12
@leofang leofang merged commit 989e087 into NVIDIA:main Feb 12, 2025
72 checks passed
@github-actions GitHub Actions
Copy link

Doc Preview CI
Preview removed because the pull request was closed or merged.

@rwgk rwgk deleted the add_docs_nvvm_rst branch February 12, 2025 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leofang leofang leofang approved these changes

Assignees

@rwgk rwgk

Labels
cuda.bindings Everything related to the cuda.bindings module documentation Improvements or additions to documentation P0 High priority - Must do!
Projects
None yet
Milestone
cuda-python 12.9.0 & 11.8.7
Development

Successfully merging this pull request may close these issues.
2 participants
@rwgk @leofang