summary refs log tree commit diff
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorJason Miller <54179289+jmillerpdt@users.noreply.github.com>2022-12-17 01:00:36 -0500
committerGitHub <noreply@github.com>2022-12-16 22:00:36 -0800
commit8392158289e7d1a801905bc4195983f1b7434770 (patch)
tree87a0588557dffb92f2980f5b6b233f0c70da1242 /doc/languages-frameworks
parent08b5fc6d8c4fda44b5b98e36c294c5e031f3ef1c (diff)
downloadnixpkgs-8392158289e7d1a801905bc4195983f1b7434770.tar
nixpkgs-8392158289e7d1a801905bc4195983f1b7434770.tar.gz
nixpkgs-8392158289e7d1a801905bc4195983f1b7434770.tar.bz2
nixpkgs-8392158289e7d1a801905bc4195983f1b7434770.tar.lz
nixpkgs-8392158289e7d1a801905bc4195983f1b7434770.tar.xz
nixpkgs-8392158289e7d1a801905bc4195983f1b7434770.tar.zst
nixpkgs-8392158289e7d1a801905bc4195983f1b7434770.zip
cudaPackages: add cudaFlags (#205351)
* cudaPackages: add cudaFlags

* cudaNames -> cudaMicroarchitectureNames

* update documentation, remove config for static library removal

* doc link added to flags

* fix whitespace in assignment
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/cuda.section.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/languages-frameworks/cuda.section.md b/doc/languages-frameworks/cuda.section.md
index fccf66bf79d..27bae33bc71 100644
--- a/doc/languages-frameworks/cuda.section.md
+++ b/doc/languages-frameworks/cuda.section.md
@@ -32,3 +32,22 @@ mypkg = let
   }});
 in callPackage { inherit cudaPackages; };
 ```
+
+The CUDA NVCC compiler requires flags to determine which hardware you
+want to target for in terms of SASS (real hardware) or PTX (JIT kernels).
+
+Nixpkgs tries to target support real architecture defaults based on the
+CUDA toolkit version with PTX support for future hardware.  Experienced
+users may optmize this configuration for a variety of reasons such as
+reducing binary size and compile time, supporting legacy hardware, or
+optimizing for specific hardware.
+
+You may provide capabilities to add support or reduce binary size through
+`config` using `cudaCapabilities = [ "6.0" "7.0" ];` and
+`cudaForwardCompat = true;` if you want PTX support for future hardware.
+
+Please consult [GPUs supported](https://en.wikipedia.org/wiki/CUDA#GPUs_supported)
+for your specific card(s).
+
+Library maintainers should consult [NVCC Docs](https://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/)
+and release notes for their software package.