Skip to content

Commit 664ec82

Browse files
docs: Document Dagger.set_distributed_package! (#602)
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
1 parent e5a3698 commit 664ec82

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/src/api-dagger/functions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,11 @@ addprocs!
5959
rmprocs!
6060
```
6161

62+
## Distributed Package Selection Functions
63+
```@docs
64+
set_distributed_package!
65+
```
66+
6267
## DTask Execution Environment Functions
6368

6469
These functions are used within the function called by a `DTask`.

docs/src/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,24 @@ data on disk to be specified as desired.
304304

305305
-----
306306

307+
## Quickstart: Distributed Package Selection
308+
309+
Dagger.jl can use either the built-in `Distributed` package or the `DistributedNext` package for distributed operations. You can set your preference using the `Dagger.set_distributed_package!` function.
310+
311+
### Setting the Distributed Package
312+
313+
To set your preferred distributed package (e.g., to `DistributedNext`):
314+
315+
```julia
316+
Dagger.set_distributed_package!("DistributedNext")
317+
```
318+
319+
This will set a preference that persists across Julia sessions. Remember that **you need to restart your Julia session** for this change to take effect.
320+
321+
For more details, see [`Dagger.set_distributed_package!`](@ref).
322+
323+
-----
324+
307325
## Quickstart: Distributed Arrays
308326

309327
Dagger's `DArray` type represents a distributed array, where a single large

0 commit comments

Comments
 (0)