Skip to content

Commit fd4ce11

Browse files
Augment docs about setting runtime version (#2822)
Describe the actions of `set_runtime_version!` more completely. Specifically, mention adding `CUDA_Runtime_jll` to `[extras]' in `Project.toml`. [only docs]
1 parent 4f38802 commit fd4ce11

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/src/installation/overview.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,15 +121,23 @@ julia> CUDA.set_runtime_version!(v"11.8")
121121
[ Info: Set CUDA.jl toolkit preference to use CUDA 11.8.0 from artifact sources, please re-start Julia for this to take effect.
122122
```
123123

124-
This generates the following `LocalPreferences.toml` file in your active environment:
124+
This preference is compatible with other CUDA JLLs, e.g., if you load `CUDNN_jll` it will
125+
only select artifacts that are compatible with the configured CUDA runtime.
126+
127+
`CUDA.set_runtime_version!` performs the following two actions:
128+
129+
1. Generates the following `LocalPreferences.toml` file in your active environment:
125130

126131
```
127132
[CUDA_Runtime_jll]
128133
version = "11.8"
129134
```
130135

131-
This preference is compatible with other CUDA JLLs, e.g., if you load `CUDNN_jll` it will
132-
only select artifacts that are compatible with the configured CUDA runtime.
136+
2. Ensures the following line is in the `[extras]` section of your active `Project.toml` file to allow `Preferences.jl` to find the `version` preference for `CUDA_Runtime_jll`:
137+
138+
```
139+
CUDA_Runtime_jll = "76a88914-d11a-5bdc-97e0-2f5a05c973a2"
140+
```
133141

134142
### Using a local CUDA
135143

0 commit comments

Comments
 (0)