Refactor install/build guide. #1899
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cjnolet
added
improvement
|
/ok to test |
bdice
reviewed
Oct 13, 2023
docs/source/build.md
Outdated
| All of RAFT's C++ APIs can be used header-only but pre-compiled shared libraries also contain some host-accessible APIs and template instantiations to accelerate compile times. | ||
| #### Conda environment scripts | ||
|
|
||
| Conda environment scripts are provided for installing the necessary dependencies to build both the C++ and Python libraries from source. It is preferred to use `mamba`, as it provides significant speedup over `conda`. In addition you will have to manually install a CUDA toolkit which is greater than, or equal to, the version you install into you conda environment. Installing CUDA toolkit into your host system is necessary because `nvcc` is not provided with Conda's cudatoolkit dependencies. The following example will install create and install dependencies for a CUDA 11.8 conda environment: |
There was a problem hiding this comment.
This situation changes pretty dramatically (for the better) with CUDA 12. Should we figure out a way to tell the "simple" CUDA 12 story first, which has no system CTK requirement, and then describe the CUDA 11 case after that? (Eventually the CUDA 11 info will be safe to remove, so I'd try to separate it now.)
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
bdice
approved these changes
Oct 13, 2023
Comment on lines
67
to
68
| pip install pylibraft-cu11 --extra-index-url=https://pypi.nvidia.com | ||
| pip install raft-dask-cu11 --extra-index-url=https://pypi.nvidia.com |
There was a problem hiding this comment.
Maybe combine?
Suggested change
| pip install pylibraft-cu11 --extra-index-url=https://pypi.nvidia.com | |
| pip install raft-dask-cu11 --extra-index-url=https://pypi.nvidia.com | |
| pip install pylibraft-cu11 raft-dask-cu11 --extra-index-url=https://pypi.nvidia.com |
docs/source/build.md
Outdated
| There are a few different strategies for including RAFT in downstream projects, depending on whether the [required build dependencies](#build-dependencies) have already been installed and are available on the `lib` and `include` paths. | ||
|
|
||
| Using cmake, you can enable CUDA support right in your project's declaration: | ||
| When using the GPU parts of RAFT, you will need to enable CUDA support in your Cmake project declaration: |
There was a problem hiding this comment.
I didn't mark all these as noted in my previous review -- maybe use find/replace "Cmake" to "CMake."
Suggested change
| When using the GPU parts of RAFT, you will need to enable CUDA support in your Cmake project declaration: | |
| When using the GPU parts of RAFT, you will need to enable CUDA support in your CMake project declaration: |
|
/merge |
|
/merge |
divyegala
pushed a commit
to divyegala/raft
that referenced
this pull request
Oct 17, 2023
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs. Closes rapidsai#1895 Authors: - Corey J. Nolet (https://github.com/cjnolet) Approvers: - Bradley Dice (https://github.com/bdice) - Dante Gama Dessavre (https://github.com/dantegd) URL: rapidsai#1899
divyegala
pushed a commit
to divyegala/raft
that referenced
this pull request
Oct 19, 2023
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs. Closes rapidsai#1895 Authors: - Corey J. Nolet (https://github.com/cjnolet) Approvers: - Bradley Dice (https://github.com/bdice) - Dante Gama Dessavre (https://github.com/dantegd) URL: rapidsai#1899
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs.
Closes #1895