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.

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

Document CUDA library dependencies for python wheel #716

Merged
merged 26 commits into from
Oct 2, 2023

Conversation

anthony-santana
Copy link
Collaborator

Description

Closes #700

@copy-pr-bot
Copy link

copy-pr-bot bot commented Sep 28, 2023

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@schweitzpgi
Copy link
Collaborator

LGTM. Directions seem easy to follow, etc.

@bettinaheim bettinaheim added this to the release 0.4.1 milestone Sep 29, 2023
@bettinaheim bettinaheim added the documentation Improvements or additions to documentation label Sep 29, 2023
docs/sphinx/using/simulators.rst Outdated Show resolved Hide resolved
docs/sphinx/install.rst Outdated Show resolved Hide resolved
docs/sphinx/using/simulators.rst Outdated Show resolved Hide resolved
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
anthony-santana and others added 4 commits September 29, 2023 18:18
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
bettinaheim and others added 6 commits October 2, 2023 20:48
This PR makes the following changes:

In 0.4.0, I wasn't very careful with links in the readme, such that these links refer to the latest version of the docs. Since this can cause confusion, I updated it to only directly link to the release notes.
The release notes contain links to the docs and examples for each version.
I removed the instructions for building from source from the PyPI readme and instead added them to the docs (specifically to the Python Wheels section of the Getting Started page).
I removed the instructions for installing wheel dependencies from the docs and instead added them to the PyPI readme.
I removed updates to the simulators that give instructions for installing dependencies and instead added a note for the backend that states what optional components are needed.
I removed the optional cudart dependencies in the Python wheel. Even with all of these packages installed, there are still some libraries that will need to be installed separately (that aren't available on PyPI), and it just seems better to have a (one!) simple and clear recommendation for how to install the optional dependencies in the readme. If the simple instructions are not enough, I linked the CUDA docs and the OpenMPI docs for more information.
Not done: I haven't updated the mgpu docs with instructions for how to run the code (that's something for another PR...)
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
@anthony-santana
Copy link
Collaborator Author

anthony-santana commented Oct 2, 2023

/ok to test

Command Bot: Processing...

docs/sphinx/install.rst Outdated Show resolved Hide resolved
Signed-off-by: A.M. Santana <anthonys@nvidia.com>
@anthony-santana
Copy link
Collaborator Author

anthony-santana commented Oct 2, 2023

/ok to test

Command Bot: Processing...

@anthony-santana anthony-santana enabled auto-merge (squash) October 2, 2023 21:14
@bettinaheim
Copy link
Collaborator

bettinaheim commented Oct 2, 2023

/ok to test

Command Bot: Processing...

@anthony-santana anthony-santana merged commit cc558d1 into NVIDIA:main Oct 2, 2023
109 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 2, 2023
@anthony-santana anthony-santana deleted the python_gpu branch October 2, 2023 22:32
@bettinaheim bettinaheim added the no release notes Don't list this PR in the release notes label Nov 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation no release notes Don't list this PR in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document installation of the necessary CUDA libraries to use GPU backends in Python wheels
4 participants