Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify description of how LocalPreferences.toml is generated in the docs #2535

Merged
merged 1 commit into from
Oct 29, 2024
Merged

Clarify description of how LocalPreferences.toml is generated in the docs #2535

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/src/installation/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,15 @@ julia> CUDA.set_runtime_version!(local_toolkit=true)
[ Info: Set CUDA.jl toolkit preference to use CUDA from the local system, please re-start Julia for this to take effect.
```

After re-launching Julia:
Calling `CUDA.set_runtime_version!(local_toolkit=true)` generates the following `LocalPreferences.toml` file in
your active environment:

```
[CUDA_Runtime_jll]
local = "true"
```

so that after re-launching Julia:

```
julia> using CUDA
Expand All @@ -157,17 +165,9 @@ CUDA runtime 11.8, local installation
...
```

Calling the above helper function generates the following `LocalPreferences.toml` file in
your active environment:

```
[CUDA_Runtime_jll]
local = "true"
```

This preference not only configures CUDA.jl to use a local toolkit, it also prevents
The preference `local = "true"` under `CUDA_Runtime_jll` not only configures CUDA.jl to use a local toolkit, it also prevents
downloading any artifact, so it may be interesting to set this preference before ever
importing CUDA.jl (e.g., by putting this preference file in a system-wide depot).
importing CUDA.jl (e.g., by putting a `LocalPreferences.toml` file in a system-wide depot).

If CUDA.jl doesn't properly detect your local toolkit, it may be that certain libraries or
binaries aren't on a globally-discoverable path. For more information, run Julia with the
Expand Down