cudaPackages: doc fixup

Signed-off-by: Connor Baker <ConnorBaker01@gmail.com>
This commit is contained in:
Connor Baker 2025-05-10 02:51:30 +00:00
parent ead6581362
commit 8fcff2390e

View file

@ -8,15 +8,6 @@
The files in this directory are added (in some way) to the `cudaPackages` The files in this directory are added (in some way) to the `cudaPackages`
package set by [cuda-packages.nix](../../top-level/cuda-packages.nix). package set by [cuda-packages.nix](../../top-level/cuda-packages.nix).
## Top-level files
Top-level nix files are included in the initial creation of the `cudaPackages`
scope. These are typically required for the creation of the finalized
`cudaPackages` scope:
- `backend-stdenv.nix`: Standard environment for CUDA packages.
- `flags.nix`: Flags set, or consumed by, NVCC in order to build packages.
## Top-level directories ## Top-level directories
- `cuda`: CUDA redistributables! Provides extension to `cudaPackages` scope. - `cuda`: CUDA redistributables! Provides extension to `cudaPackages` scope.
@ -38,6 +29,8 @@ scope. These are typically required for the creation of the finalized
short, the Multiplex builder adds multiple versions of a single package to short, the Multiplex builder adds multiple versions of a single package to
single instance of the CUDA Packages package set. It is used primarily for single instance of the CUDA Packages package set. It is used primarily for
packages like `cudnn` and `cutensor`. packages like `cudnn` and `cutensor`.
- `lib`: A library of functions and data used by and for the CUDA package set.
This library is exposed at the top-level as `pkgs.cudaLib`.
- `modules`: Nixpkgs modules to check the shape and content of CUDA - `modules`: Nixpkgs modules to check the shape and content of CUDA
redistributable and feature manifests. These modules additionally use shims redistributable and feature manifests. These modules additionally use shims
provided by some CUDA packages to allow them to re-use the provided by some CUDA packages to allow them to re-use the
@ -45,9 +38,8 @@ scope. These are typically required for the creation of the finalized
own. `cudnn` and `tensorrt` are examples of packages which provide such own. `cudnn` and `tensorrt` are examples of packages which provide such
shims. These modules are further described in the shims. These modules are further described in the
[Modules](./modules/README.md) documentation. [Modules](./modules/README.md) documentation.
- `nccl`: NVIDIA NCCL library. - `packages`: Contains packages which exist in every instance of the CUDA
- `nccl-tests`: NVIDIA NCCL tests. package set. These packages are built in a `by-name` fashion.
- `saxpy`: Example CMake project that uses CUDA.
- `setup-hooks`: Nixpkgs setup hooks for CUDA. - `setup-hooks`: Nixpkgs setup hooks for CUDA.
- `tensorrt`: NVIDIA TensorRT library. - `tensorrt`: NVIDIA TensorRT library.