Skip to content

Commit

Permalink
fix: Direct users to the CUDA metapackage guides for compilation
Browse files Browse the repository at this point in the history
* The current (2025-01-08) FAQ incorrectly states that compilation of CUDA code
  using conda-forge provided packages is not possible. Compilation support
  is provided through the cuda-compiler metapackage and additional cuda
  metapackages provide additional development and runtime dependencies.
  The documentation for these metapackage is currently being developed along
  with their evolution and currently exists as multiple user guides in the
  cuda feedstock.
   - c.f. https://github.com/conda-forge/cuda-feedstock/blob/main/recipe/README.md
* This change intentionally removes nearly all specific information, not even
  mentioning the cuda-compiler metapackage, and instead directs readers to the
  user guides.
  • Loading branch information
matthewfeickert committed Jan 8, 2025
1 parent 3cc7737 commit d459745
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/user/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,8 @@ conda environment. This can be accomplished (for gcc) by passing `-sysroot=/` on

## How can I compile CUDA (host or device) codes in my environment?

Unfortunately, this is not possible with conda-forge's current infrastructure (`nvcc`, `cudatoolkit`, etc) if there is no local CUDA Toolkit installation. In particular, the `nvcc` package provided on conda-forge is a _wrapper package_ that exposes the actual `nvcc` compiler to our CI infrastructure in a `conda`-friendly way; it does not contain the full `nvcc` compiler toolchain. One of the reasons is that CUDA headers like `cuda.h`, `cuda_runtime.h`, etc, which are needed at compile time, are not redistributable according to NVIDIA's EULA. Likewise, the `cudatoolkit` package only contains CUDA runtime libraries and not the compiler toolchain.

If you need to compile CUDA code, even if it involves only CUDA host APIs, you will still need a valid CUDA Toolkit installed locally and use it. Please refer to [NVCC's documentation](https://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/index.html) for the CUDA compiler usage and [CUDA Programming Guide](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html) for general CUDA programming.
The [`cuda` feedstock](https://github.com/conda-forge/cuda-feedstock) provides various CUDA metapackages to make running and compiling CUDA code easier.
These metapackages and their documentation are updated frequently, so for the most up to date recommendations and documentation please read the [relevant guides provided on the feedstock](https://github.com/conda-forge/cuda-feedstock/blob/main/recipe/README.md).

<a id="faq-abi-incompatibility"></a>

Expand Down

0 comments on commit d459745

Please sign in to comment.